Leave Yamada UI a star

Star
Yamada UIYamada UIv1.7.2

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

"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"

disabled

Description

If true, the form control will be disabled.

Type

boolean

Default

false

errorBorderColor

Description

The border color when the input is invalid.

Type

"border" | BorderColor | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 320 more ... | [...]

focusBorderColor

Description

The border color when the input is focused.

Type

"border" | BorderColor | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 320 more ... | [...]

htmlSize

Description

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

Type

number

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

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 Input.

Type

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

Default

"md"

variant

Description

The variant of the Input.

Type

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

Default

"outline"

InputAddonProps

placement

Description

The placement of the element.

Type

"left" | "right"

Default

'left'

InputElementProps

clickable

Description

If true, the element clickable.

Type

boolean

Default

false

isClick

Deprecated

Description

If true, the element clickable.

Deprecated

Use clickable instead.

Type

boolean

Default

false

isClickable

Deprecated

Description

If true, the element clickable.

Deprecated

Use clickable instead.

Type

boolean

Default

false

placement

Description

The placement of the element.

Type

"left" | "right"

Default

'left'

InputGroupProps

Edit this page on GitHub

PreviousIconButtonNextNumberInput