Button elements
Add a button to create a one-click interaction in a workbook or application. You can customize the button display with text and icons, and configure it to trigger actions that kick off workflows, navigate to a specific destination, modify or refresh elements, export data, call APIs, and more.
Buttons are a UI element, allowing you to stylize workbooks and create seamless interactive experiences.
This document explains how to create and customize a button element. For information about actions and action sequences that can execute when the button is clicked, see Action effects.
User requirements
The ability to create and customize a button element requires the following:
- You must be assigned an account type with the Full explore or Create, edit, and publish workbooks permission enabled.
- You must be the workbook owner or be granted Can explore or Can edit access to the workbook.
Add a button element
Add a Button element to your workbook.
-
Open a draft, custom view, or saved view of a workbook.
-
In the Add element bar, hover over UI and select Button.
Customize button properties
Icons in buttons are in public beta.
This documentation describes one or more public beta features that are in development. Beta features are subject to quick, iterative changes; therefore the current user experience in the Sigma service can differ from the information provided in this page.
This page should not be considered official published documentation until Sigma removes this notice and the beta flag on the corresponding feature(s) in the Sigma service. For the full beta feature disclaimer, see Beta features.
You can customize the element properties that define the button's appearance, including the label, style, alignment, shape, and size.
In the editor panel, select the Properties tab, then configure the following settings for the button:
| Options | Details |
|---|---|
| Button type | Select a button type variant from among Text, Icon, Text and icon. |
| Appearance | Select a button variant from among Filled, Outline, and Text. |
| Text | Add a label to display in the button. Select = on your keyboard to include a dynamic value defined by a formula expression. |
| Style | Customize the font weight, text color, and button color. |
| Horizontal | Align or stretch the button relative to the total element width. |
| Vertical | Align the button relative to the total element height. |
| Shape | Select a button shape from among Auto, Square, Round, and Pill. |
| Size | Select a button size from among Small, Medium, and Large. |
| Show icon | Turn on the toggle to add an icon, then select a Position for the icon relative to the text. Available when Type is set to Button. |
| Icon | Select an icon to appear in the button. Available when Type is set to Icon button, or when the Show icon toggle is turned on. |
| Tooltip | Enter text to display as an on-hover tooltip. Available when Type is set to Icon button. |
You can search for icons that fit your design needs. After selecting Change icon in the Properties tab, you can search for an icon by its name using the search bar. Additionally, you can search by category by selecting between All, Filled, Outlined, Toned, and Emoji.
Configure button actions
Configure actions and action sequences that execute when the button is clicked.
-
In the editor panel, select the Actions tab.
-
Configure actions and action sequences as needed. For information about specific action effects and how to configure them, see Action effects and the documentation linked in the table.