Slider

The Slider is used to allow users to make selections from a range of values.

Import#

import { Slider } from '@chakra-ui/react'

Usage#

<Slider.Root defaultValue={30}>
  <Slider.Control>
    <Slider.Track>
      <Slider.FilledTrack />
    </Slider.Track>
    <SliderThumb />
  </Slider.Control>
</Slider.Root>

Changing the color palette#

<Slider.Root colorPalette='pink' defaultValue={30}>
  <Slider.Control>
    <Slider.Track>
      <Slider.FilledTrack />
    </Slider.Track>
    <SliderThumb />
  </Slider.Control>
</Slider.Root>

Changing the orientation#

<Slider.Root defaultValue={30} orientation='vertical'>
  <Slider.Control minH='32'>
    <Slider.Track>
      <Slider.FilledTrack />
    </Slider.Track>
    <SliderThumb />
  </Slider.Control>
</Slider.Root>

Customizing the styles#

Slider component was designed to be composed to make it easy for you to customize its styles.

<Slider.Root defaultValue={30}>
  <Slider.Control>
    <Slider.Track bg='red.100'>
      <SliderFilledTrack bg='tomato' />
    </Slider.Track>
    <SliderThumb boxSize={6}>
      <Box color='tomato' as={MdGraphicEq} />
    </SliderThumb>
  </Slider.Control>
</Slider.Root>

Changing the step value#

Set the step prop to snap the slider to predefined sets of values.

<Slider.Root defaultValue={60} min={0} max={300} step={30}>
  <Slider.Control>
    <Slider.Track bg='red.100'>
      <SliderFilledTrack bg='tomato' />
    </Slider.Track>
    <SliderThumb boxSize={6} />
  </Slider.Control>
</Slider.Root>

Rendering the value text#

Use the Slider.ValueText component to render the value of the slider.

<Slider.Root defaultValue={30}>
  <Flex justify='space-between'>
    <Slider.Label> Price</Slider.Label>
    <Slider.ValueText />
  </Flex>
  <Slider.Control>
    <Slider.Track>
      <Slider.FilledTrack />
    </Slider.Track>
    <SliderThumb />
  </Slider.Control>
</Slider.Root>

Listening to slider changes#

Use the onChange and onChangeEnd to listen to change events on the slider.

<Slider.Root onChangeEnd={(val) => console.log(val)}>
  <Slider.Control>
    <Slider.Track>
      <Slider.FilledTrack />
    </Slider.Track>
    <SliderThumb />
  </Slider.Control>
</Slider.Root>

Configure thumb focus with `focusThumbOnChange`#

By default SliderThumb will receive focus whenever value changes. You can opt-out of this behavior by setting the value of focusThumbOnChange to false. This is normally used with a "controlled" slider value.

<Slider.Root aria-label='slider-ex-5' value={value} focusThumbOnChange={false}>
  <Slider.Control>
    <Slider.Track>
      <Slider.FilledTrack />
    </Slider.Track>
    <SliderThumb />
  </Slider.Control>
</Slider.Root>

useSlider#

The useSlider hook is exported with state and focus management logic for use in creating tailor-made slider component for your application.

Read more about the useSlider hook here.

The Slider component is a multipart component. The styling needs to be applied to each part specifically.

To learn more about styling multipart components, visit the Component Style page.

Anatomy#

A: container
B: track
C: thumb
D: filledTrack
E: mark

Theming properties#

The properties that affect the theming of the Slider component are:

size: The size of the slider. Defaults to md.
colorScheme: The color scheme of the slider. Defaults to blue.

Theming utilities#

createMultiStyleConfigHelpers: a function that returns a set of utilities for creating style configs for a multipart component (definePartsStyle and defineMultiStyleConfig).
definePartsStyle: a function used to create multipart style objects.
defineMultiStyleConfig: a function used to define the style configuration for a multipart component.

import { sliderAnatomy as parts } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'

const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(parts.keys)

Customizing the default theme#

import { sliderAnatomy as parts } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'
const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(parts.keys)
const baseStyle = definePartsStyle({
  // define the part you're going to style
  thumb: {
    bg: 'orange.400', // change the background of the thumb to orange.400
  },
  filledTrack: {
    bg: 'blue.600', // change the background of the filled track to blue.600
  },
})
export const sliderTheme = defineMultiStyleConfig({ baseStyle })

After customizing the slider theme, we can import it in our theme file and add it in the components property:

import { extendTheme } from '@chakra-ui/react'
import { sliderTheme } from './theme/components/slider.ts'
export const theme = extendTheme({
  components: { Slider: sliderTheme },
})

This is a crucial step to make sure that any changes that we make to the slider theme are applied.

Adding a custom size#

Let's assume we want to include an extra large slider size. Here's how we can do that:

