property-share-description.md

Property description

The property description is a JSON string, representing the optional text of the share link inside the share block.

Example usage

The following input JSON shows how to set description in a share block. This is the basic usage, showing a set of share buttons.

{
    "from" : "info@example.com",
    "subject" : "Email with a share block",
    "content" : {
        "blocks" : [ {
            "type"      : "share",
            "label"     : "Share with friends!",
            "align"     : "left",
            "icon"      : {
                "type"      : "rounded",
                "size"      : 32
            },
            "link"      : {
                "url"       : "https://responsiveemail.com/",
                "title"     : "Post title"
            },
            "description": "Optional description of the share link",
            "platforms" : ["facebook", "twitter", "linkedin", "googleplus"] 
        } ]
    }
}

For more information and more examples, please check the documentation of the share block.