このページは機械翻訳のため、誤りを含む場合があります。 英語の原文を読む

要素

OtpInput

ワンタイムコード入力は、決まった桁数の数字(SMS の認証コードや認証アプリのコード)を受け取り、セルに表示します。動作はすべて入力側が担います。セルの上に重ねた透明なネイティブのテキストフィールドが 1 つだけキーボードを受け取るため、タイピング、入力メソッド、ペースト、テンキー、システムのコード自動入力(iOS の「メッセージから」、Android の SMS 候補)はプラットフォーム標準のものになり、スクリーンリーダーからは 1 つのテキストフィールドとして見えます。入力できるのは数字だけで、length 桁までです。Backspace で末尾の 1 桁を削除でき、コードが埋まったことは onComplete で通知されます。見た目はアプリ側が決めます。OtpInput には、色、サイズ、枠線、ラベルが一切ありません。構成要素はセル、セルを分割したグループ、キャレットで、アプリがそれぞれにスタイルを指定します。

el-otp-input.tsx
el-otp-input.tsxLive
import { Clipboard, cleanup, mount, signal, Text, View } from "nsh";
import { Button, OtpInput, Switch } from "nsh/base";
import { button, buttonText, desktop, focusRing, hoverFill, Log, Panel, size, Split, ui } from "./palette";

// The parts: geometry and motion in classes, colors from the palette. The
// cell that takes the next digit gets the keyboard's focus ring (`focus:`,
// the palette's `info` ring) while the code has the focus, and the caret
// blinks in it (steady with reduced motion: the input's own). A cell that
// holds a digit, a bullet too, lifts out of its well: a card's fill under a
// firmer edge (`data-filled:`), faded in (`transition-colors`). Cells are
// 44 points on a touch screen, 36 with a pointer; a pressed or hovered
// button and the switches' rows take the palette's states.
const CODE = "246810";
const cell = desktop ? "w-9 h-11 text-lg" : "w-11 h-13 text-xl";
const cellClass = `${cell} items-center justify-center rounded-lg border border-line bg-inset font-semibold text-foreground transition-colors motion-reduce:transition-none data-filled:border-input data-filled:bg-card focus:outline-2 focus:outline-info focus:-outline-offset-2 disabled:opacity-40`;
const row = `-mx-2 flex-row-reverse items-center justify-between gap-3 rounded-lg px-2 ${desktop ? "py-1" : "py-2"} active:opacity-70`;
const track = `${desktop ? "w-9" : "w-12"} rounded-full p-0.5 transition-colors motion-reduce:transition-none`;
const thumb = desktop ? "size-4 rounded-full transition-transform motion-reduce:transition-none checked:translate-x-4" : "size-5.5 rounded-full transition-transform motion-reduce:transition-none checked:translate-x-5";

function Option(props: { label: string; checked: boolean; onChange: (next: boolean) => void }) {
  return (
    <Switch
      checked={props.checked}
      onChange={({ checked }) => props.onChange(checked)}
      class={row}
      hoverStyle={hoverFill()}
      focusStyle={focusRing()}
      trackClass={track}
      trackStyle={props.checked ? ui().accentFill : ui().inset}
      thumbClass={thumb}
      thumbStyle={props.checked ? { backgroundColor: ui().onAccent } : ui().raised}
    >
      <Text style={{ flex: 1, fontSize: size.label, color: ui().text }}>{props.label}</Text>
    </Switch>
  );
}

function Action(props: { label: string; disabled?: boolean; onPress: () => void }) {
  return (
    <Button onPress={props.onPress} disabled={props.disabled} {...button("secondary", { style: desktop ? {} : { flex: 1 } })}>
      <Text style={buttonText()}>{props.label}</Text>
    </Button>
  );
}

