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-segmented-button

v14.0.4

Published

The Material Components for the web segmented button component

Downloads

6

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

phamloi7710phamloi7710

Keywords

material componentsmaterial designsegmented button

Readme

Segmented Buttons

Segmented buttons allow users to toggle the selected states of grouped buttons.

Using segmented buttons

Installation

npm install @loipham/material-segmented-button

Basic Usage

HTML Structure

<div class="mdc-segmented-button" role="group">
  <button class="mdc-segmented-button__segment" aria-pressed="false">
    <i class="material-icons mdc-segmented-button__icon">favorite</i>
  </button>
  <button class="mdc-segmented-button__segment" aria-pressed="false">
    <div class="mdc-segmented-button__label">Sample Text</div>
  </button>
  <button class="mdc-segmented-button__segment" aria-pressed="false">
    <i class="material-icons mdc-segmented-button__icon">favorite</i>
    <div class="mdc-segmented-button__label">Sample Text</div>
  </button>
</div>

Styles

@use '@loipham/material-ripple/common';
@use '@loipham/material-segmented-button/styles';

JavaScript Instantiation

import {MDCSegmentedButton} from '@loipham/material-segmented-button';
const segmentedButtonEl = document.querySelector('.mdc-segmented-button');
const segmentedButton = new MDCSegmentedButton(segmentedButtonEl);

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

The MDC Segmented Button component automatically instantiates the child MDC Segmented Button Segment components.

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, FontAwesome, or any other icon library you wish.

Segmented Button

Multi select

By default, the segmented button allows any number of segments to be selected at a time so that each segment is independent from the rest.

For accessibility, the segments are treated as toggle buttons. The segmented button is assigned role="group" and each segment has the attribute aria-pressed with a boolean value corresponding to its selected state.

<div class="mdc-segmented-button" role="group">
  <button class="mdc-segmented-button__segment" aria-pressed="false">
    <i class="material-icons mdc-segmented-button__icon">favorite</i>
  </button>
  <button class="mdc-segmented-button__segment" aria-pressed="false">
    <div class="mdc-segmented-button__label">Sample Text</div>
  </button>
  <button class="mdc-segmented-button__segment" aria-pressed="false">
    <i class="material-icons mdc-segmented-button__icon">favorite</i>
    <div class="mdc-segmented-button__label">Sample Text</div>
  </button>
</div>

Single select

The segmented button can be limited to select only one segment at a time. In this case, the selected segment cannot be unselected with a click. Selecting a different segment will unselect the previously selected segment. To make the segmented button single select, add the class mdc-segmented-button--single-select.

For accessibility, the segments are treated as radio buttons. The segmented button is assigned role="radiogroup" and each segment is assigned role="radio" and has the attribute aria-checked with a boolean value corresponding to its selected state.

<div class="mdc-segmented-button mdc-segmented-button--single-select" role="radiogroup">
  <button class="mdc-segmented-button__segment" role="radio" aria-checked="false">
    <i class="material-icons mdc-segmented-button__icon">favorite</i>
  </button>
  <button class="mdc-segmented-button__segment" role="radio" aria-checked="false">
    <div class="mdc-segmented-button__label">Sample Text</div>
  </button>
  <button class="mdc-segmented-button__segment" role="radio" aria-checked="false">
    <i class="material-icons mdc-segmented-button__icon">favorite</i>
    <div class="mdc-segmented-button__label">Sample Text</div>
  </button>
</div>

Segment

The segment is assumed to be a child of a segmented button. The segment can be in a selected or unselected state and changes state if the button is clicked or if the segmented button tells it to change its state. If the parent segmented button is single select and the segment is selected, the segment will not become unselected if it is clicked.

The segment can contain an icon, text, or both. If both an icon and text are used, the icon is assumed to come first (unless the page is loaded as rtl). Ripple effects and touch support can also be added.

Segment with text

To insert text inside of a segment, add the class mdc-segmented-button__label.

<button class="mdc-segmented-button__segment">
  <div class="mdc-segmented-button__label">Sample Text</div>
</button>

Segment with an icon

To insert an icon inside of a segment, add the class mdc-segmented-button__icon.

<button class="mdc-segmented-button__segment">
  <i class="material-icons mdc-segmented-button__icon">favorite</i>
</button>

Selected segment

