PinInput

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

<PinInput.Root />

使い方

import { PinInput } from "@yamada-ui/react"

import { PinInput } from "@/components/ui"

import { PinInput } from "@workspaces/ui"

<PinInput.Root />

バリアントを変更する

<VStack>
  <For each={["outline", "filled", "flushed"]}>
    {(variant) => <PinInput.Root key={variant} variant={variant} />}
  </For>
</VStack>

サイズを変更する

<VStack>
  <For each={["xs", "sm", "md", "lg", "xl"]}>
    {(size) => <PinInput.Root key={size} size={size} />}
  </For>
</VStack>

カラースキームを変更する

<VStack>
  <For each={["green", "orange"]}>
    {(colorScheme) => (
      <PinInput.Root key={colorScheme} colorScheme={colorScheme} />
    )}
  </For>
</VStack>

デフォルトの値を設定する

デフォルトの値を設定する場合は、defaultValueに文字列を設定します。

<VStack>
  <For each={["1234", "123"]}>
    {(defaultValue) => (
      <PinInput.Root key={defaultValue} defaultValue={defaultValue} />
    )}
  </For>
</VStack>

プレースホルダーを変更する

プレースホルダーを変更する場合は、placeholderに文字列を設定します。

<PinInput.Root placeholder="💩" />

フィールド数を変更する

フィールド数を変更する場合は、itemsに数値を設定します。

<VStack>
  <For each={[3, 4, 5, 6]}>
    {(items) => <PinInput.Root key={items} items={items} />}
  </For>
</VStack>

タイプを変更する

デフォルトでは、数値のみ入力が可能です。英数字をサポートする場合は、typeにalphanumericを設定します。

<PinInput.Root type="alphanumeric" />

ワンタイムパスワード

ワンタイムパスワード(autocomplete="one-time-code")を有効にするには、otpをtrueに設定します。

<PinInput.Root otp />

入力された値をマスクする

入力された値をマスクする場合は、maskをtrueに設定します。

<PinInput.Root mask />

無効にする

無効にする場合は、disabledをtrueに設定します。

<PinInput.Root>
  <For each={[0, 1, 2, 3]}>
    {(index) => <PinInput.Field key={index} index={index} disabled />}
  </For>
</PinInput.Root>

読み取り専用にする

読み取り専用にする場合は、readOnlyをtrueに設定します。

<PinInput.Root>
  <For each={[0, 1, 2, 3]}>
    {(index) => <PinInput.Field key={index} index={index} readOnly />}
  </For>
</PinInput.Root>

無効な入力にする

無効な入力にする場合は、invalidをtrueに設定します。

<PinInput.Root>
  <For each={[0, 1, 2, 3]}>
    {(index) => <PinInput.Field key={index} index={index} invalid />}
  </For>
</PinInput.Root>

ボーダーの色を変更する

ボーダーの色を変更する場合は、focusBorderColorまたはerrorBorderColorに値を設定します。

<VStack>
  <PinInput.Root focusBorderColor="green.500" />
  <PinInput.Root errorBorderColor="orange.500" invalid />
</VStack>

完了のイベントをハンドルする

完了のイベントをハンドルする場合は、onCompleteを使用します。

const { page } = useLoading()

return <PinInput.Root onComplete={() => page.start({ duration: 5000 })} />

こちらのコードを使用する場合は、"use client"をファイルの上部に追加する必要があります。

フォーカス管理を無効にする

デフォルトでは、フィールドが入力されると、自動的に次のフィールドにフォーカスは移動します。また、BackSpaceキーが入力された場合は、前のフィールドにフォーカスされます。この制御を無効にする場合は、manageFocusをfalseに設定します。

<PinInput.Root manageFocus={false} />

フィールドをカスタマイズする

<PinInput.Root>
  <For each={[0, 1, 2, 3]}>
    {(index) => (
      <PinInput.Field
        key={index}
        index={index}
        _placeholder={{ color: "blue.500" }}
      />
    )}
  </For>
</PinInput.Root>

制御する

const { page } = useLoading()
const [value, onChange] = useState("")

const onComplete = () => page.start({ duration: 5000 })

return (
  <PinInput.Root value={value} onChange={onChange} onComplete={onComplete} />
)

こちらのコードを使用する場合は、"use client"をファイルの上部に追加する必要があります。

Props

PinInput.Root

