Slider

Sliders allow users to quickly select a value within a range. They should be used when the upper and lower bounds to the range are invariable.

installyarn add @adobe/react-spectrum
version3.0.2
usageimport {Slider} from '@adobe/react-spectrum'

Example#


<Slider label="Cookies to buy" defaultValue={12} />
<Slider label="Cookies to buy" defaultValue={12} />
<Slider
  label="Cookies to buy"
  defaultValue={12}
/>

Value#


Sliders are controlled with the value prop and uncontrolled with the defaultValue prop. This value must fall between the Slider's minimum and maximum values, which default to 0 and 100 respectively.

function Example() {
  let [value, setValue] = React.useState(25);
  return (
    <Flex gap="size-150" wrap>
      <Slider label="Cookies to buy (Uncontrolled)" defaultValue={25} />
      <Slider
        label="Cookies to buy (Controlled)"
        value={value}
        onChange={setValue}
      />
    </Flex>
  );
}
function Example() {
  let [value, setValue] = React.useState(25);
  return (
    <Flex gap="size-150" wrap>
      <Slider
        label="Cookies to buy (Uncontrolled)"
        defaultValue={25}
      />
      <Slider
        label="Cookies to buy (Controlled)"
        value={value}
        onChange={setValue}
      />
    </Flex>
  );
}
function Example() {
  let [
    value,
    setValue
  ] = React.useState(25);
  return (
    <Flex
      gap="size-150"
      wrap>
      <Slider
        label="Cookies to buy (Uncontrolled)"
        defaultValue={25}
      />
      <Slider
        label="Cookies to buy (Controlled)"
        value={value}
        onChange={
          setValue
        }
      />
    </Flex>
  );
}

Alternatively, a different scale can be used by setting the minValue and maxValue props.

<Slider
  label="Cookies to buy"
  minValue={50}
  maxValue={150}
  defaultValue={100}
/>
<Slider
  label="Cookies to buy"
  minValue={50}
  maxValue={150}
  defaultValue={100}
/>
<Slider
  label="Cookies to buy"
  minValue={50}
  maxValue={150}
  defaultValue={100}
/>

The slider value can be formatted by using the formatOptions prop. formatOptions is compatible with the option parameter of Intl.NumberFormat and is applied based on the current locale.

<Slider
  label="Currency"
  formatOptions={{style: 'currency', currency: 'JPY'}}
  defaultValue={60}
/>
<Slider
  label="Currency"
  formatOptions={{style: 'currency', currency: 'JPY'}}
  defaultValue={60}
/>
<Slider
  label="Currency"
  formatOptions={{
    style: 'currency',
    currency: 'JPY'
  }}
  defaultValue={60}
/>

Labeling#


Value labels are shown above the Slider by default, but they can also be moved to the side or hidden as needed. The label text should be in sentence case.

<Flex direction="column" maxWidth="size-5000" gap="size-300">
  <Slider label="Cookies to buy" defaultValue={25} />
  <Slider label="Donuts to buy" labelPosition="side" defaultValue={25} />
  <Slider label="Pastries to buy" showValueLabel={false} defaultValue={25} />
</Flex>
<Flex
  direction="column"
  maxWidth="size-5000"
  gap="size-300">
  <Slider label="Cookies to buy" defaultValue={25} />
  <Slider
    label="Donuts to buy"
    labelPosition="side"
    defaultValue={25}
  />
  <Slider
    label="Pastries to buy"
    showValueLabel={false}
    defaultValue={25}
  />
</Flex>
<Flex
  direction="column"
  maxWidth="size-5000"
  gap="size-300">
  <Slider
    label="Cookies to buy"
    defaultValue={25}
  />
  <Slider
    label="Donuts to buy"
    labelPosition="side"
    defaultValue={25}
  />
  <Slider
    label="Pastries to buy"
    showValueLabel={
      false
    }
    defaultValue={25}
  />
</Flex>

