shoelace/docs/components/range.md

Range

[component-header:sl-range]

Ranges allow the user to select a single value within a given range using a slider.

<sl-range></sl-range>

?> This component doesn't work with standard forms. Use <sl-form> instead.

Examples

Disabled

Use the disabled attribute to disable a slider.

<sl-range min="0" max="100" step="1" disabled></sl-range>

Tooltip Placement

By default, the tooltip is shown on top. Set tooltip to bottom to show it below the slider.

<sl-range min="0" max="100" step="1" tooltip="bottom"></sl-range>

Disable the Tooltip

To disable the tooltip, set tooltip to none.

<sl-range min="0" max="100" step="1" tooltip="none"></sl-range>

Custom Track Colors

You can customize the active and inactive portions of the track using the --track-color-active and --track-color-inactive custom properties.

<sl-range style="
  --track-color-active: rgb(var(--sl-color-primary-600));
  --track-color-inactive: rgb(var(--sl-color-primary-200));
"></sl-range>

Custom Tooltip Formatter

You can change the tooltip's content by setting the tooltipFormatter property to a function that accepts the range's value as an argument.

<sl-range min="0" max="100" step="1" class="range-with-custom-formatter"></sl-range>

<script>
  const range = document.querySelector('.range-with-custom-formatter');
  range.tooltipFormatter = value => `Total - ${value}%`;
</script>

Labels

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

<sl-range label="Volume" min="0" max="100"></sl-input>

Help Text

Add descriptive help text to a range with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.

<sl-range 
  label="Volume" 
  help-text="Controls the volume of the current song."
  min="0"
  max="100"
></sl-input>

[component-metadata:sl-range]