@material/tab-bar

What is @material/tab-bar?

@material/tab-bar is a package from Material Design Components (MDC) that provides a tab bar component. This component allows for the creation of tabbed navigation interfaces, which are commonly used in web applications to organize content into different sections.

What are @material/tab-bar's main functionalities?

Basic Tab Bar

This code initializes a basic tab bar using the @material/tab-bar package. The MDCTabBar class is used to create a tab bar component, which is then attached to an HTML element with the class 'mdc-tab-bar'.

import { MDCTabBar } from '@material/tab-bar';

const tabBar = new MDCTabBar(document.querySelector('.mdc-tab-bar'));

Tab Bar with Icons

This code demonstrates how to create a tab bar with icons. The HTML structure includes tabs with both icons and text labels, which are styled using Material Design classes.

import { MDCTabBar } from '@material/tab-bar';

const tabBar = new MDCTabBar(document.querySelector('.mdc-tab-bar'));

// HTML structure
// <div class="mdc-tab-bar">
//   <div class="mdc-tab">
//     <span class="mdc-tab__icon material-icons">favorite</span>
//     <span class="mdc-tab__text-label">Favorites</span>
//   </div>
//   <div class="mdc-tab">
//     <span class="mdc-tab__icon material-icons">person</span>
//     <span class="mdc-tab__text-label">Profile</span>
//   </div>
// </div>

Scrollable Tab Bar

This code shows how to create a scrollable tab bar. The 'mdc-tab-bar--scrollable' class is added to the tab bar element to enable horizontal scrolling for tabs that overflow the container.

import { MDCTabBar } from '@material/tab-bar';

const tabBar = new MDCTabBar(document.querySelector('.mdc-tab-bar'));

// HTML structure
// <div class="mdc-tab-bar mdc-tab-bar--scrollable">
//   <div class="mdc-tab">
//     <span class="mdc-tab__text-label">Tab 1</span>
//   </div>
//   <div class="mdc-tab">
//     <span class="mdc-tab__text-label">Tab 2</span>
//   </div>
//   <!-- More tabs -->
// </div>

Other packages similar to @material/tab-bar

react-tabs

react-tabs is a React component for creating tabbed interfaces. It provides a simple and flexible API for creating tabs and managing their state. Compared to @material/tab-bar, react-tabs is specifically designed for React applications and offers more customization options for React developers.

bootstrap

Bootstrap is a popular front-end framework that includes a variety of components, including tabbed navigation. Bootstrap's tab component is easy to use and integrates well with other Bootstrap components. While @material/tab-bar follows Material Design guidelines, Bootstrap offers a different design aesthetic and a broader set of components.

semantic-ui-react

semantic-ui-react is the official React integration for Semantic UI. It includes a Tab component that allows for the creation of tabbed interfaces. Similar to @material/tab-bar, semantic-ui-react provides a set of pre-styled components, but it follows the Semantic UI design principles instead of Material Design.

README

Tab Bar

Tabs organize and allow navigation between groups of content that are related and at the same level of hierarchy. The Tab Bar contains the Tab Scroller and Tab components.

Design & API Documentation

• Material Design guidelines: Tabs
• Demo

Installation

npm install @material/tab-bar

Basic Usage

HTML Structure

<div class="mdc-tab-bar" role="tablist">
  <div class="mdc-tab-scroller">
    <div class="mdc-tab-scroller__scroll-area">
      <div class="mdc-tab-scroller__scroll-content">
        <button class="mdc-tab mdc-tab--active" role="tab" aria-selected="true" tabindex="0">
          <span class="mdc-tab__content">
            <span class="mdc-tab__icon material-icons" aria-hidden="true">favorite</span>
            <span class="mdc-tab__text-label">Favorites</span>
          </span>
          <span class="mdc-tab-indicator mdc-tab-indicator--active">
            <span class="mdc-tab-indicator__content mdc-tab-indicator__content--underline"></span>
          </span>
          <span class="mdc-tab__ripple"></span>
          <div class="mdc-tab__focus-ring"></div>
        </button>
      </div>
    </div>
  </div>
</div>

Styles

@use "@material/tab-bar/mdc-tab-bar";
@use "@material/tab-scroller/mdc-tab-scroller";
@use "@material/tab-indicator/mdc-tab-indicator";
@use "@material/tab/mdc-tab";

JavaScript Instantiation

import {MDCTabBar} from '@material/tab-bar';

const tabBar = new MDCTabBar(document.querySelector('.mdc-tab-bar'));

See Importing the JS component for more information on how to import JavaScript.

Variants

MDC Tab Bar does not have any variants; however, its subcomponents do. See the Tab Scroller, Tab, and Tab Indicator documentation for more information.

Tab Icons

We recommend using Material Icons from Google Fonts:

<head>
  <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
</head>

However, you can also use SVG, Font Awesome, or any other icon library you wish.

Style Customization

CSS Classes

