Tabs
A Tabs component contains a number of defined containers that can be navigated through the tabs. Each tab acts as a container that can have different component placed inside it.
In order to avoid excessively complex situations, certain components, namely Calendar and Kanban, are restricted from being placed within the Tabs component using drag-and-drop functionality.
If the builder attempts to add any of the aforementioned components inside the Tabs, an error message will be displayed:
<Restricted component> cannot be used as a child component within the Tabs.
Properties
Tabs
This property lets you add and remove containers from the Tabs component. Each container in the tab has its unique id
, title
and disabled
for disabling individual tabs . This field expects an array of objects.
{{[
{ title: 'Home', id: '0' },
{ title: 'Profile', id: '1',disabled:'true' },
{ title: 'Settings', id: '2' }
]}}
Adding background color to Tabs
You can specify the different color for each tab using the backgroundColor
property and use hex color code or color name as the value.
{{[
{ title: 'Home', id: '0', backgroundColor: '#81D4FA' },
{ title: 'Profile', id: '1', backgroundColor: 'blue' },
{ title: 'Settings', id: '2', backgroundColor: '#ecf0f1'}
]}}
Default tab
This property selects the container in the tab which matches the corresponding id
. By default, the value is set to 0
.
Hide tab
It allows you to hide all the tab titles defined in the Tabs property above. It accepts boolean values which can also be set using the toggle option or programmatically by clicking on the fx button.
Render only active tab
This property is enabled by default. When enabled, only the active tab will be rendered and when disabled, all the tabs in the component will be rendered.
Events
Layout | Description |
---|---|
On tab switch | This event is triggered when the tab is switched. |
Check Action Reference docs to get the detailed information about all the Actions.
Component Specific Actions (CSA)
Following actions of Tabs component can be controlled using the component specific actions(CSA):
Actions | Description | How To Access |
---|---|---|
setTab | Set the current tab of the Tabs component via a component-specific action within any event handler. | Employ a RunJS query to execute component-specific actions such as await components.tabs1.setTab(1) |
Exposed Variables
Variables | Description | How To Access |
---|---|---|
currentTab | This variable holds the id of the current tab selected on the Tabs component. | Access the value dynamically using JS: {{components.tabs1.currentTab}} |
Actions
Action | Description | Properties |
---|---|---|
setTab | Set current tab. | id |
Devices
Property | Description | Expected Value |
---|---|---|
Show on desktop | Makes the component visible in desktop view. | You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
Show on mobile | Makes the component visible in mobile view. | You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
Styles
Style | Description |
---|---|
Highlight color | You can change the highlight color of the selected tab by entering the Hex color code or choosing a color of your choice from the color picker. |
Tab width | Tab width can be set as auto or equally split. |
Visibility | Toggle on or off to control the visibility of the component. You can programmatically change its value by clicking on the fx button next to it. If {{false}} the component will not be visible after the app is deployed. By default, it's set to {{true}} . |
Disable | This is off by default, toggle on the switch to lock the component and make it non-functional. You can also programmatically set the value by clicking on the fx button next to it. If set to {{true}} , the component will be locked and becomes non-functional. By default, its value is set to {{false}} . |
Any property having fx button next to its field can be programmatically configured.