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-bar

v14.0.4

Published

The Material Components for the web tab bar component

Downloads

1

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

Installation

npm install @loipham/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 "@loipham/material-tab-bar/mdc-tab-bar";
@use "@loipham/material-tab-scroller/mdc-tab-scroller";
@use "@loipham/material-tab-indicator/mdc-tab-indicator";
@use "@loipham/material-tab/mdc-tab";

JavaScript Instantiation

import {MDCTabBar} from '@loipham/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.