function App() {
  const code = signal("");
  const masked = signal(false);
  const disabled = signal(false);
  const status = signal<"typing" | "checking" | "right" | "wrong">("typing");
  const events = signal<string[]>([]);
  const log = (line: string) => events.set([line, ...events()].slice(0, 6));
  // Checking the code takes a moment, as a server's answer does.
  let check: ReturnType<typeof setTimeout> | undefined;
  cleanup(() => clearTimeout(check));
  const verify = (value: string) => {
    status.set("checking");
    clearTimeout(check);
    check = setTimeout(() => status.set(value === CODE ? "right" : "wrong"), 600);
  };
  const message = () =>
    ({
      typing: { text: `${code().length} of 6 digits`, color: ui().muted },
      checking: { text: "Checking…", color: ui().muted },
      right: { text: "Verified", color: ui().up },
      wrong: { text: "That code is not right", color: ui().down },
    })[status()];

  return (
    <View style={{ flex: 1, backgroundColor: ui().page, padding: 20, paddingTop: 24, gap: 14 }}>
      <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>otp input</Text>
      <Text style={{ color: ui().muted }}>
        {desktop ? "Click the code and type it, or paste it; Tab reaches it too" : "Tap the code to type it, or paste it"}
      </Text>

      <Split
        gap={14}
        inspector={
          <>
            <Panel title="value · masked · disabled">
              <Text style={{ fontSize: 13, color: ui().text, fontVariant: ["tabular-nums"] }}>
                {code() ? `value “${masked() ? "•".repeat(code().length) : code()}”` : "value “” (empty)"}
              </Text>
              <Option
                label="Masked"
                checked={masked()}
                onChange={(next) => {
                  masked.set(next);
                  log(next ? "masked: bullets, a secure field" : "masked off");
                }}
              />
              <Option
                label="Disabled"
                checked={disabled()}
                onChange={(next) => {
                  disabled.set(next);
                  log(next ? "disabled: no focus" : "enabled");
                }}
              />
            </Panel>
            <Log title="onChange · onComplete · onFocus · onBlur" lines={events()} minHeight={120} />
          </>
        }
      >
        <View style={{ ...ui().card, borderRadius: 16, padding: desktop ? 20 : 16, gap: 16, alignItems: "center" }}>
          <View style={{ gap: 4, alignItems: "center" }}>
            <Text style={{ fontSize: size.label, fontWeight: "600", color: ui().text }}>Enter the code</Text>
            <Text style={{ fontSize: size.detail, color: ui().muted }}>{`We sent it to •••• 4821 (it is ${CODE})`}</Text>
          </View>
          <OtpInput
            length={6}
            groups={2}
            value={code()}
            masked={masked()}
            disabled={disabled()}
            onChange={({ value: next }) => {
              code.set(next);
              status.set("typing");
              log(`onChange “${next}”`);
            }}
            onComplete={({ value }) => {
              log(`onComplete “${value}”`);
              verify(value);
            }}
            onFocus={() => log("onFocus")}
            onBlur={() => log("onBlur")}
            accessibilityLabel="Verification code, 6 digits"
            class="flex-row items-center gap-3"
            groupClass="flex-row gap-1.5"
            cellClass={cellClass}
            cellStyle={{ boxShadow: ui().inset.boxShadow }}
            caretClass="w-0.5 h-6 rounded-full"
            caretStyle={{ backgroundColor: ui().text }}
          />
          <Text style={{ fontSize: size.detail, color: message().color }}>{message().text}</Text>
          <View class={desktop ? "flex-row gap-2" : "flex-row gap-2 self-stretch"}>
            <Action
              label="Copy the code"
              onPress={() => {
                Clipboard.writeText(CODE);
                log("copied: paste it into the code");
              }}
            />
            <Action
              label="Clear"
              disabled={code() === ""}
              onPress={() => {
                code.set("");
                status.set("typing");
                log("value set to “”");
              }}
            />
          </View>
        </View>
      </Split>
    </View>
  );
}

mount(App);
use nsh_base::{OtpInputCompleteEvent, otp_input, theme};
use nsh_core::prelude::*;

