npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@loipham/material-tab

v14.0.4

Published

The Material Components for the web tab component

Downloads

1

Readme

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 @loipham/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 "@loipham/material-tab/mdc-tab";

JavaScript Instantiation

import {MDCTab} from '@loipham/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()