React Tabs Overview
The React Tabs is a lightweight and user-friendly component that organizes corresponding content in a tab format or a collection of tabs typically placed horizontally. The React Tab enables end-users to easily click through and display different views. There are several features and customization options like tab orientation, templating, built-in header styles, animation, scroll buttons, and more.
The Ignite UI for React Tabs organizes and switches between similar data sets. The tabs are placed at the top of the data content. When a tab is selected its corresponding content is displayed.
React Tabs Example
The React Tabs example below displays three different tabs aligned in a single line so you can navigate across each in a fast and easy way.
How to use Tabs with Ignite UI for React
First, you need to the install the corresponding Ignite UI for React npm package by running the following command:
npm install igniteui-react
Before using the IgrTabs
, you need to import it as follows:
import { IgrTabs, IgrTab } from "igniteui-react";
For a complete introduction to the Ignite UI for React, read the Getting Started topic.
Simple IgrTabs
declaration is done as follows:
<IgrTabs>
<IgrTab label="Tab 1">
<span>Panel 1</span>
</IgrTab>
<IgrTab label="Tab 2">
<span>Panel 2</span>
</IgrTab>
<IgrTab label="Tab 3">
<span>Panel 3</span>
</IgrTab>
</IgrTabs>
Selection
The IgrTabs
emits Change
event when the user selects an item either by key press or click. The select
method allows you to select a tab by specifying the IgrTab
or its id.
If the selected tab is not specified on initial load, the first tab that is not disabled will be selected.
The default behavior, which selects a tab when the user is navigating with the arrow keys, could be modified by the activation
property. Setting it to Manual
will focus the next/previous tab on arrow key press, but the tab will be selected only after pressing Space or Enter
Disabled Tab
A tab is disabled by setting the disabled
attribute:
<IgrTab disabled={true}>Tab 1</IgrTab>
Alignment
The alignment
property controls how React tabs are positioned. It accepts the following values:
Start
(default): the width of the tab depends on the content (label, icon, both) and all tabs have equal padding. First tab is aligned to the tabs container's left side.Center
: the width of the tab depends on the content and occupies the tabs container's center.End
: the width of the tab depends on the content and all tabs have equal padding. Last tab is aligned to the tabs container's right side.Justify
: all tabs are equal in width and fully fit the tabs container.
If the space is not enough to fit all tabs, scroll buttons are displayed.
Scrolling
Scroll buttons are shown when the available space is not enough to render all React tabs. The start scroll button is disabled if the first tab is in view. Respectively, when last tab is in view the end scroll button is disabled. By pressing one of the scroll buttons the tabs are scrolled so the tab in that direction is fully visible, or if it is already visible the previous/next tab in that direction is displayed.
Keyboard Navigation
Keys | Description |
---|---|
← | Selects previous (next in Right-to-Left mode) tab. If activation is set to Manual only focuses the tab. Scrolls to end if on first tab. |
→ | Selects next (previous in Right-to-Left mode) tab. If activation is set to Manual only focuses the tab. Scrolls to start if on last tab. |
Home | Selects the first tab. |
End | Selects the last tab. |
Enter / Space | Selects the focused tab when activation is Manual |
Prefix / Suffix
Each tab has default slot to display information - icon, text or both and prefix
and suffix
slots to show additional content in the beginning and/or in the end.
Styling
The IgrTabs
component exposes several CSS parts, giving you full control over its style:
Name | Description |
---|---|
selected-indicator |
The selected indicator. |
start-scroll-button |
The start scroll button displayed when the tabs overflow. |
end-scroll-button |
The end scroll button displayed when the tabs overflow. |
The IgrTab
component exposes the following CSS parts:
Name | Description |
---|---|
content |
Tab header's label slot container. |
prefix |
Tab header's label prefix. |
suffix |
Tab header's label suffix. |
tab-header |
The header of a single tab. |
tab-body |
Holds the body content of a single tab, only the body of the selected tab is visible. |
igc-tab::part(tab-header) {
background-color: var(--ig-gray-200);
}
igc-tab::part(content) {
color: var(--ig-success-500);
}