Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@material/tab

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@material/tab

The Material Components for the web tab component

14.0.0
latest
Source
npm

Version published: 3 years ago

Weekly downloads: 752K; decreased by-2.32%

Maintainers: 15

Weekly downloads

Created: 6 years ago

Source

Tab

Tabs organize and allow navigation between groups of content that are related and at the same level of hierarchy. Each Tab governs the visibility of one group of content.

Design & API Documentation

Installation

npm install @material/tab

Basic Usage

HTML Structure

<button class="mdc-tab" role="tab" aria-selected="false" tabindex="-1">
  <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">
    <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>

The mdc-tab__focus-ring element ensures that a focus indicator is displayed in high contrast mode around the active/focused tab.

Styles

@use "@material/tab/mdc-tab";

JavaScript Instantiation

import {MDCTab} from '@material/tab';

const tab = new MDCTab(document.querySelector('.mdc-tab'));

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

Variants

Active Tab

NOTE: Don't forget to add the mdc-tab-indicator--active class to the mdc-tab-indicator subcomponent.

<button class="mdc-tab mdc-tab--active" role="tab" aria-selected="true">
  <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>

Tab with Indicator Spanning Only Content

In the example under Basic Usage, the Tab Indicator will span the entire tab. Alternatively, the tab indicator can be set up to span only the content of the tab if it is instead placed within the mdc-tab__content element:

<button class="mdc-tab" role="tab" aria-selected="false" tabindex="-1">
  <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 class="mdc-tab-indicator">
      <span class="mdc-tab-indicator__content mdc-tab-indicator__content--underline"></span>
    </span>
  </span>
  <span class="mdc-tab__ripple"></span>
  <div class="mdc-tab__focus-ring"></div>
</button>

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`	Mandatory.
`mdc-tab__content`	Mandatory. Container of tab icon, text label and tab indicator.
`mdc-tab__ripple`	Mandatory. Denotes the ripple surface for the tab.
`mdc-tab--active`	Optional. Indicates that the tab is active.
`mdc-tab--stacked`	Optional. Indicates that the tab icon and label should flow vertically instead of horizontally.
`mdc-tab--min-width`	Optional. Indicates that the tab should shrink in size to be as narrow as possible without causing text to wrap.
`mdc-tab__text-label`	Optional. Indicates the text label of the tab.
`mdc-tab__icon`	Optional. Indicates a leading icon in the tab.

Sass Mixins

To customize the colors of any part of the tab, use the following mixins.

Mixin	Description
`text-label-color($color)`	Customizes the color of the tab text label.
`icon-color($color)`	Customizes the color of the tab icon.
`states-color($color)`	Customizes the base states color, which affects hover/focus states and the press ripple.
`ink-color($color)`	Customizes the text label, icon, and base states color.
`active-text-label-color($color)`	Customizes the color of the active tab's text label.
`active-icon-color($color)`	Customizes the color of the active tab's icon.
`active-states-color($color)`	Customizes the color of the active tab's states.
`parent-positioning`	Sets the positioning of the MDCTab's parent element so that `MDCTab.computeDimensions()` reports the same values in all browsers.
`fixed-width($width)`	Sets the fixed width of the tab. The tab will never be smaller than the given width.
`horizontal-padding($padding)`	Sets the horizontal padding of the tab.
`height($height)`	Sets custom height to tab bar.
`text-transform($transform)`	Sets tab `text-transform` property

`MDCTab` Properties and Methods

Property	Value Type	Description
`id`	`string`	Value of the root tab element's `id` attribute.
`active`	`boolean` (read-only)	Allows getting the active state of the tab.
`focusOnActivate`	`boolean` (write-only)	Sets whether the tab should focus itself when activated. Defaults to `true`.

Method Signature	Description
`activate(previousIndicatorClientRect?: ClientRect) => void`	Activates the indicator. `previousIndicatorClientRect` is an optional argument.
`deactivate() => void`	Deactivates the indicator.
`focus() => void`	Focuses the tab.
`computeIndicatorClientRect() => ClientRect`	Returns the bounding client rect of the indicator.
`computeDimensions() => MDCTabDimensions`	Returns the dimensions of the Tab.

Event Name	Event Data Structure	Description
`MDCTab:interacted`	`{"detail": {"tabId": string}}`	Emitted when the Tab is interacted with, regardless of its active state. Used by parent components to know which Tab to activate.

Usage within Web Frameworks

If you are using a JavaScript framework, such as React or Angular, you can create a Tab 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.

`MDCTabAdapter`

Method Signature	Description
`addClass(className: string) => void`	Adds a class to the root element.
`removeClass(className: string) => void`	Removes a class from the root element.
`hasClass(className: string) => boolean`	Returns true if the root element contains the given class.
`setAttr(attr: string, value: string) => void`	Sets the given attribute on the root element to the given value.
`activateIndicator(previousIndicatorClientRect?: ClientRect) => void`	Activates the tab indicator subcomponent. `previousIndicatorClientRect` is an optional argument.
`deactivateIndicator() => void`	Deactivates the tab indicator subcomponent.
`getOffsetLeft() => number`	Returns the `offsetLeft` value of the root element.
`getOffsetWidth() => number`	Returns the `offsetWidth` value of the root element.
`getContentOffsetLeft() => number`	Returns the `offsetLeft` value of the content element.
`getContentOffsetWidth() => number`	Returns the `offsetWidth` value of the content element.
`notifyInteracted() => void`	Emits the `MDCTab:interacted` event.
`focus() => void`	Applies focus to the root element.

`MDCTabFoundation`

Method Signature	Description
`handleClick() => void`	Handles the logic for the `"click"` event.
`isActive() => boolean`	Returns whether the tab is active.
`setFocusOnActivate(focusOnActivate: boolean) => void`	Sets whether the tab should focus itself when activated.
`activate(previousIndicatorClientRect?: ClientRect) => void`	Activates the tab. `previousIndicatorClientRect` is an optional argument.
`deactivate() => void`	Deactivates the tab.
`computeDimensions() => MDCTabDimensions`	Returns the dimensions of the tab.

`MDCTabFoundation` Event Handlers

When wrapping the Tab component, it is necessary to register the following event handler. For an example of this, see the MDCTab component's initialSyncWithDOM method.

Event	Element	Foundation Handler
`click`	Root element	`handleClick()`

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

Keywords

FAQs

What is @material/tab?

Is @material/tab popular?

Is @material/tab well maintained?

Package last updated on 28 Apr 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@material/tab

Tab

Design & API Documentation

Installation

Basic Usage

HTML Structure

Styles

JavaScript Instantiation

Variants

Active Tab

Tab with Indicator Spanning Only Content

Tab Icons

Style Customization

CSS Classes

Sass Mixins

MDCTab Properties and Methods

Usage within Web Frameworks

MDCTabAdapter

MDCTabFoundation

MDCTabFoundation Event Handlers

14.0.0 (2022-04-27)

Bug Fixes

Features

BREAKING CHANGES

Keywords

Related posts

Threat Actor Exposes Playbook for Exploiting npm to Build Blockchain-Powered Botnets

NVD Backlog Tops 20,000 CVEs Awaiting Analysis as NIST Prepares System Updates

`MDCTab` Properties and Methods

`MDCTabAdapter`

`MDCTabFoundation`

`MDCTabFoundation` Event Handlers