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

@material/segmented-button

Package Overview
Dependencies
Maintainers
14
Versions
1201
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@material/segmented-button

The Material Components for the web segmented button component

  • 15.0.0-canary.d153db62b.0
  • Source
  • npm
  • Socket score

Version published
Maintainers
14
Created
Source

Segmented Buttons

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

Using segmented buttons

Installation

npm install @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 '@material/ripple/common';
@use '@material/segmented-button/styles';

JavaScript Instantiation

import {MDCSegmentedButton} from '@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 ClassDescription
mdc-segmented-buttonMandatory. Indicates the wrapper for child segments.
mdc-segmented-button__single-selectOptional. Indicates the segmented button only allows one segment to be selected at a time.
mdc-segmented-button__segmentMandatory. Indicates a button element that can be selected.
mdc-segmented-button__iconOptional. Indicates an icon in the segment. We recommend using Material Icons from Google Fonts.
mdc-segmented-button__labelOptional. Indicates text in the segment.
mdc-segmented-button__segment--selectedOptional. Indicates that the segment is selected.
mdc-touch-target-wrapperOptional. Indicates contained segment has touch target support.
mdc-segmented-button--touchOptional. Indicates the segment has touch target support.
mdc-segmented-button__touchOptional. Indicates the segment has touch target support.
mdc-segmented-button__rippleOptional. 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

MixinDescription
outline-colorCustomizes the border color around each segment.
unselected-ink-colorCustomizes the text and icon ink color for an unselected segment.
unselected-container-fill-colorCustomizes the background color for an unselected segment.
selected-ink-colorCustomizes the text and icon ink color for a selected segment.
selected-container-fill-colorCustomizes 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 @material/segmented-button.

SegmentDetail

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

PropertyValue TypeDescription
indexnumberThe index of the segment.
selectedbooleanThe segment's selected state.
segmentId?string | undefinedThe segment's segmentId, if provided.

MDCSegmentedButton

Method SignatureDescription
getSelectedSegments() => readonly SegmentDetail[]Proxies to foundation's getSelectedSegments method.
selectSegment(indexOrSegmentId: number | string) => voidProxies to foundation's selectSegment method.
unselectSegment(indexOrSegmentId: number | string) => voidProxies to foundation's unselectSegment method.
isSegmentSelected(indexOrSegmentId: number | string) => booleanProxies to foundation's isSegmentSelected method.
PropertyValue TypeDescription
segmentsReadOnlyArray<MDCSegmentedButtonSegment>Array of child MDCSegmentedButtonSegments.
rippleMDCRipple (read-only)The MDCRipple instance for the root element that MDCSegmentedButton initializes.
Events
Event Nameevent.detailDescription
MDCSegmentedButton:changeSegmentDetailIndicates that a segment's selected value may have changed due to a click.

MDCSegmentedButtonSegment

Method SignatureDescription
setIndex(index: number) => voidSets segment's index.
setIsSingleSelect(isSingleSelect: boolean) => voidSets segment's isSingleSelect.
isSelected() => booleanProxies to foundation's isSelected method.
setSelected() => voidProxies to foundation's setSelected method.
setUnselected() => voidProxies to foundation's setUnselected method.
getSegmentId() => string | undefinedProxies to foundation's getSegmentId method.
Events
Event Nameevent.detailDescription
MDCSegmentedButtonSegment:selectedSegmentDetailIndicates 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 SignatureDescription
hasClass(className: string) => booleanReturns 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) => voidSets identified segment to be selected.
unselectSegment(indexOrSegmentId: number | string) => voidSet identified segment to be not selected.
notifySelectedChange(detail: SegmentDetail) => voidNotifies 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 SignatureDescription
isSingleSelect() => booleanReturns true if wrapping segmented button is single select, otherwise returns false.
getAttr(attrName: string) => string | nullReturns root element's attribute if it is set, otherwise returns null.
setAttr(attrName: string, value: string) => voidSets root element's attribute value to value.
addClass(className: string) => voidAdds class to the root element.
removeClass(className: string) => voidRemoves class from the root element.
hasClass(className: string) => booleanReturns true if root element has class, otherwise returns false.
notifySelectedChange(selected: boolean) => voidNotifies 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 SignatureDescription
selectSegment(indexOrSegmentId: number | string) => voidSets identified segment to be selected.
unselectSegment(indexOrSegmentId: number | string) => voidSet identified segment to be not selected.
getSelectedSegments() => readonly SegmentDetail[]Returns selected segments as readonly list of SegmentDetails.
isSegmentSelected(indexOrSegmentId: number | string) => booleanReturns true if identified segment is selected, otherwise returns false.
isSingleSelect() => booleanReturns true if segmented button is single select, otherwise returns false.
handleSelected(detail: SegmentDetail) => voidHandles 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:

EventsElement SelectorFoundation Handler
MDCSegmentedButtonSegment:selected.mdc-segmented-button (root)handleSelected

MDCSegmentedButtonSegmentFoundation

Method SignatureDescription
isSelected() => voidReturns true if segment is currently selected.
setSelected() => voidSets segment to be selected.
setUnselected() => voidSets segment to be not selected.
getSegmentId() => string | undefinedReturns segment's segmentId if it was provided, otherwise return undefined.
handleClick() => voidHandles 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:

EventsElement SelectorFoundation Handler
click.mdc-segmented-button__segment (root)handleClick

Keywords

FAQs

Package last updated on 19 Sep 2023

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc