Object

LinkButton

The component for opening a link in a button.

Properties

role

string

(Required)

Always link_button for this component.

Value: link_button

accessibilityLabel

string

A string that is read to the user when certain accessibility functionalities are enabled.

anchor

Anchor

An object that defines vertical alignment with another component.

animation

An object that defines an animation to be applied to the component.

To remove a previously set condition, use none.

Possible types: ComponentAnimation, string("none")

behavior

An object that defines behavior for a component, like Parallax or Springy.

To remove a previously set condition, use none.

Possible types: Behavior, string("none")

conditional

An instance or array of button properties that can be applied conditionally, and the conditions that cause them to be applied.

Possible types: ConditionalButton, [ConditionalButton]

hidden

boolean

A Boolean value that determines whether the component is hidden.

Default: false

identifier

string

A unique identifier for this component. If used, identifier must be unique across the entire document. An identifier is required if you want to anchor other components to this component.

layout

An inline ComponentLayout object that contains layout information, or a string reference to a ComponentLayout that is defined at the top level of the document.

If layout is not defined, size and position are based on various factors, such as the device type, the length of the content, and the role of this component.

Possible types: ComponentLayout, string

style

An inline ComponentStyle object that defines the appearance of this component, or a string reference to a ComponentStyle that is defined at the top level of the document.

The none value is used for conditional design elements. Adding it here has no effect.

Possible types: ComponentStyle, string, string("none")

text

string

The text, styled according to the textStyle definition.

textStyle

An inline ComponentTextStyle object that contains styling information, or a string reference to a ComponentTextStyle object that is defined at the top level of the document.

Possible types: ComponentTextStyle, string

URL

SupportedURLs

(Required)

The URL to open when a user interacts with the range of text specified in the addition.

Discussion

Use the LinkButton component to display a button with a link. The link opens when the user interacts with the button. The LinkButton can be placed anywhere in the document and is styled using ComponentStyle and ComponentTextStyle properties.

Example

{  "components": [    {      "role": "link_button",      "URL": "http://apple.com",      "text": "Read More",      "style": {        "backgroundColor": "#DDD",        "mask": {          "type": "corners",          "radius": 25        }      },      "layout": {        "padding": 10      }    }  ]}

Relationships

Inherits From

Component