Follow block
The follow block provides the ability to add links to your social media pages so
people can follow you.
All available properties of this block type are mentioned in the table below.
Follow block properties
| Property | Value | Description |
|---|---|---|
| type | "follow" | Property to identify the block as a follow block. |
| label | string | The label to show above all the social icons. |
| platforms | object | The platforms which we should be displaying in this follow block and their corresponding usernames/urls to follow. |
| icon | object | The type and size of each social icon. |
| font | object | Override the template wide default font properties to style the label property. |
| background | object | The background settings for the follow block. |
| margin | mixed | Margins around the follow block. |
| padding | mixed | Whitespace around the block, this whitespace will have a background. |
| visibility | object | Visibility based on device, client and/or receiver. |
| container | object | Access to the surrounding container. |
| align | string | The alignment of the social media icons of this block and their label text. |
Attributes
Just like some other blocks we support to apply custom attributes on the links. But as a follow block is essentially a collection we support custom attributes for each element. Because of this attributes are applied slightly differently. Simply create a element with the name of the platform in the root of the follow block. Within there you create a regular attributes block as seen in the example.
Example usage
The following input JSON shows how to show a follow block in a document. This is
the basic usage, showing a set of follow buttons.
{
"from" : "info@example.com",
"subject" : "Email with a follow block",
"content" : {
"blocks" : [ {
"type" : "follow",
"label" : "Follow us!",
"align" : "left",
"icon" : {
"type" : "rounded",
"size" : 32
},
"platforms" : {
"facebook" : "copernica",
"twitter" : "https://twitter.com/copernica"
}
} ]
}
}As you can see in above example, for many platforms (like Twitter and Facebook) you can both specify the full URL of the user to be followed, as well as just the username.
If you want to include additional properties, you can also pass in objects instead of usernames/urls. The following example demonstrates how you can pass custom link attributes for each platform:
{
"from" : "info@example.com",
"subject" : "Email with a follow block",
"content" : {
"blocks" : [ {
"type" : "follow",
"label" : "Follow us!",
"align" : "left",
"icon" : {
"type" : "rounded",
"size" : 32
},
"platforms" : {
"facebook" : {
"identifier": "copernica",
"attributes": {
"class": "my-custom-class"
}
},
"twitter" : {
"identifier": "@twitterhandle",
"attributes": {
"class": "my-custom-class"
}
}
}
} ]
}
}Found a typo?
You can find this documentation page on GitHub.
Propose a change
