Leave Yamada UI a star

Star
Yamada UIYamada UIv1.5.1

Input

Input is a component used to obtain text input from the user.

Source@yamada-ui/input

Props

InputProps

colorScheme

Description

The visual color appearance of the component.

Type

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

errorBorderColor

Description

The border color when the input is invalid.

Type

"border" | "link" | BorderColor | "current" | "focus" | "whiteAlpha.50" | "whiteAlpha.100" | "whiteAlpha.200" | "whiteAlpha.300" | "whiteAlpha.400" | "whiteAlpha.500" | ... 319 more ... | ColorModeArray<...>

focusBorderColor

Description

The border color when the input is focused.

Type

"border" | "link" | BorderColor | "current" | "focus" | "whiteAlpha.50" | "whiteAlpha.100" | "whiteAlpha.200" | "whiteAlpha.300" | "whiteAlpha.400" | "whiteAlpha.500" | ... 319 more ... | ColorModeArray<...>

htmlSize

Description

The native HTML size attribute to be passed to the input.

Type

number

isDisabled

Description

If true, the form control will be disabled.

Type

boolean

Default

false

isInvalid

Description

If true, the form control will be invalid.

Type

boolean

Default

false

isReadOnly

Description

If true, the form control will be readonly.

Type

boolean

Default

false

isRequired

Description

If true, the form control will be required.

Type

boolean

Default

false

size

Description

The size of the Input.

Type

"xs" | "sm" | "md" | "lg"

Default

md

variant

Description

The variant of the Input.

Type

"outline" | "filled" | "flushed" | "unstyled"

Default

outline

InputGroupProps

InputAddonProps

placement

Description

The placement of the element.

Type

"left" | "right"

Default

'left'

InputElementProps

isClick

Description

If true, the element clickable.

Type

boolean

Default

false

placement

Description

The placement of the element.

Type

"left" | "right"

Default

'left'

Edit this page on GitHub

PreviousIconButtonNextNumberInput