Slider

Numeric value control on a draggable track.

Examples

Default

Volume40

import { Slider } from '@var-ui/react';

<Slider label="Volume" defaultValue={40} />

Props

Accessibility

Built on React Aria Components where applicable.

Props

Prop	Type	Default	Description
`className`	`string \| undefined`	—	—
`description`	`string \| undefined`	—	Helper text shown below the control when there is no error.
`errorMessage`	`string \| undefined`	—	Validation message; when set, the field is shown in an error state.
`label`	`string \| undefined`	—	Visible label rendered above the control.
`showOutput`	`boolean \| undefined`	`true`	Show the current value beside the label.

React Aria props

Prop	Type	Default	Description
`aria-describedby`	`string \| undefined`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string \| undefined`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.
`aria-label`	`string \| undefined`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string \| undefined`	—	Identifies the element (or elements) that labels the current element.
`children`	`ChildrenOrFunction<SliderRenderProps>`	—	The children of the component. A function may be provided to alter the children based on component state.
`defaultValue`	`number \| number[] \| undefined`	—	The default value (uncontrolled).
`dir`	`string \| undefined`	—	—
`formatOptions`	`NumberFormatOptions \| undefined`	—	The display format of the value label.
`hidden`	`boolean \| undefined`	—	—
`id`	`string \| undefined`	—	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
`inert`	`boolean \| undefined`	—	—
`lang`	`string \| undefined`	—	—
`onAnimationEnd`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationEndCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationIteration`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationIterationCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationStart`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationStartCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAuxClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onAuxClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onChange`	`((value: number \| number[]) => void) \| undefined`	—	Handler that is called when the value changes.
`onClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onContextMenu`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onContextMenuCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onDoubleClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onDoubleClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onGotPointerCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onGotPointerCaptureCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onLostPointerCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onLostPointerCaptureCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseDown`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseDownCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseEnter`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseLeave`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseMove`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseMoveCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOut`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOutCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOver`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOverCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseUp`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseUpCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerCancel`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerCancelCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerDown`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerDownCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerEnter`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerLeave`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerMove`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerMoveCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOut`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOutCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOver`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOverCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerUp`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerUpCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onScroll`	`UIEventHandler<HTMLDivElement> \| undefined`	—	—
`onScrollCapture`	`UIEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchCancel`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchCancelCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchEnd`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchEndCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchMove`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchMoveCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchStart`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchStartCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionCancel`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionCancelCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionEnd`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionEndCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionRun`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionRunCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionStart`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionStartCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onWheel`	`WheelEventHandler<HTMLDivElement> \| undefined`	—	—
`onWheelCapture`	`WheelEventHandler<HTMLDivElement> \| undefined`	—	—
`render`	`DOMRenderFunction<"div", SliderRenderProps> \| undefined`	—	Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
`slot`	`string \| null \| undefined`	—	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.
`style`	`StyleOrFunction<SliderRenderProps> \| undefined`	—	The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
`translate`	`"yes" \| "no" \| undefined`	—	—
`value`	`number \| number[] \| undefined`	—	The current value (controlled).

DOM props (6)

Prop	Type	Default	Description
`isDisabled`	`boolean \| undefined`	—	Whether the whole Slider is disabled.
`maxValue`	`number \| undefined`	`100`	The slider's maximum value.
`minValue`	`number \| undefined`	`0`	The slider's minimum value.
`onChangeEnd`	`((value: number \| number[]) => void) \| undefined`	—	Fired when the slider stops moving, due to being let go.
`orientation`	`Orientation \| undefined`	`'horizontal'`	The orientation of the Slider.
`step`	`number \| undefined`	`1`	The slider's step value.

Theme this component via createDesignTheme({ components: { slider: … } }). See Customize for the full override API.

Public classes and data attributes from @var-ui/core slider().

root

Name	Example	Description
`class`	`var-ui-slider`	Root / part class name

label

Name	Example	Description
`class`	`var-ui-slider__label`	Root / part class name

description

Name	Example	Description
`class`	`var-ui-slider__description`	Root / part class name

error

Name	Example	Description
`class`	`var-ui-slider__error`	Root / part class name

control

Name	Example	Description
`class`	`var-ui-slider__control`	Root / part class name

track

Name	Example	Description
`class`	`var-ui-slider__track`	Root / part class name

fill

Name	Example	Description
`class`	`var-ui-slider__fill`	Root / part class name

thumb

Name	Example	Description
`class`	`var-ui-slider__thumb`	Root / part class name

output

Name	Example	Description
`class`	`var-ui-slider__output`	Root / part class name

Apply via `recipeProps(recipe(…))` or copy the class / data attributes onto your markup.