You are viewing an older version of the Social Share documentation (1.x). View the latest version (2.x) →
Developers

Button

Whenever you're dealing with a button in your template, you're actually working with a Button object.

Attributes

AttributeDescription
nameThe name of the provider.
handleThe handle of the provider.
primaryColorThe primary brand color of the provider.
iconThe SVG icon of the provider.
urlThe URL, if passed in through renderOptions.

Methods

MethodDescription
getRenderOptions()Returns any render options passed in when creating the button.
getProvider()Returns the provider the button is for.
render()Returns the rendered HTML for the button.