Input OTP

スロットに分かれたワンタイムコードの入力です。

Code: —

インポート

import { InputOTP, InputOTPSlot } from "@pelagornis/page/components";

例

上のプレビューはこのファイルを描画したものです。src/components/ にコピーして使い始めてください。

import { useState } from "react";
import { InputOTP, InputOTPSlot, Stack, Text } from "@pelagornis/page/components";

export default function InputOTPDemo() {
  const [code, setCode] = useState("");

  return (
    <Stack gap="sizeSmall" align="center">
      <InputOTP maxLength={6} value={code} onValueChange={setCode} pattern={/\d/} aria-label="Verification code">
        {Array.from({ length: 6 }, (_, index) => (
          <InputOTPSlot key={index} index={index} />
        ))}
      </InputOTP>
      <Text variant="captionMd">Code: {code || "—"}</Text>
    </Stack>
  );
}

MDX で使う

Input OTP は React の状態を共有する複数のパーツで構成されます。MDX に書いた子要素はそれぞれ別のアイランドとして描画されるため、パーツ同士がつながりません。上の例のように .tsx ファイルで組み立て、そのファイルをインポートしてください。

---
title: Example
---

import InputOtpExample from "../../components/InputOtpExample";

<InputOtpExample client:load />

client:load はページの読み込み時にアイランドをハイドレートします。ページの下の方にあるコンテンツには client:visible を使ってください。

Markdoc で使う

Markdoc のタグは Astro コンポーネントを描画しますが、このコンポーネントにはクライアントの状態が必要です。例をハイドレートする .astro ファイルで包み、そのファイルをタグとして登録してください。

---
import InputOtpExample from "../InputOtpExample";
---

<InputOtpExample client:load />

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "input-otp-example": {
      render: component("./src/components/markdoc/InputOtpExample.astro"),
      selfClosing: true,
    },
  },
});

{% input-otp-example /%}

バリアント

各 variant prop が受け付ける値です。

Prop	値
`size`	`sm` `md` `lg`

構造

コンポーネントを構成するパーツと、それぞれが描画する data-refineui のロールです。

パーツ	ロール
`root`	input-otp
`slot`	input-otp-slot

キーボード

フォーカスがあるときにコンポーネントが処理するキーです。

キー	動作
`ArrowLeft`	previous-trigger
`ArrowRight`	next-trigger

参考

デザインのガイドとトークンの詳細は RefineUI · Input OTP を参照してください。
共通のルールは MDX で使うと Markdoc で使うを参照してください。