CSS Class	Description
mdc-tab-bar	Mandatory.

Sass Mixins

To customize the width of the tab bar, use the following mixin.

Mixin	Description
width($width)	Customizes the width of the tab bar.
density($density-scale)	Sets density scale to default tab bar variant. Use stacked-density mixin for stacked variant. Supported density scales -4, -3, -2, -1 and 0.
stacked-density($density-scale)	Sets density scale to stacked tab bar variant. Supported density scales -4, -3, -2, -1 and 0.
tab-scroller-transition($duration-ms, $timing-function)	Sets the CSS transition for the tab scrolling animation. This mixin is a proxy to mdc-tab-scroller-transition mixin.

MDCTabBar Properties and Methods

Property	Value Type	Description
focusOnActivate	boolean (write-only)	Sets whether tabs focus themselves when activated. Defaults to true.
useAutomaticActivation	boolean (write-only)	Sets how tabs activate in response to keyboard interaction. Automatic (true) activates as soon as a tab is focused with arrow keys; manual (false) activates only when the user presses space/enter. The default is automatic (true).

Method Signature	Description
activateTab(index: number) => void	Activates the tab at the given index.
scrollIntoView(index: number) => void	Scrolls the tab at the given index into view.

Event Name	Event Data Structure	Description
MDCTabBar:activated	{"detail": {"index": number}}	Emitted when a Tab is activated with the index of the activated Tab. Listen for this to update content when a Tab becomes active.

Usage within Web Frameworks

If you are using a JavaScript framework, such as React or Angular, you can create a Tab Bar for your framework. Depending on your needs, you can use the Simple Approach: Wrapping MDC Web Vanilla Components, or the Advanced Approach: Using Foundations and Adapters. Please follow the instructions here.

MDCTabBarAdapter

Method Signature	Description
scrollTo(scrollX: number) => void	Scrolls the Tab Scroller to the given position.
incrementScroll(scrollXIncrement: number) => void	Increments the Tab Scroller by the given value.
getScrollPosition() => number	Returns the scroll position of the Tab Scroller.
getScrollContentWidth() => number	Returns the width of the Tab Scroller's scroll content element.
getOffsetWidth() => number	Returns the offsetWidth of the root element.
isRTL() => boolean	Returns if the text direction is RTL.
setActiveTab(index: number) => void	Sets the tab at the given index to be activated.
activateTabAtIndex(index: number, clientRect: ClientRect) => void	Activates the Tab at the given index with the given clientRect.
deactivateTabAtIndex(index) => void	Deactivates the Tab at the given index.
focusTabAtIndex(index: number) => void	Focuses the Tab at the given index.
getTabIndicatorClientRectAtIndex(index: number) => ClientRect	Returns the client rect of the Tab at the given index.
getTabDimensionsAtIndex(index) => MDCTabDimensions	Returns the dimensions of the Tab at the given index.
getTabListLength() => number	Returns the number of child Tab components.
getPreviousActiveTabIndex() => number	Returns the index of the previously active Tab.
getFocusedTabIndex() => number	Returns the index of the focused Tab.
getIndexOfTabById(id: string) => number	Returns the index of the given Tab ID.
notifyTabActivated(index: number) => void	Emits the MDCTabBar:activated event.

MDCTabBarFoundation

Method Signature	Description
activateTab(index: number) => void	Activates the tab at the given index.
setUseAutomaticActivation(useAutomaticActivation: boolean) => void	Sets how tabs activate in response to keyboard interaction. Automatic (true) activates as soon as a tab is focused with arrow keys; manual (false) activates only when the user presses space/enter.
handleKeyDown(evt: Event) => void	Handles the logic for the "keydown" event.
handleTabInteraction(evt: Event) => void	Handles the logic for the "MDCTab:interacted" event.
scrollIntoView(index: number) => void	Scrolls the Tab at the given index into view.

Changelog

14.0.0 (2022-04-27)

Bug Fixes

