React Tabs API
The Tabs component is a tab strip used to switch between pages or views. This UI component is included in the TabPanel UI component, but you can use Tabs separately as well.
See Also
jQuery
Angular
Vue
React
Configuration
| Name | Description |
|---|---|
| accessKey |
Specifies the shortcut key that sets focus on the UI component. |
| dataSource |
Binds the UI component to data. |
| disabled |
Specifies whether the UI component responds to user interaction. |
| elementAttr |
Specifies the global attributes to be attached to the UI component's container element. |
| focusStateEnabled |
Specifies whether the UI component can be focused using keyboard navigation. |
| height |
Specifies the UI component's height. |
| hint |
Specifies text for a hint that appears when a user pauses on the UI component. |
| hoverStateEnabled |
Specifies whether the UI component changes its state when a user pauses on it. |
| iconPosition |
Specifies icon position relative to the text inside the tab. |
| itemComponent |
An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| itemHoldTimeout |
The time period in milliseconds before the onItemHold event is raised. |
| itemRender |
An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| items |
An array of items displayed by the UI component. |
| itemTemplate |
Specifies a custom template for items. |
| keyExpr |
Specifies the key property that provides key values to access data items. Each key value must be unique. |
| noDataText |
Specifies the text or HTML markup displayed by the UI component if the item collection is empty. |
| onContentReady |
A function that is executed when the UI component is rendered and each time the component is repainted. |
| onDisposing |
A function that is executed before the UI component is disposed of. |
| onInitialized |
A function used in JavaScript frameworks to save the UI component instance. |
| onItemClick |
A function that is executed when a collection item is clicked or tapped. |
| onItemContextMenu |
A function that is executed when a collection item is right-clicked or pressed. |
| onItemHold |
A function that is executed when a collection item has been held for a specified period. |
| onItemRendered |
A function that is executed after a collection item is rendered. |
| onOptionChanged |
A function that is executed after a UI component property is changed. |
| onSelectionChanged |
A function that is executed when a collection item is selected or selection is canceled. |
| orientation |
Specifies component orientation. |
| repaintChangesOnly |
Specifies whether to repaint only those elements whose data changed. |
| rtlEnabled |
Switches the UI component to a right-to-left representation. |
| scrollByContent |
Specifies whether or not an end user can scroll tabs by swiping. |
| scrollingEnabled |
Specifies whether or not an end user can scroll tabs. |
| selectedIndex |
The index of the currently selected UI component item. |
| selectedItem |
The selected item object. |
| selectedItemKeys |
Specifies an array of currently selected item keys. |
| selectedItems |
An array of currently selected item objects. |
| selectionMode |
Specifies whether the UI component enables an end user to select only a single item or multiple items. |
| showNavButtons |
Specifies whether navigation buttons should be available when tabs exceed the UI component's width. |
| stylingMode |
Specifies the styling mode for the active tab. |
| tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
| visible |
Specifies whether the UI component is visible. |
| width |
Specifies the UI component's width. |
See Also
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration properties for this component. |
| dispose() |
Disposes of all the resources allocated to the Tabs instance. |
| element() |
Gets the root UI component element. |
| endUpdate() |
Refreshes the UI component after a call of the beginUpdate() method. |
| focus() |
Sets focus on the UI component. |
| getDataSource() |
Gets the DataSource instance. |
| getInstance(element) |
Gets the instance of a UI component found using its DOM node. |
| instance() |
Gets the UI component's instance. Use it to access other methods of the UI component. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all UI component properties. |
| option(optionName) |
Gets the value of a single property. |
| option(optionName, optionValue) |
Updates the value of a single property. |
| option(options) |
Updates the values of several properties. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| repaint() |
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
| resetOption(optionName) |
Resets a property to its default value. |
Events
| Name | Description |
|---|---|
| contentReady |
Raised when the UI component is rendered and each time the component is repainted. |
| disposing |
Raised before the UI component is disposed of. |
| initialized |
Raised only once, after the UI component is initialized. |
| itemClick |
Raised when a collection item is clicked or tapped. |
| itemContextMenu |
Raised when a collection item is right-clicked or pressed. |
| itemHold |
Raised when a collection item has been held for a specified period. |
| itemRendered |
Raised after a collection item is rendered. |
| optionChanged |
Raised after a UI component property is changed. |
| selectionChanged |
Raised when a collection item is selected or selection is canceled. |
Types
| Name | Description |
|---|---|
| ContentReadyEvent |
The type of the contentReady event handler's argument. |
| DisposingEvent |
The type of the disposing event handler's argument. |
| InitializedEvent |
The type of the initialized event handler's argument. |
| ItemClickEvent |
The type of the itemClick event handler's argument. |
| ItemContextMenuEvent |
The type of the itemContextMenu event handler's argument. |
| ItemHoldEvent |
The type of the itemHold event handler's argument. |
| ItemRenderedEvent |
The type of the itemRendered event handler's argument. |
| OptionChangedEvent |
The type of the optionChanged event handler's argument. |
| SelectionChangedEvent |
The type of the selectionChanged event handler's argument. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.