fn verification(verify: impl Fn(&str) + 'static) -> impl IntoElement {
    let code = signal(SharedString::default());
    otp_input()
        .length(6)
        .groups(2)
        .value(move || Some(code.get()))
        .on_change(move |next: &SharedString| code.set(next.clone()))
        .on_complete(move |e: &OtpInputCompleteEvent| verify(&e.value))
        .accessibility_label("Verification code, 6 digits")
        .flex_row()
        .gap_3()
        .group_style(|s| s.flex_row().gap_2())
        .cell_style(|s| {
            s.w(px(40.0))
                .h(px(48.0))
                .items_center()
                .justify_center()
                .rounded(px(8.0))
                .border_1()
                .border_color(move || theme().input)
                .text_xl()
        })
        // The cell that takes the next digit, while the code has the focus,
        // and the cells that hold a digit.
        .cell_class("focus:border-ring data-filled:bg-muted")
        .caret_style(|s| s.w(px(2.0)).h(px(24.0)).bg(move || theme().foreground))
}

OtpInput は nsh/base、つまり Rust の nsh-base クレートに含まれます。Rust では、otp_input() が、プロパティごとのセッター(.length(..)、.cell_style(..))、イベントごとのリスナーメソッド(.on_complete(..))、入力自体に対する型付きスタイルメソッドを備えたインスタンスを作成します。

#コード

  • 制御コンポーネント: value を渡し、onChange で更新します。セルにはアプリが渡した value がそのまま表示されます。アプリが設定した値(誤ったコードの後でコードをクリアする場合など)は通知されません。
  • 非制御コンポーネント: defaultValue を渡す(または何も渡さない)場合、コードは onChange と onComplete から読み取ります。

ユーザーの操作はフィールドから読み取られ、キャレットは常に末尾にあります。

ユーザーの操作コード
数字を入力するコードが length より短い間は末尾に追加されます。すべて埋まっている場合は何も変わりません。
全角数字(0–9、東アジアの入力メソッドが出力するもの)を入力するASCII の数字が追加されます。
それ以外を入力する何も変わりません。フィールドが破棄します。
Backspace を押す最後の数字が削除されます。
ペーストする、またはシステムがコードを自動入力するその数字が同じ規則で追加されます。length 桁以上の数字を含むテキスト(123-456、メッセージ内のコードなど)は、コードを最初の length 桁で置き換えます。

onChange は変更のたびに新しいコードとともに通知されます。変更によって最後のセルが埋まった場合は、その後に onComplete が続くため、アプリはここでコードを検証します。

#プロパティ

プロパティRust型デフォルト説明
length.length(..)number必須コードの桁数。1 桁につき 1 セルです。
value.value(..)stringなしアプリが制御するコード(そのまま表示されます)。指定しない場合、入力が自身で保持します。
defaultValue.default_value(..)stringなしvalue が未設定のときの、初期のコード。
masked.masked(..)booleanfalse埋まったセルに数字の代わりにドットを表示し、フィールドはセキュアなものになります。スクリーンリーダーはコードを読み上げず、システムもコードを候補に出しません。
disabled.disabled(..)booleanfalseフォーカスも編集もできません。disabled: スタイルが入力とその各パーツに適用され、スクリーンリーダーは無効状態(dimmed)であると伝えます。
groups.groups(..)number1セルを分割するグループの数。できるだけ均等に分けます(6 桁を 2 グループなら 3 + 3)。最小 1、最大でセルごとに 1 つです。
accessibilityLabel.accessibility_label(..)stringなしスクリーンリーダーがフィールドについて読み上げる内容。コードの用途と桁数を伝えます。
cellClass、cellStyle.cell_class(..)、.cell_style(|s| ..)string、StyleProp<TextStyle>なし各セルのサイズ、枠線、テキスト(color、fontSize。数字はこれを継承します)。focus: と data-filled: はセルの状態をスタイルします(「パーツ」を参照)。
groupClass、groupStyle.group_class(..)、.group_style(|s| ..)string、StyleProp<ViewStyle>なしセルの各グループ(flex-row gap-2)。
caretClass、caretStyle.caret_class(..)、.caret_style(|s| ..)string、StyleProp<ViewStyle>なしキャレットの幅、高さ、色。
class、styleスタイルメソッドstring、StyleProp<ViewStyle>なし入力自体。グループを囲む行(または列)です。

