Slider slider link

Full documentation: https://webawesome.com/docs/components/slider

<wa-slider> Stable Since 2.0

Sliders let users choose a numeric value within a defined range by dragging a thumb along a track.

<wa-slider
  label="Number of users"
  hint="Limit six per team"
  name="value"
  value="3"
  min="0"
  max="6"
  with-markers
  with-tooltip
>
  <span slot="reference">Less</span>
  <span slot="reference">More</span>
</wa-slider>

This component works with standard <form> elements. Please refer to the section on form controls to learn more about form submission and client-side validation.

Examples examples link

Labels labels link

Use the label attribute to give the slider an accessible label. For labels that contain HTML, use the label slot instead.

<wa-slider label="Volume" min="0" max="100"></wa-slider>

Hint hint link

Add descriptive hint to a slider with the hint attribute. For hints that contain HTML, use the hint slot instead.

<wa-slider label="Volume" hint="Controls the volume of the current song." min="0" max="100" value="50"></wa-slider>

Showing tooltips showing tooltips link

Use the with-tooltip attribute to display a tooltip with the current value when the slider is focused or being dragged.

<wa-slider label="Quality" name="quality" min="0" max="100" value="50" with-tooltip></wa-slider>

Setting min, max, and step setting min max and step link

Use the min and max attributes to define the slider’s range, and the step attribute to control the increment between values.

<wa-slider label="Between zero and one" min="0" max="1" step="0.1" value="0.5" with-tooltip></wa-slider>

Showing markers showing markers link

Use the with-markers attribute to display visual indicators at each step increment. This works best with sliders that have a smaller range of values.

<wa-slider label="Size" name="size" min="0" max="8" value="4" with-markers></wa-slider>

Adding references adding references link

Use the reference slot to add contextual labels below the slider. References are automatically spaced using space-between, making them easy to align with the start, center, and end positions.

<wa-slider
  label="Speed"
  name="speed"
  min="1"
  max="5"
  value="3"
  with-markers
  hint="Controls the speed of the thing you're currently doing."
>
  <span slot="reference">Slow</span>
  <span slot="reference">Medium</span>
  <span slot="reference">Fast</span>
</wa-slider>

If you want to show a reference next to a specific marker, you can add position: absolute to it and set the left, right, top, or bottom property to a percentage that corresponds to the marker’s position.

Formatting the value formatting the value link

Customize how values are displayed in tooltips and announced to screen readers using the valueFormatter property. Set it to a function that accepts a number and returns a formatted string. The Intl.NumberFormat API is particularly useful for this.

<!-- Percent -->
<wa-slider
  id="slider__percent"
  label="Percentage"
  name="percentage"
  value="0.5"
  min="0"
  max="1"
  step=".01"
  with-tooltip
></wa-slider
><br />

<script>
  const slider = document.getElementById('slider__percent');
  const formatter = new Intl.NumberFormat('en-US', { style: 'percent' });

  customElements.whenDefined('wa-slider').then(() => {
    slider.valueFormatter = value => formatter.format(value);
  });
</script>

<!-- Duration -->
<wa-slider id="slider__duration" label="Duration" name="duration" value="12" min="0" max="24" with-tooltip></wa-slider
><br />

<script>
  const slider = document.getElementById('slider__duration');
  const formatter = new Intl.NumberFormat('en-US', { style: 'unit', unit: 'hour', unitDisplay: 'long' });

  customElements.whenDefined('wa-slider').then(() => {
    slider.valueFormatter = value => formatter.format(value);
  });
</script>

<!-- Currency -->
<wa-slider id="slider__currency" label="Currency" name="currency" min="0" max="100" value="50" with-tooltip></wa-slider>

<script>
  const slider = document.getElementById('slider__currency');
  const formatter = new Intl.NumberFormat('en-US', {
    style: 'currency',
    currency: 'USD',
    currencyDisplay: 'symbol',
    maximumFractionDigits: 0,
  });

  customElements.whenDefined('wa-slider').then(() => {
    slider.valueFormatter = value => formatter.format(value);
  });