The segment will remain in a visually toggled state while selected. To select the segment by default, add the class mdc-segmented-button__segment--selected and set the attribute aria-pressed or aria-checked (if the segmented button is multi or single select, respectively) to true.

<button class="mdc-segmented-button__segment mdc-segmented-button__segment--selected" aria-pressed="true">
  <div class="mdc-segmented-button__label">Sample Text</div>
</button>

Additional Information

Touch accessibility

Material Design spec advises that touch targets should be at least 48 x 48 px. To meet this requirement, add the following to your segments:

<div class="mdc-touch-target-wrapper">
  <button class="mdc-segmented-button__segment mdc-segmented-button--touch">
    <div class="mdc-segmented-button__touch"></div>
    <div class="mdc-segmented-button__label">Sample Text</div>
  </button>
</div>

Ripple

To include ripple effects when a segment is clicked add the following classes to the segment:

<button class="mdc-segmented-button__segment">
  <div class="mdc-segmented-button__ripple"></div>
  <div class="mdc-segmented-button__label">Sample Text</div>
</button>

Keyboard navigation

Each segment within the segmented button is a tabbable element. Arrow key navigation between segments is not supported at this time.

Style Customization

CSS Classes

CSS Class | Description --- | --- mdc-segmented-button | Mandatory. Indicates the wrapper for child segments. mdc-segmented-button__single-select | Optional. Indicates the segmented button only allows one segment to be selected at a time. mdc-segmented-button__segment | Mandatory. Indicates a button element that can be selected. mdc-segmented-button__icon | Optional. Indicates an icon in the segment. We recommend using Material Icons from Google Fonts. mdc-segmented-button__label | Optional. Indicates text in the segment. mdc-segmented-button__segment--selected | Optional. Indicates that the segment is selected. mdc-touch-target-wrapper | Optional. Indicates contained segment has touch target support. mdc-segmented-button--touch | Optional. Indicates the segment has touch target support. mdc-segmented-button__touch | Optional. Indicates the segment has touch target support. mdc-segmented-button__ripple | Optional. Indicates the segment has a ripple effect when clicked.

NOTE: Every segment element must contain an icon with class mdc-segmented-button__icon, text with class mdc-segmented-button__label, or both.

NOTE: While mdc-touch-target-wrapper, mdc-segmented-button--touch, and mdc-segmented-button__touch are optional, if one is used then all three must be used.

Sass Mixins

Mixin | Description --- | --- outline-color | Customizes the border color around each segment. unselected-ink-color | Customizes the text and icon ink color for an unselected segment. unselected-container-fill-color | Customizes the background color for an unselected segment. selected-ink-color | Customizes the text and icon ink color for a selected segment. selected-container-fill-color | Customizes the background color for an selected segment.

MDCSegmentedButton, MDCSegmentedButtonSegment, and SegmentDetail Properties and Methods

The MDC Segmented Button package is composed of two JavaScript classes:

  • MDCSegmentedButton defines the behavior of a set of segments.
  • MDCSegmentedButtonSegment defines the behavior of a single segment.

To use the MDCSegmentedButton and MDCSegmentedButtonSegment classes, import both from @loipham/material-segmented-button.

SegmentDetail

The SegmentDetail type contains only the actionable information about a specific MDCSegmentedButtonSegment.

Property | Value Type | Description --- | --- | --- index | number | The index of the segment. selected | boolean | The segment's selected state. segmentId? | string \| undefined | The segment's segmentId, if provided.

MDCSegmentedButton

Method Signature | Description --- | --- getSelectedSegments() => readonly SegmentDetail[] | Proxies to foundation's getSelectedSegments method. selectSegment(indexOrSegmentId: number \| string) => void | Proxies to foundation's selectSegment method. unselectSegment(indexOrSegmentId: number \| string) => void | Proxies to foundation's unselectSegment method. isSegmentSelected(indexOrSegmentId: number \| string) => boolean | Proxies to foundation's isSegmentSelected method.

Property | Value Type | Description --- | --- | --- segments | ReadOnlyArray<MDCSegmentedButtonSegment> | Array of child MDCSegmentedButtonSegments. ripple | MDCRipple (read-only) | The MDCRipple instance for the root element that MDCSegmentedButton initializes.

Events

Event Name | event.detail | Description --- | --- | --- MDCSegmentedButton:change | SegmentDetail | Indicates that a segment's selected value may have changed due to a click.

