Open Source

Blazor Tabs Overview

The Blazor 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 Blazor 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 Blazor 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.

Blazor Tabs Example

The Blazor 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 Blazor

Before using the IgbTabs, you need to import it as follows:

// in Program.cs file

builder.Services.AddIgniteUIBlazor(typeof(IgbTabsModule));

For a complete introduction to the Ignite UI for Blazor, read the Getting Started topic.

Simple IgbTabs declaration is done as follows:

<IgbTabs>
    <IgbTab Label="Tab 1">
      <span>Content for tab 1</span>
    </IgbTab>
    <IgbTab Label="Tab 2">
      <span>Content for tab 2</span>
    </IgbTab>
    <IgbTab>
      <div slot="label">Tab 3</div>
      <span>Content for tab 3</span>
    </IgbTab>
</IgbTabs>

Tab text can be set either as simple string using the Label property or by assigning children to the label slot. Any remaining children in the default slot are rendered as the tab content.

Selection

The IgbTabs 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 IgbTab 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:

<IgbTab Label="Tab 1" Disabled></IgbTab>

Alignment

The Alignment property controls how Blazor 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 Blazor 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.

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

Besides the label slot to display information - icon, text or both, each tab also has prefix and suffix slots to show additional content in the beginning and/or in the end.

Styling

The IgbTabs component exposes several CSS parts, giving you full control over its style:

Name	Description
`headers`	The wrapper which includes the tabs and the scroll buttons.
`headers-content`	The container for the tabs which represents the available space for rendering of the tabs.
`headers-wrapper`	The wrapper for the tabs and the selected indicator.
`headers-scroll`	The container for the tabs.
`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.
`content`	The container for the content where the data is displayed.

The IgbTab 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),
igc-tabs::part(inner)::after {
    --item-background: var(--ig-surface-600);
    --border-color: var(--ig-success-300);
}

igc-tab::part(tab-body),
igc-tab[selected] igc-icon {
    --item-active-icon-color: var(--ig-success-300);
}

igc-tab:not([selected]) igc-icon {
    --item-icon-color: var(--ig-gray-500);
}

igc-tabs::part(start-scroll-button),
igc-tabs::part(end-scroll-button) {
    --background: var(--ig-surface-600);
    --hover-background: var(--ig-surface-700);
    --active-background: var(--ig-surface-700);
    --disabled-background: var(--ig-gray-100);
    --button-color: var(--ig-gray-700);
    --button-hover-color: var(--ig-gray-800);
    --button-disabled-color: var(--ig-gray-300);
    --border-color: var(--ig-surface-600);
}

igc-tab::part(tab-header) {
    --item-hover-color: var(--ig-success-500);
}

igc-tab::part(tab-header)::before {
    --border-color--hover: var(--ig-gray-500);
}

API Reference

IgbTab IgbTabs IgbIcon IgbIconButton IgbRadioGroup