</script>

Range selection range selection link

Use the range attribute to enable dual-thumb selection for choosing a range of values. Set the initial thumb positions with the min-value and max-value attributes.

<wa-slider
  label="Price Range"
  hint="Select minimum and maximum price"
  name="price"
  range
  min="0"
  max="100"
  min-value="20"
  max-value="80"
  with-tooltip
  id="slider__range"
>
  <span slot="reference">$0</span>
  <span slot="reference">$50</span>
  <span slot="reference">$100</span>
</wa-slider>

<script>
  const slider = document.getElementById('slider__range');
  const formatter = new Intl.NumberFormat('en-US', { style: 'currency', currency: 'USD', maximumFractionDigits: 0 });

  customElements.whenDefined('wa-slider').then(() => {
    slider.valueFormatter = value => formatter.format(value);
  });
</script>

For range sliders, the minValue and maxValue properties represent the current positions of the thumbs. When the form is submitted, both values will be included as separate entries with the same name.

const slider = document.querySelector('wa-slider[range]');

// Get the current values
console.log(`Min value: ${slider.minValue}, Max value: ${slider.maxValue}`);

// Set the values programmatically
slider.minValue = 30;
slider.maxValue = 70;

Vertical Sliders vertical sliders link

Set the orientation attribute to vertical to create a vertical slider. Vertical sliders automatically center themselves and fill the available vertical space.

<div style="display: flex; gap: 1rem;">
  <wa-slider orientation="vertical" label="Volume" name="volume" value="65" style="width: 80px"></wa-slider>

  <wa-slider orientation="vertical" label="Bass" name="bass" value="50" style="width: 80px"></wa-slider>

  <wa-slider orientation="vertical" label="Treble" name="treble" value="40" style="width: 80px"></wa-slider>
</div>

Range sliders can also be vertical.

<div style="height: 300px; display: flex; align-items: center; gap: 2rem;">
  <wa-slider
    label="Temperature Range"
    orientation="vertical"
    range
    min="0"
    max="100"
    min-value="30"
    max-value="70"
    with-tooltip
    tooltip-placement="right"
    id="slider__vertical-range"
  >
  </wa-slider>
</div>

<script>
  const slider = document.getElementById('slider__vertical-range');
  slider.valueFormatter = value => {
    return new Intl.NumberFormat('en', {
      style: 'unit',
      unit: 'fahrenheit',
      unitDisplay: 'short',
      minimumFractionDigits: 0,
      maximumFractionDigits: 1,
    }).format(value);
  };
</script>

Size size link

Control the slider’s size using the size attribute. Valid options include xs, s, m, l, and xl.

<wa-slider size="xs" value="50" label="Extra Small"></wa-slider><br />
<wa-slider size="s" value="50" label="Small"></wa-slider><br />
<wa-slider size="m" value="50" label="Medium"></wa-slider><br />
<wa-slider size="l" value="50" label="Large"></wa-slider><br />
<wa-slider size="xl" value="50" label="Extra Large"></wa-slider>

Indicator Offset indicator offset link

By default, the filled indicator extends from the minimum value to the current position. Use the indicator-offset attribute to change the starting point of this visual indicator.

<wa-slider
  label="User Friendliness"
  hint="Did you find our product easy to use?"
  name="value"
  value="0"
  min="-5"
  max="5"
  indicator-offset="0"
  with-markers
  with-tooltip
>
  <span slot="reference">Easy</span>
  <span slot="reference">Moderate</span>
  <span slot="reference">Difficult</span>
</wa-slider>

Disabled disabled link

Use the disabled attribute to disable a slider.

<wa-slider label="Disabled" value="50" disabled></wa-slider>

Importing importing link

If you’re using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.

**CDN**

Import this component directly from the CDN:

import 'https://ka-f.webawesome.com/webawesome@3.7.0/components/slider/slider.js';

**npm**

After installing Web Awesome via npm, import this component:

import '@awesome.me/webawesome/dist/components/slider/slider.js';

**Self-Hosted**

