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

@material/slider

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@material/slider

The Material Components for the web slider component

14.0.0
latest
Source
npm

Version published: 3 years ago

Weekly downloads: 675K; decreased by-10.11%

Maintainers: 15

Weekly downloads

Created: 8 years ago

What is @material/slider?

@material/slider is a Material Design slider component for the web. It provides a range of features for creating sliders that are consistent with the Material Design guidelines. This package allows developers to create sliders with various configurations, including discrete and continuous sliders, and provides customization options for styling and behavior.

What are @material/slider's main functionalities?

Basic Slider

This code sample demonstrates how to create a basic slider using the @material/slider package. The slider is initialized and an event listener is added to log the value whenever it changes.

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://unpkg.com/@material/slider/dist/mdc.slider.css">
  <script src="https://unpkg.com/@material/slider/dist/mdc.slider.js"></script>
</head>
<body>
  <div class="mdc-slider" tabindex="0" role="slider" aria-valuemin="0" aria-valuemax="100" aria-valuenow="50" aria-label="Select Value">
    <div class="mdc-slider__track-container">
      <div class="mdc-slider__track"></div>
    </div>
    <div class="mdc-slider__thumb-container">
      <div class="mdc-slider__pin">
        <span class="mdc-slider__pin-value-marker"></span>
      </div>
      <svg class="mdc-slider__thumb" width="21" height="21">
        <circle cx="10.5" cy="10.5" r="7.875"></circle>
      </svg>
      <div class="mdc-slider__focus-ring"></div>
    </div>
  </div>
  <script>
    const slider = new mdc.slider.MDCSlider(document.querySelector('.mdc-slider'));
    slider.listen('MDCSlider:change', () => console.log(`Value changed to ${slider.value}`));
  </script>
</body>
</html>

Discrete Slider with Tick Marks

This code sample demonstrates how to create a discrete slider with tick marks using the @material/slider package. The slider is configured to display discrete values and markers along the track.

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://unpkg.com/@material/slider/dist/mdc.slider.css">
  <script src="https://unpkg.com/@material/slider/dist/mdc.slider.js"></script>
</head>
<body>
  <div class="mdc-slider mdc-slider--discrete mdc-slider--display-markers" tabindex="0" role="slider" aria-valuemin="0" aria-valuemax="100" aria-valuenow="50" aria-label="Select Value">
    <div class="mdc-slider__track-container">
      <div class="mdc-slider__track"></div>
      <div class="mdc-slider__track-marker-container"></div>
    </div>
    <div class="mdc-slider__thumb-container">
      <div class="mdc-slider__pin">
        <span class="mdc-slider__pin-value-marker"></span>
      </div>
      <svg class="mdc-slider__thumb" width="21" height="21">
        <circle cx="10.5" cy="10.5" r="7.875"></circle>
      </svg>
      <div class="mdc-slider__focus-ring"></div>
    </div>
  </div>
  <script>
    const slider = new mdc.slider.MDCSlider(document.querySelector('.mdc-slider'));
    slider.listen('MDCSlider:change', () => console.log(`Value changed to ${slider.value}`));
  </script>
</body>
</html>

Range Slider

This code sample demonstrates how to create a range slider using the @material/slider package. The range slider allows users to select a range of values within a specified minimum and maximum.

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://unpkg.com/@material/slider/dist/mdc.slider.css">
  <script src="https://unpkg.com/@material/slider/dist/mdc.slider.js"></script>
</head>
<body>
  <div class="mdc-slider mdc-slider--range" tabindex="0" role="slider" aria-valuemin="0" aria-valuemax="100" aria-valuenow="50" aria-label="Select Value">
    <div class="mdc-slider__track-container">
      <div class="mdc-slider__track"></div>
    </div>
    <div class="mdc-slider__thumb-container">
      <div class="mdc-slider__pin">
        <span class="mdc-slider__pin-value-marker"></span>
      </div>
      <svg class="mdc-slider__thumb" width="21" height="21">
        <circle cx="10.5" cy="10.5" r="7.875"></circle>
      </svg>
      <div class="mdc-slider__focus-ring"></div>
    </div>
    <div class="mdc-slider__thumb-container">
      <div class="mdc-slider__pin">
        <span class="mdc-slider__pin-value-marker"></span>
      </div>
      <svg class="mdc-slider__thumb" width="21" height="21">
        <circle cx="10.5" cy="10.5" r="7.875"></circle>
      </svg>
      <div class="mdc-slider__focus-ring"></div>
    </div>
  </div>
  <script>
    const slider = new mdc.slider.MDCSlider(document.querySelector('.mdc-slider'));
    slider.listen('MDCSlider:change', () => console.log(`Value changed to ${slider.value}`));
  </script>
