Atoms / Slider

Slider

A value on a track, or a range between two, with ticks and a written value.

import { Slider } from "@forgeron/ui";
/01 → Single
Volume40%
import { Slider } from "@forgeron/ui";
import { useState } from "react";

export default function Single() {
  const [volume, setVolume] = useState<number | readonly [number, number]>(40);
  return (
    <Slider
      label="Volume"
      showValue
      value={volume}
      onChange={setVolume}
      marks={[
        { value: 0, label: "0" },
        { value: 50, label: "50" },
        { value: 100, label: "100" },
      ]}
      formatValue={(n) => `${n}%`}
    />
  );
}
/02 → Range
Price€80 – €320
import { Slider } from "@forgeron/ui";

export default function Range() {
  return (
    <Slider
      label="Price"
      showValue
      min={0}
      max={500}
      step={10}
      minGap={1}
      defaultValue={[80, 320]}
      formatValue={(n) => `€${n}`}
      marks={[0, 100, 200, 300, 400, 500]}
    />
  );
}
API → Props
PropTypeDefaultDescription
labelstring—Names the slider; a range's thumbs read “from” and “to” for assistive technology.
value / defaultValuenumber | [number, number]—Controlled or not. An array makes it a range.
onChange(value) => void—On every change.
onChangeEnd(value) => void—Pointer released or key pressed: the moment to save.
min / max / stepnumber0 / 100 / 1The limits and the grain.
largeStepnumber—Page Up and Page Down. Default ten steps.
marks(number | { value, label? })[]—Ticks under the track.
showValue / formatValueboolean / (n) => string—The value at the end of the label row, and how it is written.
minGapnumber0Steps a thumb keeps from the next.
disabledboolean—Not editable.
classNamestring—Extra classes.