import { sliderAnatomy as parts } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'
const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(parts.keys)

const sizes = {
  xl: definePartsStyle({
    container: defineStyle({
      w: "50%",
    }),
    track: defineStyle({
      h: 7,
    }),
    thumb: defineStyle({
      boxSize: 7,
    }),
  }),
};
export const sliderTheme = defineMultiStyleConfig({ sizes })
// Now we can use the new `xl` size
<Slider size="xl">...</Slider>

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Creating a custom variant#

Let's assume we want to create a custom square variant. Here's how we can do that:

import { sliderAnatomy as parts } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/react'
const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(parts.keys)

const square = definePartsStyle({
  thumb: defineStyle({
    rounded: "none",
  }),
});

export const sliderTheme = defineMultiStyleConfig({
  variants: { square },
})

// Now we can use the new `square` variant
<Slider variant="square">...</Slider>

Changing the default properties#

Let's assume we want to change the default size and variant of every slider in our app. Here's how we can do that:

import { sliderAnatomy } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers, defineStyle } from '@chakra-ui/react'

const { defineMultiStyleConfig } = createMultiStyleConfigHelpers(
  sliderAnatomy.keys,
)

export const sliderTheme = defineMultiStyleConfig({
  defaultProps: {
    size: 'xl',
    variant: 'square',
  },
})

// This saves you time, instead of manually setting the size and variant every time you use a slider:
<Slider size="xl" variant="square">...</Slider>

Showcase#

import {
  Slider,
  SliderTrack,
  SliderFilledTrack,
  SliderThumb,
  SliderMark,
  Text,
  Box,
  Flex,
  useColorMode,
  IconButton,
} from "@chakra-ui/react";
import { useState } from "react";
import { FaMoon, FaSun } from "react-icons/fa";

export default function App() {
  const { toggleColorMode, colorMode } = useColorMode();
  const [sliderValue, setSliderValue] = useState(50);

  return (
    <>
      <Flex h={"100vh"} textAlign="center" gap={5} p={8} direction="column">
        <Box display="flex" gap={3} flexDirection="column">
          <Text fontSize="lg">Default variant</Text>
          <Slider aria-label="slider-ex-1">
            <SliderTrack>
              <SliderFilledTrack />
            </SliderTrack>
            <SliderThumb />
          </Slider>
        </Box>

        <Box display="flex" gap={3} flexDirection="column">
          <Text fontSize="lg">Custom size</Text>
          <Slider aria-label="slider-ex-1" size="xl">
            <SliderTrack>
              <SliderFilledTrack />
            </SliderTrack>
            <SliderThumb />
          </Slider>
        </Box>

        <Box display="flex" gap={3} flexDirection="column">
          <Text fontSize="lg">Square variant</Text>
          <Slider aria-label="slider-ex-1" variant="square">
            <SliderTrack>
              <SliderFilledTrack />
            </SliderTrack>
            <SliderThumb />
          </Slider>
        </Box>

        <Box display="flex" gap={3} flexDirection="column">
        <Text fontSize="lg">Custom variant with markers</Text>
        <Slider aria-label="slider-ex-1" variant="colorful" onChange={(val) => setSliderValue(val)}>
          <SliderMark value={sliderValue}>
            {sliderValue}%
          </SliderMark>
          <SliderTrack>
            <SliderFilledTrack />
          </SliderTrack>
          <SliderThumb />
        </Slider>
      </Box>

        <IconButton
          aria-label="toggle theme"
          rounded="full"
          size="xs"
          position="absolute"
          bottom={4}
          left={4}
          onClick={toggleColorMode}
          icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
        />
      </Flex>
    </>
  );
}

Open Sandbox

Edit this page on GitHub

Slider

Import#

Usage#

Changing the color palette#

Changing the orientation#

Customizing the styles#

Changing the step value#

Rendering the value text#

Listening to slider changes#

Configure thumb focus with `focusThumbOnChange`#

useSlider#

Props#

Slider Props#

SliderThumb Props#

SliderFilledTrack Props#

SliderTrack Props#

Anatomy#

Theming properties#

Theming utilities#

Customizing the default theme#

Adding a custom size#

Creating a custom variant#

Changing the default properties#

Showcase#

Slider

Import#

Usage#

Changing the color palette#

Changing the orientation#

Customizing the styles#

Changing the step value#

Rendering the value text#

Listening to slider changes#

Configure thumb focus with focusThumbOnChange#

useSlider#

Props#

Slider Props#

SliderThumb Props#

SliderFilledTrack Props#

SliderTrack Props#

Anatomy#

Theming properties#

Theming utilities#

Customizing the default theme#

Adding a custom size#

Creating a custom variant#

Changing the default properties#

Showcase#

Configure thumb focus with `focusThumbOnChange`#