By default, the value label is formatted as a plain number. This can be customized using the following props.

  • showValueLabel: Allows you to display or hide the value label.
  • formatOptions: Allows you to customize the format of the value.
  • getValueLabel: Allows you to provide a custom function to format the value label.
<Flex direction="column" maxWidth="size-3000" gap="size-300">
  <Slider label="Cookies to buy" showValueLabel={false} defaultValue={90} />
  <Slider
    label="Percent donus eaten"
    maxValue={1}
    step={0.001}
    formatOptions={{style: 'percent', minimumFractionDigits: 1}}
    defaultValue={0.891}
  />
  <Slider
    label="Donuts to buy"
    maxValue={60}
    getValueLabel={(donuts) => `${donuts} of 60 Donuts`}
  />
</Flex>
<Flex
  direction="column"
  maxWidth="size-3000"
  gap="size-300">
  <Slider
    label="Cookies to buy"
    showValueLabel={false}
    defaultValue={90}
  />
  <Slider
    label="Percent donus eaten"
    maxValue={1}
    step={0.001}
    formatOptions={{
      style: 'percent',
      minimumFractionDigits: 1
    }}
    defaultValue={0.891}
  />
  <Slider
    label="Donuts to buy"
    maxValue={60}
    getValueLabel={(donuts) => `${donuts} of 60 Donuts`}
  />
</Flex>
<Flex
  direction="column"
  maxWidth="size-3000"
  gap="size-300">
  <Slider
    label="Cookies to buy"
    showValueLabel={
      false
    }
    defaultValue={90}
  />
  <Slider
    label="Percent donus eaten"
    maxValue={1}
    step={0.001}
    formatOptions={{
      style: 'percent',
      minimumFractionDigits: 1
    }}
    defaultValue={
      0.891
    }
  />
  <Slider
    label="Donuts to buy"
    maxValue={60}
    getValueLabel={(
      donuts
    ) =>
      `${donuts} of 60 Donuts`
    }
  />
</Flex>

Accessibility#

Depending on the visualization being used (i.e. depending on the showValueLabel prop), a label, aria-label, or aria-labelledby prop is required.

Internationalization#

To internationalize a Slider, a localized string should be passed to the label prop, aria-label prop, or value of the associated aria-labelledby element.

For languages that are read right-to-left (e.g. Hebrew and Arabic), the layout of the slider is automatically flipped. In addition, Slider automatically uses the current locale to format the value label.

Props#


NameTypeDefaultDescription
isFilledbooleanWhether a fill color is shown between the start of the slider and the current value.
fillOffsetnumberThe offset from which to start the fill.
trackGradientstring[]The background of the track, specified as the stops for a CSS background: linear-gradient(to right/left, ...trackGradient).
formatOptionsIntl.NumberFormatOptionsThe display format of the value label.
labelPositionLabelPosition'top'The label's overall position relative to the element it is labeling.
showValueLabelbooleanWhether the value's label is displayed. True by default if there's a label, false by default if not.
getValueLabel( (value: number )) => stringA function that returns the content to display as the value's label. Overrides default formatted number.
orientationOrientation'horizontal'The orientation of the Slider.
isDisabledbooleanWhether the whole Slider is disabled.
minValuenumber0The slider's minimum value.
maxValuenumber100The slider's maximum value.
stepnumber1The slider's step value.
valuenumberThe current value (controlled).
defaultValuenumberThe default value (uncontrolled).
labelReactNodeThe content to display as the label.
Events
NameTypeDefaultDescription
onChangeEnd( (value: number )) => voidFired when the slider stops moving, due to being let go.
onChange( (value: number )) => voidHandler that is called when the value changes.
Layout
NameTypeDefaultDescription
flexstringnumberbooleanWhen used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumberWhen used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumberWhen used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumberstringWhen used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'Overrides the alignItems property of a flex or grid container. See MDN.
justifySelf'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'Specifies how the element is justified inside a flex or grid container. See MDN.
ordernumberThe layout order for the element within a flex or grid container. See MDN.
gridAreastringWhen used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstringWhen used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstringWhen used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstringWhen used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstringWhen used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstringWhen used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstringWhen used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValueThe margin for all four sides of the element. See MDN.
marginTopDimensionValueThe margin for the top side of the element. See MDN.
marginBottomDimensionValueThe margin for the bottom side of the element. See MDN.
marginStartDimensionValueThe margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValueThe margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValueThe margin for both the left and right sides of the element. See MDN.
marginYDimensionValueThe margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValueThe width of the element. See MDN.
minWidthDimensionValueThe minimum width of the element. See MDN.
maxWidthDimensionValueThe maximum width of the element. See MDN.
heightDimensionValueThe height of the element. See MDN.
minHeightDimensionValueThe minimum height of the element. See MDN.
maxHeightDimensionValueThe maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static''relative''absolute''fixed''sticky'Specifies how the element is positioned. See MDN.
topDimensionValueThe top position for the element. See MDN.
bottomDimensionValueThe bottom position for the element. See MDN.
leftDimensionValueThe left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValueThe right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValueThe logical start position for the element, depending on layout direction. See MDN.
endDimensionValueThe logical end position for the element, depending on layout direction. See MDN.
zIndexnumberThe stacking order for the element. See MDN.
isHiddenbooleanHides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
aria-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-detailsstringIdentifies the element (or elements) that provide a detailed, extended description for the object.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


