Create actions that control modals and tabbed containers

Workbooks support actions that change the state of modals and tabbed containers, enabling seamless transitions between related content views.

This document explains how to create actions that open modals, close modals, or select a specific tab in a tabbed container. For more information about actions in Sigma, see Intro to actions.

User requirements

📘

The following requirements apply to users who configure actions. Users who access and interact with a workbook can typically trigger all existing actions within it. Any restrictions are noted in this document.

The ability to configure actions 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 workbook permission.

1 If you’re granted Can explore workbook permission, you can configure actions in custom, saved, and shared views. Actions saved to views do not apply to the workbook’s published version.

Open or close a modal

Create an action that opens or closes a modal in the current workbook. For more details about modals, see Add a modal to a workbook.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then in the side panel, click Actions.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Open modal or Close modal.
  Select modal	If configuring an Open modal action, select the modal to open, or choose New modal. The Close modal action doesn't require modal selection because it must be configured on an element within the modal it closes.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

Select tab (beta)

🚩

This documentation describes a public beta feature and is under construction. This page should not be considered part of our published documentation until this notice, and the corresponding Beta flag on the feature in the Sigma service, are removed. As with any beta feature, the feature discussed below is subject to quick, iterative changes. The latest experience in the Sigma service might differ from the contents of this document.

Beta features are subject to the Beta features disclaimer.

Create an action to display a specific tab in a tabbed container element.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then in the side panel, click Actions.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Select tab.
  Tabbed container	Select a tabbed container in this workbook.
  Tab	Select the tab to display.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.