#イベント

イベントRustペイロードタイミング
onChange.on_change(|value: &SharedString| ..)(e: { value: string })ユーザーがコードを変更したとき(入力、削除、ペースト、自動入力)。
onComplete.on_complete(|e: &OtpInputCompleteEvent| ..){ value }ユーザーの変更によって最後のセルが埋まったとき。onChange の後に発生します。
onFocus / onBlur.on_focus / .on_blurなし入力がキーボードフォーカスを得た / 失ったとき。

#Ref メソッド

メソッドRust説明
focus()focus()(OtpInputApi)入力を押したときと同様に、キーボードフォーカスを取得してソフトウェアキーボードを表示します。

#パーツ

パーツ配置場所スタイル指定
入力class、style
グループ入力内に、グループごとに 1 つgroupClass、groupStyle。disabled: は入力に従います
セル所属するグループ内に、数字ごとに 1 つcellClass、cellStyle。入力にフォーカスがある間、次の数字を受け取るセルに focus:、数字が入っている各セルに data-filled:、disabled: は入力に従います
数字埋まったセルセルのテキストスタイル(text-xl、font-semibold)。masked の間は •
キャレット入力にフォーカスがある間、次の数字を受け取る空のセルcaretClass、caretStyle

次の数字を受け取るセルは、最後の数字の次のセルです。コードがすべて埋まった場合は最後のセルになります。キャレットはテキストフィールドと同様に点滅します(0.5 秒表示、0.5 秒非表示で、編集のたびにしばらく点灯したままになります)。点滅は opacity によってネイティブに行われ、レイアウト上の位置は保たれます。モーションの低減が有効な場合は静止します。入力上のどこを押してもフォーカスされます。フィールドがセルの上に重なっているためです。

数字が入っているセルは、マスクの有無にかかわらず属性 data-filled を持つため、data-filled: クラスでユーザーが入力済みのセルをスタイルできます(より強い枠線や塗りなど: data-filled:border-foreground data-filled:bg-muted)。これは shadcn/ui が状態を記述する方法と同じです。cellClass に group がある場合、group-data-filled: クラスで入力済みセルの内側、つまり数字をスタイルできます。セルが変えるのはクラスだけで、内容は変えません。そのため、キーを 1 回押しても再スタイルされるのは 1 つのセルだけで、再描画は発生しません。

#アクセシビリティ

  • スクリーンリーダーには、accessibilityLabel で名前が付けられた 1 つのテキストフィールドとして見え、コードがその値になります。セルはスクリーンリーダーからは隠されます。コードの用途と桁数を伝えてください(例: 「認証コード、6 桁」)。masked の間、フィールドはセキュアなものになるため、コードは読み上げられません。
  • キーボードはプラットフォーム標準のものです。スマートフォンではテンキー、デスクトップでは任意のキーボード(入力できるのは数字のみ)と Backspace を使います。Tab キーで、他のテキストフィールドと同様に入力へ移動できます。
  • disabled の間はフォーカスを受け取らず、スクリーンリーダーは無効状態(dimmed)であると伝えます。

ラベル、ロール、通知全般については、アクセシビリティを参照してください。

#プラットフォームの注意事項

  • iOS: フィールドはコードフィールド(textContentType oneTimeCode)になるため、QuickType バーにメッセージやメールのコードが候補として表示され、テンキーが表示されます。masked フィールドは、フォーカスを失った後に再度入力するとやり直しになります。iOS のセキュアフィールドと同じ動作です。
  • Android: autofillHints smsOTPCode により、キーボードと自動入力サービスが SMS のコードを候補として提示でき、数字キーボードが表示されます。
  • macOS、Windows、Linux、Web: タイピングとペーストはフィールドに渡されます(ブラウザでは、スマートフォンの数字キーボード用に inputmode="numeric" を使用します)。セルの上には I ビームポインターが表示されます。