Leave Yamada UI a star

Star
Yamada UIYamada UIv1.7.2

HueSlider

HueSlider is a component used to allow the user to select a color hue.

Source@yamada-ui/color-picker

Props

HueSliderProps

colorScheme

Description

The visual color appearance of the component.

Type

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

defaultValue

Description

The initial value of the slider.

Type

number

disabled

Description

If true, the form control will be disabled.

Type

boolean

Default

false

focusThumbOnChange

Description

If false, the slider handle will not capture focus when value changes.

Type

boolean

Default

true

inputProps

Description

Props for slider input element.

Type

HTMLUIProps<"input">

invalid

Description

If true, the form control will be invalid.

Type

boolean

Default

false

isDisabled

Deprecated

Description

If true, the form control will be disabled.

Deprecated

Use disabled instead.

Type

boolean

Default

false

isInvalid

Deprecated

Description

If true, the form control will be invalid.

Deprecated

Use invalid instead.

Type

boolean

Default

false

isReadOnly

Deprecated

Description

If true, the form control will be readonly.

Deprecated

Use readOnly instead.

Type

boolean

Default

false

isRequired

Deprecated

Description

If true, the form control will be required.

Deprecated

Use required instead.

Type

boolean

Default

false

max

Description

The maximum allowed value of the slider. Cannot be less than min.

Type

number

min

Description

The minimum allowed value of the slider. Cannot be greater than max.

Type

number

name

Description

The name attribute of the hidden input field. This is particularly useful in forms.

Type

string

onChange

Description

Function called whenever the slider value changes.

Type

(value: number) => void

onChangeEnd

Description

Function called when the user is done selecting a new value.

Type

(value: number) => void

onChangeStart

Description

Function called when the user starts selecting a new value.

Type

(value: number) => void

overlays

Description

The overlay used for the slider.

Type

HTMLUIProps[]

readOnly

Description

If true, the form control will be readonly.

Type

boolean

Default

false

required

Description

If true, the form control will be required.

Type

boolean

Default

false

size

Description

The size of the HueSlider.

Type

"sm" | "md" | "lg"

Default

"md"

step

Description

The step in which increments or decrements have to be made.

Type

number

Default

1

thumbColor

Description

The CSS background property. Used in background of thumb element.

Type

UIValue<"border" | ({} & string) | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | "amber.950" | ... 318 more ... | Background<...>>

thumbProps

Description

Props for slider thumb element.

Type

HTMLUIProps

trackProps

Description

Props for slider track element.

Type

HTMLUIProps

value

Description

The value of the slider.

Type

number

variant

Description

The variant of the HueSlider.

Type

string

withShadow

Description

If true, the slider has an inner box-shadow.

Type

boolean

Default

true

Edit this page on GitHub

PreviousRangeSliderNextAlphaSlider