Askr documentation
Generated API snapshot

@askrjs/ui/slider

Exports from the declarations published in @askrjs/ui. Signatures reflect the published artifact.

Exports

This entrypoint publishes 15 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

Slidertype

Slider: (props: SliderProps) => JSX.Element

Renders the `slider` part of `slider`.

SLIDER_A11Y_CONTRACTtype

SLIDER_A11Y_CONTRACT: { readonly THUMB_ROLE: "slider"; readonly VALUE_NOW_ATTRIBUTE: "aria-valuenow"; readonly VALUE_MIN_ATTRIBUTE: "aria-valuemin"; readonly VALUE_MAX_ATTRIBUTE: "aria-valuemax"; readonly ORIENTATION_ATTRIBUTE: "aria-orientation"; readonly DATA_ATTRIBUTES: { readonly slot: "data-slot"; readonly disabled: "data-disabled"; readonly orientation: "data-orientation"; }; }

Slider accessibility contract.

SliderA11yContracttype

SliderA11yContract: typeof SLIDER_A11Y_CONTRACT

Type of the Slider A11y Contract object.

SliderOwnPropstype

SliderOwnProps: {
  /** Supports literal, nested, array-mapped, and `For`-rendered descendants. */
  children?: unknown;
  id?: string;
  value?: number;
  defaultValue?: number;
  onValueChange?: (value: number) => void;
  min?: number;
  max?: number;
  step?: number;
  orientation?: SliderOrientation;
  disabled?: boolean;
  name?: string;
}

Own props for Slider, before merging with native element attributes.

children
Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue
defaultValue?: number | undefined;
disabled
disabled?: boolean | undefined;
id
id?: string | undefined;
max
max?: number | undefined;
min
min?: number | undefined;
name
name?: string | undefined;
onValueChange
onValueChange?: ((value: number) => void) | undefined;
orientation
orientation?: SliderOrientation | undefined;
step
step?: number | undefined;
value
value?: number | undefined;

SliderPropstype

SliderProps: BoxProps<'div', HTMLDivElement> & SliderOwnProps

Props for Slider.

asChild
asChild?: false | undefined;
children
Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue
defaultValue?: number | undefined;
disabled
disabled?: boolean | undefined;
id
id?: string | undefined;
max
max?: number | undefined;
min
min?: number | undefined;
name
name?: string | undefined;
onValueChange
onValueChange?: ((value: number) => void) | undefined;
orientation
orientation?: SliderOrientation | undefined;
ref
ref?: Ref<HTMLDivElement>;
step
step?: number | undefined;
value
value?: number | undefined;

SliderRangetype

SliderRange: { (props: SliderRangeProps): JSX.Element; (props: SliderRangeAsChildProps): JSX.Element; }

Renders the `slider-range` part of `slider`. Supports polymorphic rendering via `asChild`.

SliderRangeAsChildPropstype

SliderRangeAsChildProps: BoxAsChildProps

Props for the `asChild` (polymorphic) rendering of Slider Range.

asChild
asChild: true;
children
children: JSXElement;
ref
ref?: Ref<Element>;

SliderRangePropstype

SliderRangeProps: BoxProps<'div', HTMLDivElement>

Props for Slider Range.

asChild
asChild?: false | undefined;
children
children?: unknown;
ref
ref?: Ref<HTMLDivElement>;

SliderThumbtype

SliderThumb: { (props: SliderThumbProps): JSX.Element; (props: SliderThumbAsChildProps): JSX.Element; }

Renders the `slider-thumb` part of `slider` with `role="slider"`. Supports polymorphic rendering via `asChild`.

SliderThumbAsChildPropstype

SliderThumbAsChildProps: BoxAsChildProps

Props for the `asChild` (polymorphic) rendering of Slider Thumb.

asChild
asChild: true;
children
children: JSXElement;
ref
ref?: Ref<Element>;

SliderThumbPropstype

SliderThumbProps: BoxProps<'div', HTMLDivElement>

Props for Slider Thumb.

asChild
asChild?: false | undefined;
children
children?: unknown;
ref
ref?: Ref<HTMLDivElement>;

SliderTracktype

SliderTrack: { (props: SliderTrackProps): JSX.Element; (props: SliderTrackAsChildProps): JSX.Element; }

Renders the `slider-track` part of `slider`. Supports polymorphic rendering via `asChild`.

SliderTrackAsChildPropstype

SliderTrackAsChildProps: BoxAsChildProps

Props for the `asChild` (polymorphic) rendering of Slider Track.

asChild
asChild: true;
children
children: JSXElement;
ref
ref?: Ref<Element>;

SliderTrackPropstype

SliderTrackProps: BoxProps<'div', HTMLDivElement>

Props for Slider Track.

asChild
asChild?: false | undefined;
children
children?: unknown;
ref
ref?: Ref<HTMLDivElement>;