Icon Button (ALPHA)
Responsive Widgets are in alpha and available by invitation only on Business and Enterprise plans. Behavior and properties may change. To request access, open a support ticket and name the feature Responsive Widgets (ALPHA).
The Icon Button widget is a button that shows only an icon. Use it where space is tight, for example to add, edit, or delete an item. Add a tooltip so users know what the button does.
Widget type: WDS_ICON_BUTTON_WIDGET
Content properties
These properties appear in the Content tab of the property pane.
Basic
Icon string
Sets the icon on the button. Default: plus. The value must be the name of an icon from the icon list. You cannot choose "no icon."
General
Tooltip string
Shows helper text when users hover over the button.
Visible boolean
Controls whether the widget is visible. Default: on.
Disabled boolean
Stops users from clicking the button. Default: off.
Animate loading boolean
Controls the loading animation of the widget. Default: on.
Style properties
These properties appear in the Style tab of the property pane.
General
Button variant string
Sets the look of the button. Options: Filled (default), Outlined, Subtle, Ghost.
Values for code: filled, outlined, subtle, ghost.
Button color string
Sets the semantic color of the button. Options: Accent (default), Neutral, Positive, Negative, Warning.
Values for code: accent, neutral, positive, negative, warning.
Reference properties
Reference properties let you read the widget's state in bindings and code, for example {{IconButton1.isVisible}}. You cannot set them directly.
isVisible boolean
Shows whether the widget is visible.
Example:
{{IconButton1.isVisible}}
Methods
Methods let you change the widget's properties from code, for example in a JS Object.
setVisibility (param: boolean): Promise
Shows or hides the widget.
Example:
IconButton1.setVisibility(false)
setDisabled (param: boolean): Promise
Turns the button on or off.
Example:
IconButton1.setDisabled(true)
Events
onClick
Runs when users click the button. The button shows a loading state until the action finishes. A disabled button does not run the action.