Skip to main content
Version: v11.2.4

Tabs


Tabs can be used when you need multiple containers within a single window. Tab-based navigation provides an easy and powerful mechanism to handle a large amount of content within a limited area by separating content into different panes where one pane is viewable at a time. The user can quickly access the content by switching between the panes without leaving the page.

In interface design, a Tabbed Document Interface (TDI) or Tab is a graphical control element that allows multiple documents or panels to contain within a single window. You can use these Tabs as a navigational widget for switching between sets of documents. It is an interface style most commonly associated with a web browser, web application and text-editor, and preference panes.

tab run

Types of Tabs

Static Tabs

Static Tabs do not need a dataset to add Tab Panes to the Tab bar. You add them using the Add Tab Pane button from the properties panel. The Static type is the default behavior of Tabs.

Dynamic Tabs

You can create a fully dynamic tab component using a data source by binding a dataset to the Tabs widget. Based on the dataset, a number of Tab panes will generate. For more information, see Using Dynamic Tabs and Accordions.

Features

When you drag and drop a Tab widget, it comes with three default three panes. Each pane can have a separate header and content.

Tabs

  • Add Tab Pane.
  • Tabs Position to change where the Tab header will be displayed, with respect to the content.
  • Default Pane Index - to set a specific Tab to be open by default.
  • Set Tab order for the display order.

Tab Pane

  • Title - Provide a title to the Tab pan.
  • Disabled - Not allowing users to view or perform any operation on the Tab.

When to use Tabs

  • To organize content at a high level.
  • To alternate between views within the same context.
  • To logically chunk the content behind the Tabs.
  • When users don't need to see content from multiple Tabs simultaneously.

tab prop1

tab prop2

Methods

Tab has few methods exposed on widget scope that can be accessed via JavaScript. See below for usage example

  • To navigate to the previous Tab pane:
Page.Widgets.tabs1.prev(); //Navigates to previous tab
  • To navigate to the next Tab Pane:
Page.Widgets.tabs1.next(); //Navigates to next tab
  • To navigate to a specific Tab Pane:
Page.Widgets.tabs1.goToTab(2); //Navigates to second tab
  • To select a specific Tab Pane:
Page.Widgets.tabpane1.select(); //selects tabpane1

Script Access

Learn how you can access Tab events using the JavaScript option. Also, you will learn to navigate to the previous, next, and goToTab functions to switch between the tabbed content. In this case, we are using the sample HRDB with the Employee table as an example to load the data.

Prepare data and widgets

  1. Create three variables of type Employee entity. For the first variable:
    • From the variables tab, select the variable and go to the Data tab.
    • For deptid, keep the value as 1, and follow the same for others, including deptid 4.
    • Name the respective variables as EngineeringEmployeesData, SalesEmployeesData, MarketingEmployeesData.
    • For more information, see Learn how to create variables.
  2. Drag and Drop Tab widget. By default, you will see a tab with three Tab Panes.
  3. Name the Tab widget as EmployeesTab and name the Tab Panes as engineeringEmpPane, salesEmpPane, marketingEmpPane.
  4. Change Tab panes titles to Engineering, Sales, Marketing.
  5. Drop the List widget in each of these Tabs and bind it to the respective variables. Map template widgets to the respective fields.
  6. Drop three buttons. Name the first button as previousBtn, the second one as nextBtn, and the last one as goToSalesBtn. Also, change the titles to Previous, Next, and Go To Sales.

Scripting with Tabs

  • Select JavaScript for the on click event of previousBtn and use the following as javascript function with the following script:
Page.previousbtnClick = function($event, widget) {
Page.Widgets.EmployeesTab.prev(); //Navigates to previous tab
};
  • Select JavaScript for the on click event for nextBtn and use the following script:
Page.nextbtnClick = function($event, widget) {
Page.Widgets.EmployeesTab.next(); //Navigates to next tab
};
  • Select JavaScript for the on click event for goToSalesBtn and use the following script:
Page.gototabbtnClick = function($event, widget) {
Page.Widgets.EmployeesTab.goToTab(2); //Navigates to sales tab
};

Run

  1. Run the application. The first tab pane will open by default.
  2. When you click nextBtn, the salesPane will open.
  3. When you click previousBtn, the engineeringPane will open.
  4. When you click goToSalesBtn, the salesPane will open.

