Skip to content

Active display tasks

Use the Active display type to:

  • Make a tab in a tab group into the active tab.
  • For the default tab of a tab group, bring the data into the tab as part of an OnLoad event.

Configure and dispatch tab-selection display tasks with parent and nested tab support

Display_taskConfiguring subtasks within a Display Task Set

Multiple Tab Selection subtasks can be added to a single Display Task Set. Each subtask specifies a target component and the tab to activate. The subtasks execute in order when the task is dispatched.

Note: Subtasks within a set run sequentially. Each subtask targets one component-tab pair. Nested tab paths are expressed as chained labels separated by.

When a Tab Selection Display Task is dispatched at runtime, the framework fires an onTabSelection event on the target component. Any event handler registered for that event will be triggered.

  1. Task dispatched

    The Display Task containing one or more Tab Selection subtasks is dispatched — either manually or as part of an automation flow. 2. Subtasks execute sequentially

    Each Tab Selection subtask in the set is processed in order. The target component is resolved and the specified tab is activated programmatically. 3. onTabSelection fires

    After each tab activation, the corresponding onTabSelection event is triggered on the component. Any listeners attached to this event receive the payload.

Event payload reference

PropertyTypeRequiredDescription
componentIdstringrequiredIdentifier of the component whose tab was selected
tabIdstringrequiredUnique identifier of the activated tab
tabPathstring[]requiredOrdered array of tab labels from root to the selected tab, e.g. ["Settings","Privacy","Cookies"]
isNestedbooleanoptionalTrue when the selected tab is a child (nested) tab. Defaults to false for top-level tabs.