</body>
</html>

Other packages similar to @material/slider

Slider

Sliders allow users to make selections from a range of values.

The MDC Slider implementation supports both single point sliders (one thumb) and range sliders (two thumbs). It is backed by the browser <input type="range"> element, is fully accessible, and is RTL-aware.

Contents

Using sliders

Installing sliders

npm install @material/slider

Styles

@use "@material/slider/styles";

JavaScript instantiation

import {MDCSlider} from '@material/slider';

const slider = new MDCSlider(document.querySelector('.mdc-slider'));

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

Making sliders accessible

Sliders are backed by an <input> element, meaning that they are fully accessible. Unlike the ARIA-based slider, MDC sliders are adjustable using touch-based assistive technologies such as TalkBack on Android.

Per the spec, ensure that the following attributes are added to the input element(s):

value: Value representing the current value.
min: Value representing the minimum allowed value.
max: Value representing the maximum allowed value.
aria-label or aria-labelledby: Accessible label for the slider.

If the value is not user-friendly (e.g. a number to represent the day of the week), also set the following:

aria-valuetext: Set this input attribute to a string that makes the slider value understandable, e.g. 'Monday'.
Add a function to map the slider value to aria-valuetext via the MDCSlider#setValueToAriaValueTextFn method.

Sliders

There are two types of sliders:

Continuous slider

Continuous sliders allow users to make meaningful selections that don’t require a specific value.

Note: The step size for value quantization is, by default, 1. To specify a custom step size, provide a value for the step attribute on the input element.

<div class="mdc-slider">
  <input class="mdc-slider__input" type="range" min="0" max="100" value="50" name="volume" aria-label="Continuous slider demo">
  <div class="mdc-slider__track">
    <div class="mdc-slider__track--inactive"></div>
    <div class="mdc-slider__track--active">
      <div class="mdc-slider__track--active_fill"></div>
    </div>
  </div>
  <div class="mdc-slider__thumb">
    <div class="mdc-slider__thumb-knob"></div>
  </div>
</div>

Continuous range slider

Note: By default there's no minimum distance between the two thumbs. To specify one, provide a value for the data-min-range attribute on the root element and adjust the min and max attributes on the input elements accordingly.

<div class="mdc-slider mdc-slider--range" data-min-range="10">
  <input class="mdc-slider__input" type="range" min="0" max="60" value="30" name="rangeStart" aria-label="Continuous range slider demo">
  <input class="mdc-slider__input" type="range" min="40" max="100" value="70" name="rangeEnd" aria-label="Continuous range slider demo">
  <div class="mdc-slider__track">
    <div class="mdc-slider__track--inactive"></div>
    <div class="mdc-slider__track--active">
      <div class="mdc-slider__track--active_fill"></div>
    </div>
  </div>
  <div class="mdc-slider__thumb">
    <div class="mdc-slider__thumb-knob"></div>
  </div>
  <div class="mdc-slider__thumb">
    <div class="mdc-slider__thumb-knob"></div>
  </div>
</div>

Discrete slider

Discrete sliders display a numeric value label upon pressing the thumb, which allows a user to select an exact value.

To create a discrete slider, add the following:

mdc-slider--discrete class on the root element.
Value indicator element (mdc-slider__value-indicator-container), as shown below.

<div class="mdc-slider mdc-slider--discrete">
  <input class="mdc-slider__input" type="range" min="0" max="100" value="50" name="volume" step="10" aria-label="Discrete slider demo">
  <div class="mdc-slider__track">
    <div class="mdc-slider__track--inactive"></div>
    <div class="mdc-slider__track--active">
      <div class="mdc-slider__track--active_fill"></div>
    </div>
  </div>
  <div class="mdc-slider__thumb">
    <div class="mdc-slider__value-indicator-container" aria-hidden="true">
      <div class="mdc-slider__value-indicator">
        <span class="mdc-slider__value-indicator-text">
          50
        </span>
      </div>
    </div>
    <div class="mdc-slider__thumb-knob"></div>
  </div>
</div>

Discrete slider with tick marks

Discrete sliders can optionally display tick marks. Tick marks represent predetermined values to which the user can move the slider.

To add tick marks to a discrete slider, add the following:

mdc-slider--tick-marks class on the root element
mdc-slider__tick-marks element as a child of the mdc-slider__track element
mdc-slider__tick-mark--active and mdc-slider__tick-mark--inactive elements as children of the mdc-slider__tick-marks element