Properties

PropertyDescription
NameThe name is a unique identifier of the Tab.
TypeThis property specifies the type of Tabs widget. - Static: The Tab Panes will be static, which is the default behavior of Tabs. - Dynamic: The Tab Panes will be generated based on the Dataset bound to the widget.
Add Tab PaneThis action allows one to add multiple panes to the Tab. NOTE: This property applies when you set the Type propety to Static.
Layout
HeightThe height of the Tab can be specified in px or % (i.e 50px, 75%).
Tab PositionThis property determines if the Tabs should be displayed on the - left, - top (default), - right or - bottom of the Tab content.
Behavior
Default Pane IndexThis property sets the default active pane on a load of the widget based on the provided index. The Tab Index is an integer starting from 0, 1, 2, and so on. That is, setting this property to 0 will display the first Tab pane; setting to 1 will display the second Tab pane.
Retain StateThis property will allow users to maintain widget states using state handling on the URL, Local Storage or Session Storage. This property, that is enabled by default enables applications that are using Tabs to deep link specific tabs using URL rewriting approach. If state information being visible in URL is not desired, other approaches to linking to specific tab includes localStorage & sessionStorage. - URL : The state information will be stored in the app URL(This is the default option selected by the platform). - Local Storage : The widget state information will be stored in the browser local storage. - Session Storage : The state information will be stored in the browser session storage. - None : No state information will be applied to the widget.
ShowShowing determines whether or not a component is visible. It is a bindable property.
Load on Demand (visible only when show property is bound to a variable)When this property is set and show property is bound, the initialization of the widget will be deferred till the widget becomes visible. This behavior improves the load time. Use this feature with caution, as it has a downside (as we will not be able to interact with the widget through script until the widget is initialized). When the show property is not bound, the widget will be initialized immediately.
TransitionThis property defines the transition effect to be applied when switching Tabs. You can choose from none or slide. When the transition property is slide, the selected Tab will be animated into the viewport. Swipe events will work only when the transition value is slide.
Format
Horizontal AlignSet text alignment horizontally, can be left, center or right.
Tab OrderThe order of the Tabs can be changed using the arrow icons next to the Tab names.

Tab Pane

SubWidget of Tabs, to hold the Tab content.

PropertyDescription
TitleThis property defines the heading or title for the Tab panes.
NameThe name is a unique identifier of the Tab pane.
Badge ValueValue to be displayed in the badge span for the Tab pane
Badge TypeThe property controls the color of the badge. These values are: - default, - primary, - success, - info, - warning, or - danger
Accessibility
Tab IndexThe Tab Index attribute specifies the Tab order of an element. You can use this property to change the default tabbing order for widget access using the Tab key. The value can range from 0 to 32767. The default is 0 and -1 makes the element non-focusable. NOTE: In Safari browsers, by default, Tab highlights only text fields. To enable Tab functionality, in Safari Browser from Preferences -> Advanced -> Accessibility set the option "Press Tab to highlight each item on a webpage".
Content
ContentInline content or Partial page's content to be included in the widget.
Behavior
ShowShowing determines whether or not a component is visible. It is bindable.
DisabledIf the disabled property is true (checked) the value of the editor cannot change. The widget becomes display-only. It is bindable.
Graphics
Title Icon ClassThis property can assign an icon for the pane.

Events

EventDescription
On loadThis event handler is called when the widget is loaded.
Callback Events
On selectThis event handler is called when the Tab is selected.
On deselectThis event handler is called when the Tab is deselected.

Apply Retain State

When application uses Tabs, it is possible to deep link to specific tab in the tab list as user selects them. Deep linking is a way to retain the state such that even when the user refreshes the page or shares the URL with someone else, they land on the page at a particular tab.

Retain State will store the state information either in the browser URL or in local or session storages of the browser. Query param called wm_state is appended to the URL which contains the state information.

Example:

https://www.wavemakeronline.com/run-x2zq8pwbhy/ent1d52def3436/ExcelDemo_master/#/Main?wm_state=('ws'~('tabs1'~'tabpane2'))

See Also

How to Use Dynamic Tabs and Accordions
How to Build Tabbed Live Form