• button: update HCM shim to use the existing focus-ring (a657abb)
• checkbox: Add explicit system color for checkmark in HCM. (8c4da22)
• checkbox: move forced-colors theme out of static styles (bbd1126)
• checkbox: Update checkbox theme styles mixin to accept css vars (c14e977)
• chips: Fix typography selector in GMDC-Wiz chips theming (43c7d87)
• datatable: Adjust data table last row border-radius to support setting row background-color. (ba78e87)
• dialog: Render dividers in Firefox 94 on Windows HCM (fae6c65)
• dialog: Set default z-index for close button in FloatingSheet dialog. (3366a71)
• fab: Add focus ring in HCM. (d57ec74)
• focus-ring: add 2d padding customizability, RTL bugfix (f81fb1d)
• focus-ring: box-sizing bugfix to content-box. If box-sizing border-box is inherited the ring spacing will collapse. (e58552c)
• focus-ring: ignore pointer events (3ef470e)
• focus-ring: RTL bugfix (e00181e)
• iconbutton: Fixed max width and height for high contrast mode focus ring on icon buttons. Display only in forced colors mode. (cf42927)
• iconbutton: Set icon button ripple z-index to -1. (586e740)
• list: Improve a11y for multi-select lists (9736ddc)
• list: Remove conflicting validation for checkbox list in setEnabled (353ca7e)
• list: Update lastSelectedIndex when toggling a checkbox range (dcba26f)
• menusurface: Add a getOwnerDocument() method to MDCMenuSurfaceAdapter to provide a reference to the document that owns the menu surface DOM element. (3486659)
• radio: Fix disabled state in Firefox Windows high contrast mode (23043ac)
• radio: Modify theme styles Sass mixin validation to validate only keys (390220e)
• select: Add border to select menu in HCM. (5d80969)
• select: revert down/up arrow on anchor changing selected index (43d08ba)
• slider: Fix bug where secondary click moves slider thumb. (3ab9565)
• slider: Fix IE11 bug - unset is unsupported in IE. (f460e23)
• slider: In updateUI, fix behavior to match jsdoc claim that when thumb param is undefined it updates both thumbs. Input attributes were not being updated at all. (cc4ed13)
• slider: Make the slider errors easier to debug by providing all relevant values in the error message. (8687937)
• snackbar: address Trusted Types violation (cbd9358)
• tooltip: Adjusts logic in validateTooltipWithCaretDistances method. (3e30054)
• typography: Fixes typography theme-styles mixin... the value being retreived from the $theme map and css property name was swapped. The mixin would request font-size/font-weight/letter-spacing from the $theme map (which expects size/weight/tracking)... so these values would always be null. (32b3913)
• Remove /** @override */ tags from TypeScript code. (c3cdff0)
• Simplify MDCAttachable interface to be any object (Function) that has attachTo. (05db65e)
• Snackbar action button ripple color is applied to the ripple element. (4e66fb2)
• Work around bug in Sass (037285f), closes sass/sass#3259
• switch: Restore Firefox 94 HCM outlines (39cf14b)
• textfield: Fix breaking tests due to no valid pointerId being associated with pointer events. (15db4f1)
• tooltip: Only sends notification of a tooltip being hidden if showTimeout is not set (indicating that this tooltip is about to be re-shown). (6ca8b8f)

Features

• banner: Add disableAutoClose params for both banner actions to prevent the banner buttons from automatically closing the banner. Add adapter #notifyActionClicked method. (b094eaa)
• chips: add focus ring styles (783f6fd)
• chips: Added elevation tint layer color support in chips (c78ff04)
• data-table: separate table structure into its own mixin (9f9d928)
• dialog: Add styling for floating sheets (78305b6)
• dialog: Add styling for floating sheets with content padding (3e20c1d)
• Dialog: Adds an API to hide the header for GMDC Fullscreen Dialog in non-fullscreen mode (ab4aba1)
• Dialog: Adds an API to set custom position for GMDC Dialog (ea9b5b4)
• Dialog: Adds an API to set custom z-index for GMDC Dialog (96ea061)
• focus-ring: added a new mixin so we can override just the focus-ring color (641ed08)
• focus-ring: added a new mixin so we can override just the focus-ring radius (7321d62)
• iconbutton: Add link icon button Sass. (9803d2d)
• mdc-list: introduce selection change event (7d8ea46)
• menu: allow preferentially opening surface below anchor (261f2db)
• MenuSurface: Add opening event for menus. (53b3cad)
• select: Add theming mixin boilerplate code to select (ae8a6a3)
• select: Add validation getter methods. (bdf1d37)
• select: Added theme mixins to MDC select (dcfe49c)
• slider: Add minRange param to range sliders to request a minimum gap between the two thumbs. (8fffcb5)
• slider: Add an option to hide focus styles after pointer interaction. (ec54d90)
• slider: Keep the slider value indicator within the bounds of the slider if possible. (c047f7c)
• state: make context aware (b2fe352)
• switch: Add high contrast mode focus ring to switch (f31a833)
• text-field: Add theming mixin boilerplate code to text-field (eb382f3)
• text-field: Added theme mixins to MDC text field (344d528)
• textfield: adding input-font-size mixin (207230e)
• theme: allow custom property strings in theme.validate-theme() (4e372fb)
• add new class and mixin for open state of a menu item (9a02b6e)
• Indicate which thumb valueToAriaValueTextFn and valueToValueIndicatorTextFn functions are called for. (b6510c8)
• textfield: adding input-font-family mixin (991fb99)
• Describe how to add child lists into a list item. (758ce31)

BREAKING CHANGES

• MenuSurface: Adds #notifyOpening method to menu surface adapter.

PiperOrigin-RevId: 444830518

• slider: Adds #getValueIndicatorContainerWidth method to slider adapter.

PiperOrigin-RevId: 419837612