<div class="mdc-slider mdc-slider--discrete mdc-slider--tick-marks">
  <input class="mdc-slider__input" type="range" min="0" max="100" value="50" name="volume" step="10" aria-label="Discrete slider with tick marks demo">
  <div class="mdc-slider__track">
    <div class="mdc-slider__track--inactive"></div>
    <div class="mdc-slider__track--active">
      <div class="mdc-slider__track--active_fill"></div>
    </div>
    <div class="mdc-slider__tick-marks">
      <div class="mdc-slider__tick-mark--active"></div>
      <div class="mdc-slider__tick-mark--active"></div>
      <div class="mdc-slider__tick-mark--active"></div>
      <div class="mdc-slider__tick-mark--active"></div>
      <div class="mdc-slider__tick-mark--active"></div>
      <div class="mdc-slider__tick-mark--active"></div>
      <div class="mdc-slider__tick-mark--inactive"></div>
      <div class="mdc-slider__tick-mark--inactive"></div>
      <div class="mdc-slider__tick-mark--inactive"></div>
      <div class="mdc-slider__tick-mark--inactive"></div>
      <div class="mdc-slider__tick-mark--inactive"></div>
    </div>
  </div>
  <div class="mdc-slider__thumb">
    <div class="mdc-slider__value-indicator-container" aria-hidden="true">
      <div class="mdc-slider__value-indicator">
        <span class="mdc-slider__value-indicator-text">
          50
        </span>
      </div>
    </div>
    <div class="mdc-slider__thumb-knob"></div>
  </div>
</div>

Discrete range slider

<div class="mdc-slider mdc-slider--range mdc-slider--discrete">
  <input class="mdc-slider__input" type="range" min="0" max="50" value="20" step="10" name="rangeStart" aria-label="Discrete range slider demo">
  <input class="mdc-slider__input" type="range" min="20" max="100" value="50" step="10" name="rangeEnd" aria-label="Discrete range slider demo">
  <div class="mdc-slider__track">
    <div class="mdc-slider__track--inactive"></div>
    <div class="mdc-slider__track--active">
      <div class="mdc-slider__track--active_fill"></div>
    </div>
  </div>
  <div class="mdc-slider__thumb">
    <div class="mdc-slider__value-indicator-container" aria-hidden="true">
      <div class="mdc-slider__value-indicator">
        <span class="mdc-slider__value-indicator-text">
          20
        </span>
      </div>
    </div>
    <div class="mdc-slider__thumb-knob"></div>
  </div>
  <div class="mdc-slider__thumb">
    <div class="mdc-slider__value-indicator-container" aria-hidden="true">
      <div class="mdc-slider__value-indicator">
        <span class="mdc-slider__value-indicator-text">
          50
        </span>
      </div>
    </div>
    <div class="mdc-slider__thumb-knob"></div>
  </div>
</div>

Other variants

Disabled slider

To disable a slider, add the following:

mdc-slider--disabled class on the root element
disabled attribute on the input element

<div class="mdc-slider mdc-slider--disabled">
  <input class="mdc-slider__input" type="range" min="0" max="100" value="50" step="10" disabled name="volume" aria-label="Disabled slider demo">
  <div class="mdc-slider__track">
    <div class="mdc-slider__track--inactive"></div>
    <div class="mdc-slider__track--active">
      <div class="mdc-slider__track--active_fill"></div>
    </div>
  </div>
  <div class="mdc-slider__thumb">
    <div class="mdc-slider__thumb-knob"></div>
  </div>
</div>

Additional information

Initialization with custom ranges and values

When MDCSlider is initialized, it reads the input element's min, max, and value attributes if present, using them to set the component's internal min, max, and value properties.

Use these attributes to initialize the slider with a custom range and values, as shown below:

<div class="mdc-slider">
  <input class="mdc-slider__input" aria-label="Slider demo" min="0" max="100" value="75">
  <!-- ... -->
</div>

Setting slider position before component initialization

When MDCSlider is initialized, it updates the slider track and thumb positions based on the internal value(s). To set the correct track and thumb positions before component initialization, mark up the DOM as follows:

Calculate rangePercentDecimal, the active track range as a percentage of the entire track, i.e. (valueEnd - valueStart) / (max - min). Set transform:scaleX(<rangePercentDecimal>) as an inline style on the mdc-slider__track--active_fill element.
Calculate thumbEndPercent, the initial position of the end thumb as a percentage of the entire track. Set left:calc(<thumbEndPercent>% - 24px) as an inline style on the end thumb (mdc-slider__thumb) element (or right for RTL layouts).
[Range sliders only] Calculate thumbStartPercent, the initial position of the start thumb as a percentage of the entire track. Set left:calc(<thumbStartPercent>% - 24px) as an inline style on the start thumb (mdc-slider__thumb) element (or right for RTL layouts).
[Range sliders only] Using the previously calculated thumbStartPercent, set left:<thumbStartPercent>% as an inline style on the mdc-slider__track--active_fill element (or right for RTL layouts).