Fill#

View guidelines

<Flex direction="column" gap="size-300">
  <Slider
    label="Opacity"
    maxValue={1}
    formatOptions={{style: 'percent'}}
    defaultValue={0.9}
    step={0.01}
    isFilled
  />
  <Slider
    label="Exposure"
    minValue={-5}
    maxValue={5}
    defaultValue={1.83}
    formatOptions={{signDisplay: 'always'}}
    step={0.01}
    fillOffset={0}
    isFilled
  />
</Flex>
<Flex direction="column" gap="size-300">
  <Slider
    label="Opacity"
    maxValue={1}
    formatOptions={{style: 'percent'}}
    defaultValue={0.9}
    step={0.01}
    isFilled
  />
  <Slider
    label="Exposure"
    minValue={-5}
    maxValue={5}
    defaultValue={1.83}
    formatOptions={{signDisplay: 'always'}}
    step={0.01}
    fillOffset={0}
    isFilled
  />
</Flex>
<Flex
  direction="column"
  gap="size-300">
  <Slider
    label="Opacity"
    maxValue={1}
    formatOptions={{
      style: 'percent'
    }}
    defaultValue={0.9}
    step={0.01}
    isFilled
  />
  <Slider
    label="Exposure"
    minValue={-5}
    maxValue={5}
    defaultValue={1.83}
    formatOptions={{
      signDisplay:
        'always'
    }}
    step={0.01}
    fillOffset={0}
    isFilled
  />
</Flex>

Gradient#

View guidelines

<Slider
  label="Filter density"
  trackGradient={['white', 'rgba(177,141,32,1)']}
  defaultValue={0.3}
  maxValue={1}
  step={0.01}
  formatOptions={{style: 'percent'}}
  isFilled
/>
<Slider
  label="Filter density"
  trackGradient={['white', 'rgba(177,141,32,1)']}
  defaultValue={0.3}
  maxValue={1}
  step={0.01}
  formatOptions={{style: 'percent'}}
  isFilled
/>
<Slider
  label="Filter density"
  trackGradient={[
    'white',
    'rgba(177,141,32,1)'
  ]}
  defaultValue={0.3}
  maxValue={1}
  step={0.01}
  formatOptions={{
    style: 'percent'
  }}
  isFilled
/>

Disabled#

View guidelines

<Slider label="Cookies to share" defaultValue={25} isDisabled />
<Slider
  label="Cookies to share"
  defaultValue={25}
  isDisabled
/>
<Slider
  label="Cookies to share"
  defaultValue={25}
  isDisabled
/>