Prop	デフォルト	型 / 説明
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"md"`	`"2xl" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	`"outline"`	`"filled" \| "flushed" \| "outline" \| "plain"` The variant of the component.
`align`	-	`"-moz-initial" \| "baseline" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "normal" \| "revert-layer" ...` The CSS `align-items` property.
`attached`	`false`	`boolean` If `true`, the borderRadius of button that are direct children will be altered to look flushed together.
`basis`	-	`"-moz-fit-content" \| "-moz-initial" \| "-moz-max-content" \| "-moz-min-content" \| "-webkit-auto" \| "0.5" \| "1.5" \| "1" \| "1/12" \| "1/2" ...` The CSS `flex-basis` property.
`defaultValue`	-	`string` The initial value of the pin input.
`direction`	-	`"-moz-initial" \| "column-reverse" \| "column" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "row-reverse" \| "row" \| "unset" ...` The CSS `flex-direction` property.
`disabled`	`false`	`boolean` If `true`, the field will be disabled.
`errorBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is focused.
`grow`	`false`	`boolean` If `true`, the children will grow to fill the available space.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`items`	`4`	`number` The number of inputs to display.
`justify`	-	`"-moz-initial" \| "center" \| "end" \| "flex-end" \| "flex-start" \| "inherit" \| "initial" \| "left" \| "normal" \| "revert-layer" ...` The CSS `justify-content` property.
`manageFocus`	`true`	`boolean` If `true`, focus will move automatically to the next input once filled.
`mask`	-	`boolean` If `true`, the input's value will be masked just like `type=password`.
`onChange`	-	`(value: string) => void` Function called on input change.
`onComplete`	-	`(value: string) => void` Function called when all inputs have valid values.
`orientation`	`"horizontal"`	`"horizontal" \| "vertical"` The orientation of the group.
`otp`	-	`boolean` If `true`, the pin input component signals to its fields that they should.
`placeholder`	`"◯"`	`string` The placeholder for the pin input.
`readOnly`	`false`	`boolean` If `true`, the field will be readonly.
`required`	`false`	`boolean` If `true`, the field will be required.
`shrink`	-	`"-moz-initial" \| "inherit" \| "initial" \| "revert-layer" \| "revert" \| "unset" \| number & {} ...` The CSS `flex-shrink` property.
`stacking`	-	`"first-on-top" \| "last-on-top"` The stacking order of the group.
`type`	`"number"`	`"alphanumeric" \| "number"` The type of values the pin-input should allow.
`value`	-	`string` The value of the pin input.
`wrap`	-	`"-moz-initial" \| "inherit" \| "initial" \| "nowrap" \| "revert-layer" \| "revert" \| "unset" \| "wrap-reverse" \| "wrap" ...` The CSS `flex-wrap` property.

PinInput.Field

Prop	デフォルト	型 / 説明
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	-	`"2xl" \| "lg" \| "md" \| "sm" \| "xl" \| "xs"` The size of the component.
`variant`	-	`"filled" \| "flushed" \| "outline" \| "plain"` The variant of the component.
`index`	-	`number` The index of the pin input field.
`errorBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` The border color when the input is focused.
`htmlSize`	-	`number` The native HTML `size` attribute to be passed to the `input`.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.

アクセシビリティ

Field.Rootを使用しない場合は、PinInput.Rootにaria-labelまたはaria-labelledbyを設定します。

<PinInput.Root aria-label="Please one-time password" />

<VStack gap="sm">
  <Text as="h3" id="label">
    Please one-time password
  </Text>

  <PinInput.Root aria-labelledby="label" />
</VStack>

キー	説明	状態
`Tab`	フォーカスを次の項目に移動します。	-
`ArrowRight`	フォーカスを次の項目に移動します。	-
`ArrowLeft`	フォーカスを前の項目に移動します。	-

ARIAロールと属性

コンポーネント	ロールと属性	使い方
`PinInput.Root`	`role="group"`	グループであることを示します。
`PinInput.Field`	`aria-invalid`	`invalid`が設定されている場合は`"true"`を設定します。
	`aria-disabled`	`disabled`が設定されている場合は`"true"`を設定します。
	`aria-describedby`	`PinInput.Field`が`Field.Root`内にあり、`Field.Root`に`errorMessage`または`helperMessage`、もしくは`Field.ErrorMessage`または`Field.HelperMessage`が設定されている場合は、その`id`を設定します。
	`aria-readonly`	`readOnly`が設定されている場合は`"true"`を設定します。
	`aria-required`	`required`が設定されている場合は`"true"`を設定します。