MDCSegmentedButtonSegment

Method Signature | Description --- | --- setIndex(index: number) => void | Sets segment's index. setIsSingleSelect(isSingleSelect: boolean) => void | Sets segment's isSingleSelect. isSelected() => boolean | Proxies to foundation's isSelected method. setSelected() => void | Proxies to foundation's setSelected method. setUnselected() => void | Proxies to foundation's setUnselected method. getSegmentId() => string \| undefined | Proxies to foundation's getSegmentId method.

Events

Event Name | event.detail | Description --- | --- | --- MDCSegmentedButtonSegment:selected | SegmentDetail | Indicates the segment's selected status just changed due to a click.

Usage within Web Frameworks

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

Adapters: MDCSegmentedButtonAdapter and MDCSegmentedButtonSegmentAdapter

See segmented-button/component.ts and segment/component.ts for vanilla DOM implementations of these adapter APIs for reference.

MDCSegmentedButtonAdapter

Method Signature | Description --- | --- hasClass(className: string) => boolean | Returns true if segmented button has className, otherwise returns false. getSegments() => readonly SegmentDetail[] | Returns child segments represented as a readonly list of SegmentDetails. selectSegment(indexOrSegmentId: number \| string) => void | Sets identified segment to be selected. unselectSegment(indexOrSegmentId: number \| string) => void | Set identified segment to be not selected. notifySelectedChange(detail: SegmentDetail) => void | Notifies the client about the changed segment with a change event.

NOTE: notifySelectedChange must pass along a SegmentDetail representing the potentially changed Segment, and must be observable by the client (e.g. via DOM event bubbling).

MDCSegmentedButtonSegmentAdapter

Method Signature | Description --- | --- isSingleSelect() => boolean | Returns true if wrapping segmented button is single select, otherwise returns false. getAttr(attrName: string) => string \| null | Returns root element's attribute if it is set, otherwise returns null. setAttr(attrName: string, value: string) => void | Sets root element's attribute value to value. addClass(className: string) => void | Adds class to the root element. removeClass(className: string) => void | Removes class from the root element. hasClass(className: string) => boolean | Returns true if root element has class, otherwise returns false. notifySelectedChange(selected: boolean) => void | Notifies the Segmented Button that the segment's selected state has changed.

NOTE: notifySelectedChange must pass along a SegmentDetail representing the Segment, and must be observable by the mdc-segmented-button element (e.g. via DOM event bubbling).

Foundations: MDCSegmentedButtonFoundation and MDCSegmentedButtonSegmentFoundation

MDCSegmentedButtonFoundation

Method Signature | Description --- | --- selectSegment(indexOrSegmentId: number \| string) => void | Sets identified segment to be selected. unselectSegment(indexOrSegmentId: number \| string) => void | Set identified segment to be not selected. getSelectedSegments() => readonly SegmentDetail[] | Returns selected segments as readonly list of SegmentDetails. isSegmentSelected(indexOrSegmentId: number \| string) => boolean | Returns true if identified segment is selected, otherwise returns false. isSingleSelect() => boolean | Returns true if segmented button is single select, otherwise returns false. handleSelected(detail: SegmentDetail) => void | Handles a selected event. Maintains single select restrictions, if applicable, and notifies client.

MDCSegmentedButtonFoundation Event Handlers

When wrapping the Segmented Button foundation, the following events must be bound to the indicated foundation methods:

Events | Element Selector | Foundation Handler --- | --- | --- MDCSegmentedButtonSegment:selected | .mdc-segmented-button (root) | handleSelected

MDCSegmentedButtonSegmentFoundation

Method Signature | Description --- | --- isSelected() => void | Returns true if segment is currently selected. setSelected() => void | Sets segment to be selected. setUnselected() => void | Sets segment to be not selected. getSegmentId() => string \| undefined | Returns segment's segmentId if it was provided, otherwise return undefined. handleClick() => void | Handles a click event. Changes selected state if able (due to single select) and notifies Segmented Button.

MDCSegmentedButtonSegmentFoundation Event Handlers

When wrapping the Segment foundation, the following events must be bound to the indicated foundation methods:

Events | Element Selector | Foundation Handler --- | --- | --- click | .mdc-segmented-button__segment (root) | handleClick