If you’re self-hosting Web Awesome, import this component from your server:

import './webawesome/dist/components/slider/slider.js';

**React**

To import this component for React 18 or below, use the following code:

import WaSlider from '@awesome.me/webawesome/dist/react/slider/index.js';

Slots slots link

Learn more about using slots.

Attributes & Properties attributes properties link

Learn more about attributes and properties.

` By default, form controls are associated with the nearest containing element. This attribute allows you to place the form control outside of a form and associate it with the form that has this id. The form must be in the same document or shadow root for this to work. Type HTMLFormElement \| null | | | | `hint` hint | `string` The slider hint. If you need to display HTML, use the hint slot instead. Type Default ‘’ | | | | `indicatorOffset` indicator-offset | `number` The starting value from which to draw the slider’s fill, which is based on its current value. Type | | | | `isRange` | `boolean` Get if this is a range slider Type | | | | `label` label | `label` The slider’s . If you need to provide HTML in the label, use the label slot instead. Type string Default ‘’ | | | | `max` max | `number` The maximum value allowed. Type Default 100 | | | | `maxValue` max-value | `number` The maximum value of a range selection. Used only when range attribute is set. Type Default 50 | | | | `min` min | `number` The minimum value allowed. Type Default 0 | | | | `minValue` min-value | `number` The minimum value of a range selection. Used only when range attribute is set. Type Default 0 | | | | `name` name | `string \| null` The name of the slider. This will be submitted with the form as a name/value pair. Type Default null | | | | `orientation` orientation | `‘horizontal’ \| ‘vertical’` The orientation of the slider. Type Default ‘horizontal’ | | | | `range` range | `boolean` Converts the slider to a range slider with two thumbs. Type Default false | | | | `readonly` readonly | `boolean` Makes the slider a read-only field. Type Default false | | | | `size` size | `‘xs’ \| ‘s’ \| ‘m’ \| ‘l’ \| ‘xl’ \| ‘small’ \| ‘medium’ \| ‘large’` The slider’s size. Type Default ‘m’ | | | | `step` step | `number` The granularity the value must adhere to when incrementing and decrementing. Type Default 1 | | | | `tooltipDistance` tooltip-distance | `number` The distance of the tooltip from the slider’s thumb. Type Default 8 | | | | `tooltipPlacement` tooltip-placement | `‘top’ \| ‘right’ \| ‘bottom’ \| ‘left’` The placement of the tooltip in reference to the slider’s thumb. Type Default ‘top’ | | | | `validationTarget` | `undefined \| HTMLElement` Override validation target to point to the focusable element Type | | | | `validators` | `observedAttributes` Validators are static because they have , essentially attributes to “watch” for changes. Whenever these attributes change, we want to be notified and update the validator. Type Validator[] Default [] | | | | `value` | `number` The current value of the slider, submitted as a name/value pair with form data. Type | | | | `valueFormatter` | `(value: number) => string` A custom formatting function to apply to the value. This will be shown in the tooltip and announced by screen readers. Must be set with JavaScript. Property only. Type | | | | `withHint` with-hint | `true` Only required for SSR. Set to if you’re slotting in a hint element so the server-rendered markup includes the hint before the component hydrates on the client. Type boolean Default false | | | | `withLabel` with-label | `true` Only required for SSR. Set to if you’re slotting in a label element so the server-rendered markup includes the label before the component hydrates on the client. Type boolean Default false | | | | `withMarkers` with-markers | `boolean` Draws markers at each step along the slider. Type Default false | | | | `withTooltip` with-tooltip | `boolean` Draws a tooltip above the thumb when the control has focus or is dragged. Type Default false | | |

Methods methods link

Learn more about methods.

Events events link

Learn more about events.

CSS custom properties css custom properties link

Learn more about CSS custom properties.

Custom States custom states link

Learn more about custom states.

CSS parts css parts link

Learn more about CSS parts.

Dependencies dependencies link

This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.

• <wa-popup>
• <wa-tooltip>

Need a hand? Report a bug Ask for help