Leave Yamada UI a star

Star
Yamada UIYamada UIv1.7.2

SaturationSlider

SaturationSlider is a component used to allow the user to select a color saturation.

Source@yamada-ui/color-picker

Import

import { SaturationSlider } from "@yamada-ui/react"
Copied!

Usage

Editable example

<SaturationSlider />
Copied!

Change Size

Editable example

<VStack>
  <For
    each={[
      {
        size: "sm",
        defaultValue: [120, 0.33, 0.33],
      },
      {
        size: "md",
        defaultValue: [180, 0.66, 0.66],
      },
      {
        size: "lg",
        defaultValue: [240, 1, 1],
      },
    ]}
  >
    {({ size, defaultValue }, index) => (
      <SaturationSlider key={index} size={size} defaultValue={defaultValue} />
    )}
  </For>
</VStack>
Copied!

Set Step Value

To set a step value, assign a number to step.

Editable example

const [value, onChange] = useState<Hsv>([180, 1, 1])

return (
  <VStack>
    <Text>Value: {JSON.stringify(value)}</Text>

    <SaturationSlider value={value} step={0.1} onChange={onChange} />
  </VStack>
)
Copied!

Control Externally Only

To control externally only, set focusThumbOnChange to false.

Editable example

const [value, setValue] = useState<Hsv>([180, 1, 1])
const [, s, v] = value

const onChange = (space: "s" | "v", type: "increment" | "decrement") => {
  const i = space === "s" ? 1 : 2

  setValue((prev) => {
    if (type === "increment") {
      if (prev[i] !== 1) prev[i] = Math.round((prev[i] + 0.1) * 10) / 10
    } else {
      if (prev[i] !== 0) prev[i] = Math.round((prev[i] - 0.1) * 10) / 10
    }

    return [...prev]
  })
}

return (
  <VStack>
    <Text>Value: {JSON.stringify(value)}</Text>
    <SaturationSlider value={value} step={10} focusThumbOnChange={false} />

    <Wrap gap="md">
      <VStack w="auto" gap="sm">
        <Text>Saturation</Text>

        <Wrap gap="md">
          <Button
            isDisabled={s === 0}
            onClick={() => onChange("s", "decrement")}
          >
            -0.1
          </Button>

          <Button
            isDisabled={s === 1}
            colorScheme="blue"
            onClick={() => onChange("s", "increment")}
          >
            +0.1
          </Button>
        </Wrap>
      </VStack>

      <VStack w="auto" gap="sm">
        <Text>Brightness</Text>

        <Wrap gap="md">
          <Button
            isDisabled={v === 0}
            onClick={() => onChange("v", "decrement")}
          >
            -0.1
          </Button>

          <Button
            isDisabled={v === 1}
            colorScheme="blue"
            onClick={() => onChange("v", "increment")}
          >
            +0.1
          </Button>
        </Wrap>
      </VStack>
    </Wrap>
  </VStack>
)
Copied!

Disable

To disable, set isDisabled to true.

Editable example

<VStack>
  <SaturationSlider isDisabled />

  <Fieldset
    isDisabled
    legend="Pick color"
    helperMessage="Please select your favorite color"
  >
    <SaturationSlider />
  </Fieldset>
</VStack>
Copied!

Make Read-Only

To make read-only, set isReadOnly to true.

Editable example

<VStack>
  <SaturationSlider isReadOnly />

  <Fieldset
    isReadOnly
    legend="Pick color"
    helperMessage="Please select your favorite color"
  >
    <SaturationSlider />
  </Fieldset>
</VStack>
Copied!

Handle Start and End Change Events

To handle start and end change events, use onChangeStart and onChangeEnd.

Editable example

const [value, onChange] = useState<number>([180, 1, 1])
const [startValue, onChangeStart] = useState<number>([180, 1, 1])
const [endValue, onChangeEnd] = useState<number>([180, 1, 1])

return (
  <VStack>
    <Text>
      Value: {JSON.stringify(value)}, Start Value: {JSON.stringify(startValue)},
      End Value: {JSON.stringify(endValue)}
    </Text>

    <SaturationSlider
      value={value}
      onChange={onChange}
      onChangeStart={onChangeStart}
      onChangeEnd={onChangeEnd}
    />
  </VStack>
)
Copied!

Use React Hook Form

Editable example

type Data = { saturationSlider: Hsv }

const defaultValues: Data = {
  saturationSlider: [180, 1, 1],
}

const {
  control,
  handleSubmit,
  watch,
  formState: { errors },
} = useForm<Data>({ defaultValues })

const onSubmit = (data) => console.log("submit:", data)

console.log("watch:", watch())

return (
  <VStack as="form" onSubmit={handleSubmit(onSubmit)}>
    <Fieldset
      isInvalid={!!errors.saturationSlider}
      legend="Pick color"
      errorMessage={
        errors.saturationSlider ? errors.saturationSlider.message : undefined
      }
    >
      <Controller
        name="saturationSlider"
        control={control}
        render={({ field }) => <SaturationSlider {...field} />}
      />
    </Fieldset>

    <Button type="submit" alignSelf="flex-end">
      Submit
    </Button>
  </VStack>
)
Copied!

Edit this page on GitHub

PreviousAlphaSliderNextEditable