Yamada UIにスターをあげる

スター
Yamada UIYamada UIv1.7.2

PinInput

PinInputは、ピンコードやOTP(ワンタイムパスワード)の入力を取得するために使用されるコンポーネントです。

ソース@yamada-ui/pin-input

Props

PinInputFieldProps

invalid

説明

If true, the form control will be invalid.

タイプ

boolean

デフォルト

false

isDisabled

非推奨

説明

If true, the form control will be disabled.

非推奨

Use disabled instead.

タイプ

boolean

デフォルト

false

isInvalid

非推奨

説明

If true, the form control will be invalid.

非推奨

Use invalid instead.

タイプ

boolean

デフォルト

false

isReadOnly

非推奨

説明

If true, the form control will be readonly.

非推奨

Use readOnly instead.

タイプ

boolean

デフォルト

false

isRequired

非推奨

説明

If true, the form control will be required.

非推奨

Use required instead.

タイプ

boolean

デフォルト

false

PinInputProps

colorScheme

説明

The visual color appearance of the component.

タイプ

"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

説明

The initial value of the pin input.

タイプ

string

disabled

説明

If true, the form control will be disabled.

タイプ

boolean

デフォルト

false

errorBorderColor

説明

The border color when the input is invalid.

タイプ

"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

説明

The border color when the input is focused.

タイプ

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

invalid

説明

If true, the form control will be invalid.

タイプ

boolean

デフォルト

false

isDisabled

非推奨

説明

If true, the form control will be disabled.

非推奨

Use disabled instead.

タイプ

boolean

デフォルト

false

isInvalid

非推奨

説明

If true, the form control will be invalid.

非推奨

Use invalid instead.

タイプ

boolean

デフォルト

false

isReadOnly

非推奨

説明

If true, the form control will be readonly.

非推奨

Use readOnly instead.

タイプ

boolean

デフォルト

false

isRequired

非推奨

説明

If true, the form control will be required.

非推奨

Use required instead.

タイプ

boolean

デフォルト

false

items

説明

The number of inputs to display.

タイプ

number

デフォルト

4

manageFocus

説明

If true, focus will move automatically to the next input once filled.

タイプ

boolean

デフォルト

true

mask

説明

If true, the input's value will be masked just like type=password.

タイプ

boolean

onChange

説明

Function called on input change.

タイプ

(value: string) => void

onComplete

説明

Function called when all inputs have valid values.

タイプ

(value: string) => void

otp

説明

If true, the pin input component signals to its fields that they should.

タイプ

boolean

placeholder

説明

The placeholder for the pin input.

タイプ

string

デフォルト

'○'

readOnly

説明

If true, the form control will be readonly.

タイプ

boolean

デフォルト

false

required

説明

If true, the form control will be required.

タイプ

boolean

デフォルト

false

size

説明

The size of the PinInput.

タイプ

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

デフォルト

"md"

type

説明

The type of values the pin-input should allow.

タイプ

"number" | "alphanumeric"

デフォルト

'number'

value

説明

The value of the pin input.

タイプ

string

variant

説明

The variant of the PinInput.

タイプ

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

デフォルト

"outline"

GitHubでこのページを編集する

PasswordInputPhoneInput