# Slider

URL: https://ark-ui.com/docs/components/slider
Source: https://raw.githubusercontent.com/chakra-ui/ark/refs/heads/main/website/src/content/pages/components/slider.mdx

A control element that allows for a range of selections.

---

<ComponentPreview id="Slider" />

## Anatomy

<Anatomy id="slider" />

```tsx
<Slider.Root>
  <Slider.Label />
  <Slider.ValueText />
  <Slider.Control>
    <Slider.Track>
      <Slider.Range />
    </Slider.Track>
    <Slider.Thumb>
      <Slider.HiddenInput />
    </Slider.Thumb>
  </Slider.Control>
  <Slider.MarkerGroup>
    <Slider.Marker />
  </Slider.MarkerGroup>
</Slider.Root>
```

## Examples

**Example: basic**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component Basic() {
  <Slider.Root class={styles.Root} defaultValue={[40]}>
    <div style={{ display: 'flex', justifyContent: 'space-between' }}>
      <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
      <Slider.ValueText class={styles.ValueText} />
    </div>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Range

You can add multiple thumbs to the slider by adding multiple `Slider.Thumb`

**Example: range**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component Range() {
  <Slider.Root defaultValue={[30, 60]} class={styles.Root}>
    <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
      <Slider.Thumb index={1} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Marks

You can add marks to the slider track by using the `Slider.MarkerGroup` and `Slider.Marker` components.

Position the `Slider.Marker` components relative to the track by providing the `value` prop.

**Example: with-marks**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

const marks = [0, 25, 50, 75, 100];

export component WithMarks() {
  <Slider.Root class={styles.Root} defaultValue={[50]}>
    <div style={{ display: 'flex', justifyContent: 'space-between' }}>
      <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
      <Slider.ValueText class={styles.ValueText} />
    </div>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
    <Slider.MarkerGroup class={styles.MarkerGroup}>
      for (const value of marks; key value) {
        <Slider.Marker {value} class={styles.Marker}>{value}</Slider.Marker>
      }
    </Slider.MarkerGroup>
  </Slider.Root>
}

```

### Min and Max

By default, the minimum is `0` and the maximum is `100`. If that's not what you want, you can easily specify different
bounds by changing the values of the `min` and/or `max` props.

For example, to ask the user for a value between `-10` and `10`, you can use:

**Example: min-max**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component MinMax() {
  <Slider.Root min={-10} max={10} defaultValue={[5]} class={styles.Root}>
    <div style={{ display: 'flex', justifyContent: 'space-between' }}>
      <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
      <Slider.ValueText class={styles.ValueText} />
    </div>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Granularity

By default, the granularity, is `1`, meaning that the value is always an integer. You can change the step attribute to
control the granularity.

For example, If you need a value between `5` and `10`, accurate to two decimal places, you should set the value of step
to `0.01`:

**Example: step**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component Step() {
  <Slider.Root step={0.01} min={5} max={10} defaultValue={[7.5]} class={styles.Root}>
    <div style={{ display: 'flex', justifyContent: 'space-between' }}>
      <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
      <Slider.ValueText class={styles.ValueText} />
    </div>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Change Events

When the slider value changes, the `onValueChange` and `onValueChangeEnd` callbacks are invoked. You can use this to set
up custom behaviors in your app.

**Example: on-event**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component OnEvent() {
  <Slider.Root
    onValueChange={(details) => console.log('onValueChange', details.value)}
    onValueChangeEnd={(details) => console.log('onValueChangeEnd', details.value)}
    class={styles.Root}
  >
    <div style={{ display: 'flex', justifyContent: 'space-between' }}>
      <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
      <Slider.ValueText class={styles.ValueText} />
    </div>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Orientation

By default, the slider is assumed to be horizontal. To change the orientation to vertical, set the orientation property
in the machine's context to vertical.

In this mode, the slider will use the arrow up and down keys to increment/decrement its value.

> Don't forget to change the styles of the vertical slider by specifying its height

**Example: vertical**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component Vertical() {
  <Slider.Root orientation="vertical" class={styles.Root}>
    <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
    <Slider.ValueText class={styles.ValueText} />
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Origin

By default, the slider's origin is at the start of the track. To change the origin to the center of the track, set the
`origin` prop to `center`.

**Example: center-origin**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component CenterOrigin() {
  <Slider.Root origin="center" class={styles.Root} defaultValue={[75]}>
    <div style={{ display: 'flex', justifyContent: 'space-between' }}>
      <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
      <Slider.ValueText class={styles.ValueText} />
    </div>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Root Provider

An alternative way to control the slider is to use the `RootProvider` component and the `useSlider` hook. This way you
can access the state and methods from outside the component.

**Example: root-provider**

```ripple
import { Slider, useSlider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';
import button from 'styles/button.module.css';

export component RootProvider() {
  const slider = useSlider();

  <button class={button.Root} onClick={() => @slider.focus()}>{'Focus'}</button>
  <Slider.RootProvider value={slider} class={styles.Root}>
    <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
    <Slider.ValueText class={styles.ValueText} />
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.RootProvider>
}

```

### Dragging Indicator

Use the `Slider.DraggingIndicator` component inside `Slider.Thumb` to show a visual indicator while the thumb is being
dragged.

**Example: dragging-indicator**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component DraggingIndicator() {
  <Slider.Root class={styles.Root} defaultValue={[40]}>
    <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.DraggingIndicator class={styles.DraggingIndicator} />
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Thumb Overlap

Use the `minStepsBetweenThumbs` prop to prevent range slider thumbs from overlapping. This ensures a minimum gap between
thumbs, which is useful for price range filters and similar use cases.

**Example: thumb-overlap**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component ThumbOverlap() {
  <Slider.Root minStepsBetweenThumbs={5} defaultValue={[25, 60]} class={styles.Root}>
    <div style={{ display: 'flex', justifyContent: 'space-between' }}>
      <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
      <Slider.ValueText class={styles.ValueText} />
    </div>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
      <Slider.Thumb index={1} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

### Thumb Collision

Use the `thumbCollisionBehavior` prop to control how thumbs behave when they collide during pointer interactions.
Supported values are `push` (default), `swap`, and `none`.

**Example: thumb-collision**

```ripple
import { Slider } from 'ark-ripple/slider';
import styles from 'styles/slider.module.css';

export component ThumbCollision() {
  <Slider.Root thumbCollisionBehavior="push" defaultValue={[25, 60]} class={styles.Root}>
    <div style={{ display: 'flex', justifyContent: 'space-between' }}>
      <Slider.Label class={styles.Label}>{'Label'}</Slider.Label>
      <Slider.ValueText class={styles.ValueText} />
    </div>
    <Slider.Control class={styles.Control}>
      <Slider.Track class={styles.Track}>
        <Slider.Range class={styles.Range} />
      </Slider.Track>
      <Slider.Thumb index={0} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
      <Slider.Thumb index={1} class={styles.Thumb}>
        <Slider.HiddenInput />
      </Slider.Thumb>
    </Slider.Control>
  </Slider.Root>
}

```

## API Reference

### Props

**Component API Reference**

**Root Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `aria-label` | `string[]` | No | The aria-label of each slider thumb. Useful for providing an accessible name to the slider |
| `aria-labelledby` | `string[]` | No | The `id` of the elements that labels each slider thumb. Useful for providing an accessible name to the slider |
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |
| `defaultValue` | `number[]` | No | The initial value of the slider when rendered.
Use when you don't need to control the value of the slider. |
| `disabled` | `boolean` | No | Whether the slider is disabled |
| `form` | `string` | No | The associate form of the underlying input element. |
| `getAriaValueText` | `(details: ValueTextDetails) => string` | No | Function that returns a human readable value for the slider thumb |
| `id` | `string` | No | The unique identifier of the machine. |
| `ids` | `Partial<{
  root: string
  thumb: (index: number) => string
  hiddenInput: (index: number) => string
  control: string
  track: string
  range: string
  label: string
  valueText: string
  marker: (index: number) => string
}>` | No | The ids of the elements in the slider. Useful for composition. |
| `invalid` | `boolean` | No | Whether the slider is invalid |
| `max` | `number` | No | The maximum value of the slider |
| `min` | `number` | No | The minimum value of the slider |
| `minStepsBetweenThumbs` | `number` | No | The minimum permitted steps between multiple thumbs.

`minStepsBetweenThumbs` * `step` should reflect the gap between the thumbs.

- `step: 1` and `minStepsBetweenThumbs: 10` => gap is `10`
- `step: 10` and `minStepsBetweenThumbs: 2` => gap is `20` |
| `name` | `string` | No | The name associated with each slider thumb (when used in a form) |
| `onFocusChange` | `(details: FocusChangeDetails) => void` | No | Function invoked when the slider's focused index changes |
| `onValueChange` | `(details: ValueChangeDetails) => void` | No | Function invoked when the value of the slider changes |
| `onValueChangeEnd` | `(details: ValueChangeDetails) => void` | No | Function invoked when the slider value change is done |
| `orientation` | `'horizontal' | 'vertical'` | No | The orientation of the slider |
| `origin` | `'center' | 'start' | 'end'` | No | The origin of the slider range. The track is filled from the origin
to the thumb for single values.
- "start": Useful when the value represents an absolute value
- "center": Useful when the value represents an offset (relative)
- "end": Useful when the value represents an offset from the end |
| `readOnly` | `boolean` | No | Whether the slider is read-only |
| `step` | `number` | No | The step value of the slider |
| `thumbAlignment` | `'center' | 'contain'` | No | The alignment of the slider thumb relative to the track
- `center`: the thumb will extend beyond the bounds of the slider track.
- `contain`: the thumb will be contained within the bounds of the track. |
| `thumbCollisionBehavior` | `'none' | 'push' | 'swap'` | No | Controls how thumbs behave when they collide during pointer interactions.
- `none` (default): Thumbs cannot move past each other; excess movement is ignored.
- `push`: Thumbs push each other without restoring their previous positions when dragged back.
- `swap`: Thumbs swap places when dragged past each other. |
| `thumbSize` | `{ width: number; height: number }` | No | The slider thumbs dimensions |
| `value` | `number[]` | No | The controlled value of the slider |


**Root Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | root |
| `[data-disabled]` | Present when disabled |
| `[data-orientation]` | The orientation of the slider |
| `[data-dragging]` | Present when in the dragging state |
| `[data-invalid]` | Present when invalid |
| `[data-focus]` | Present when focused |


**Root CSS Variables:**

| Variable | Description |
|----------|-------------|
| `--slider-thumb-width` | The thumb width of the slider |
| `--slider-thumb-height` | The thumb height of the slider |
| `--slider-thumb-transform` | The thumb transform of the slider |
| `--slider-range-start` | The range start of the slider |
| `--slider-range-end` | The range end of the slider |
| `--translate-x` | The horizontal translation value |
| `--translate-y` | The vertical translation value |


**Control Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Control Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | control |
| `[data-dragging]` | Present when in the dragging state |
| `[data-disabled]` | Present when disabled |
| `[data-orientation]` | The orientation of the control |
| `[data-invalid]` | Present when invalid |
| `[data-focus]` | Present when focused |


**DraggingIndicator Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**DraggingIndicator Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | dragging-indicator |
| `[data-orientation]` | The orientation of the draggingindicator |
| `[data-state]` | "open" | "closed" |


**HiddenInput Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Label Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Label Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | label |
| `[data-disabled]` | Present when disabled |
| `[data-orientation]` | The orientation of the label |
| `[data-invalid]` | Present when invalid |
| `[data-dragging]` | Present when in the dragging state |
| `[data-focus]` | Present when focused |


**MarkerGroup Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**MarkerGroup Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | marker-group |
| `[data-orientation]` | The orientation of the markergroup |


**Marker Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `value` | `number` | Yes |  |
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Marker Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | marker |
| `[data-orientation]` | The orientation of the marker |
| `[data-value]` | The value of the item |
| `[data-disabled]` | Present when disabled |
| `[data-state]` |  |


**Range Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Range Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | range |
| `[data-dragging]` | Present when in the dragging state |
| `[data-focus]` | Present when focused |
| `[data-invalid]` | Present when invalid |
| `[data-disabled]` | Present when disabled |
| `[data-orientation]` | The orientation of the range |


**RootProvider Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `value` | `UseSliderReturn` | Yes |  |
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Thumb Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `index` | `number` | Yes |  |
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |
| `name` | `string` | No |  |


**Thumb Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | thumb |
| `[data-index]` | The index of the item |
| `[data-name]` |  |
| `[data-disabled]` | Present when disabled |
| `[data-orientation]` | The orientation of the thumb |
| `[data-focus]` | Present when focused |
| `[data-dragging]` | Present when in the dragging state |


**Track Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Track Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | track |
| `[data-disabled]` | Present when disabled |
| `[data-invalid]` | Present when invalid |
| `[data-dragging]` | Present when in the dragging state |
| `[data-orientation]` | The orientation of the track |
| `[data-focus]` | Present when focused |


**ValueText Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**ValueText Data Attributes:**

| Attribute | Value |
|-----------|-------|
| `[data-scope]` | slider |
| `[data-part]` | value-text |
| `[data-disabled]` | Present when disabled |
| `[data-orientation]` | The orientation of the valuetext |
| `[data-invalid]` | Present when invalid |
| `[data-focus]` | Present when focused |


### Context

**API:**

| Property | Type | Description |
|----------|------|-------------|
| `value` | `number[]` | The value of the slider. |
| `dragging` | `boolean` | Whether the slider is being dragged. |
| `focused` | `boolean` | Whether the slider is focused. |
| `setValue` | `(value: number[]) => void` | Function to set the value of the slider. |
| `getThumbValue` | `(index: number) => number` | Returns the value of the thumb at the given index. |
| `setThumbValue` | `(index: number, value: number) => void` | Sets the value of the thumb at the given index. |
| `getValuePercent` | `(value: number) => number` | Returns the percent of the thumb at the given index. |
| `getPercentValue` | `(percent: number) => number` | Returns the value of the thumb at the given percent. |
| `getThumbPercent` | `(index: number) => number` | Returns the percent of the thumb at the given index. |
| `setThumbPercent` | `(index: number, percent: number) => void` | Sets the percent of the thumb at the given index. |
| `getThumbMin` | `(index: number) => number` | Returns the min value of the thumb at the given index. |
| `getThumbMax` | `(index: number) => number` | Returns the max value of the thumb at the given index. |
| `increment` | `(index: number) => void` | Function to increment the value of the slider at the given index. |
| `decrement` | `(index: number) => void` | Function to decrement the value of the slider at the given index. |
| `focus` | `VoidFunction` | Function to focus the slider. This focuses the first thumb. |


## Accessibility

Complies with the [Slider WAI-ARIA design pattern](https://www.w3.org/WAI/ARIA/apg/patterns/slider/).

### Keyboard Support

<KeyBindingsTable id="slider" />