Additionally, the MDCSlider component should be initialized with skipInitialUIUpdate set to true.

Range slider example

This is an example of a range slider with internal values of [min, max] = [0, 100] and [start, end] = [30, 70], and a minimum range of 10.

<div class="mdc-slider mdc-slider--range" data-min-range="10">
  <input class="mdc-slider__input" type="range" min="0" max="60" value="30" name="rangeStart" aria-label="Range slider demo">
  <input class="mdc-slider__input" type="range" min="40" max="100" value="70" name="rangeEnd" aria-label="Range slider demo">
  <div class="mdc-slider__track">
    <div class="mdc-slider__track--inactive"></div>
    <div class="mdc-slider__track--active">
      <div class="mdc-slider__track--active_fill"
           style="transform:scaleX(.4); left:30%"></div>
    </div>
  </div>
  <div class="mdc-slider__thumb" style="left:calc(30%-24px)">
    <div class="mdc-slider__thumb-knob"></div>
  </div>
  <div class="mdc-slider__thumb" style="left:calc(70%-24px)">
    <div class="mdc-slider__thumb-knob"></div>
  </div>
</div>

API

Sass mixins

Mixin	Description
`track-active-color($color)`	Sets the color of the active track.
`track-inactive-color($color, $opacity)`	Sets the color and opacity of the inactive track.
`thumb-color($color)`	Sets the color of the thumb.
`thumb-ripple-color($color)`	Sets the color of the thumb ripple.
`tick-mark-active-color($color)`	Sets the color of tick marks on the active track.
`tick-mark-inactive-color($color)`	Sets the color of tick marks on the inactive track.
`value-indicator-color($color, $opaicty)`	Sets the color and opacity of the value indicator.
`value-indicator-text-color($color, $opaicty)`	Sets the color of the value indicator text.

`MDCSlider` events

Event name	`event.detail`	Description
`MDCSlider:change`	`MDCSliderChangeEventDetail`	Emitted when a value has been changed and committed from a user event. Mirrors the native `change` event: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
`MDCSlider:input`	`MDCSliderChangeEventDetail`	Emitted when a value has been changed from a user event. Mirrors the native `input` event: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event

`MDCSlider` methods

Method Signature	Description
`getValueStart() => number`	Gets the value of the start thumb (only applicable for range sliders).
`setValueStart(valueStart: number) => void`	Sets the value of the start thumb (only applicable for range sliders).
`getValue() => number`	Gets the value of the thumb (for single point sliders), or the end thumb (for range sliders).
`setValue(value: number) => void`	Sets the value of the thumb (for single point sliders), or the end thumb (for range sliders).
`getDisabled() => boolean`	Gets the disabled state of the slider.
`setDisabled(disabled: boolean) => void`	Sets the disabled state of the slider.
`setValueToAriaValueTextFn((mapFn: ((value: number) => string) \| null) => void`	Sets a function that maps the slider value to value of the `aria-valuetext` attribute on the thumb element. If not set, the `aria-valuetext` attribute is unchanged when the value changes.

Usage within frameworks

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

See MDCSliderAdapter and MDCSliderFoundation for up-to-date code documentation of slider foundation API's.

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/slider?

Is @material/slider popular?

Is @material/slider 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/slider

What is @material/slider?

What are @material/slider's main functionalities?

Other packages similar to @material/slider

rc-slider

nouislider

react-slider

Slider

Using sliders

Installing sliders

Styles

JavaScript instantiation

Making sliders accessible

Sliders

Continuous slider

Continuous range slider

Discrete slider

Discrete slider with tick marks

Discrete range slider

Other variants

Disabled slider

Additional information

Initialization with custom ranges and values

Setting slider position before component initialization

Range slider example

API

Sass mixins

MDCSlider events

MDCSlider methods

Usage within frameworks

14.0.0 (2022-04-27)

Bug Fixes

Features

BREAKING CHANGES

Keywords

Related posts

Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts

Supply Chain Attack on Rspack npm Packages Injects Cryptojacking Malware

Skuld Infostealer Returns to npm with Fake Windows Utilities and Malicious Solara Development Packages

`MDCSlider` events

`MDCSlider` methods