元素
OtpInput
一次性驗證碼輸入元件接受固定位數的數字(短訊中的驗證碼、驗證器應用程式的驗證碼),並以格子顯示。它負責處理行為:一個原生文字欄位以透明方式覆蓋在格子上方並接收鍵盤輸入,因此輸入、輸入法、貼上、數字鍵盤,以及系統的驗證碼自動填入(iOS 的「來自訊息」、Android 的短訊建議)均由平台本身處理,而螢幕閱讀器只會找到一個文字欄位。只接受數字,最多 length 位;Backspace 會移除最後一位數字,而 onComplete 會在驗證碼填滿時通知。外觀由應用程式決定:OtpInput 本身沒有顏色、尺寸、邊框或標籤。它的組成部分是格子、將格子分隔而成的群組,以及游標,各部分均由應用程式設定樣式。
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))
}import { mount, signal } from "nsh";
import { OtpInput } from "nsh/base";
function App() {
const code = signal("");
const verify = (value: string) => console.log(`checking ${value}`);
return (
<OtpInput
length={6}
groups={2}
value={code()}
onChange={({ value }) => code.set(value)}
onComplete={({ value }) => verify(value)}
accessibilityLabel="Verification code, 6 digits"
class="flex-row gap-3"
groupClass="flex-row gap-2"
cellClass="w-10 h-12 items-center justify-center rounded-lg border border-input text-xl focus:border-ring data-filled:bg-muted"
caretClass="w-0.5 h-6 bg-foreground"
/>
);
}
mount(App);OtpInput 來自 nsh/base,即 Rust 中的 nsh-base crate。在 Rust 中,otp_input() 會建立一個實例,每個 prop 有對應的 setter(.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 |
必填 | 驗證碼的位數:每位數字一個格子。 |
value |
.value(..) |
string |
無 | 由應用程式控制的驗證碼(原樣顯示)。未設定時,輸入元件會自行保存驗證碼。 |
defaultValue |
.default_value(..) |
string |
無 | 初始的驗證碼,僅在未設定 value 時適用。 |
masked |
.masked(..) |
boolean |
false |
已填入的格子會顯示圓點而非數字,而欄位會成為安全欄位:螢幕閱讀器不會讀出驗證碼,系統也不會將其納入建議。 |
disabled |
.disabled(..) |
boolean |
false |
不能取得焦點,也不能編輯;disabled: 樣式會套用於輸入元件及其各部分,螢幕閱讀器會說明它已停用。 |
groups |
.groups(..) |
number |
1 |
格子被分成多少個群組,盡可能平均分配(六位數字分成兩組則為 3 + 3);至少一組,最多每個格子一組。 |
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 |
|
| 群組 | 輸入元件內,每組一個 | groupClass、groupStyle;disabled: 跟隨輸入元件 |
| 格子 | 所屬群組內,每位數字一個 | cellClass、cellStyle;輸入元件取得焦點時,focus: 作用於接收下一位數字的格子,data-filled: 作用於每個已有數字的格子,disabled: 跟隨輸入元件 |
| 數字 | 已填入的格子 | 格子的文字樣式(text-xl、font-semibold);• 在 masked 時套用 |
| 游標 | 接收下一位數字的空格子,且輸入元件取得焦點時 | caretClass、caretStyle |
接收下一位數字的格子,是最後一位數字之後的格子;驗證碼填滿後則是最後一個格子。游標如文字欄位的游標般閃爍(亮半秒、暗半秒,每次編輯後會短暫保持不閃),透過其不透明度以原生方式實現,同時在版面配置中保留其位置;啟用減少動態效果時則保持靜止。按下輸入元件的任何位置都會使其取得焦點:欄位覆蓋在格子上方。
已有數字的格子(無論是否遮蔽)帶有屬性 data-filled,因此 data-filled: 類別可為使用者已填入的格子設定樣式(更粗的邊框、填色:data-filled:border-foreground data-filled:bg-muted),寫法與 shadcn/ui 對其狀態的寫法相同。當 group 位於 cellClass 中時,group-data-filled: 類別可為已填入格子內的內容(即其數字)設定樣式。格子只會更改類別,絕不更改內容,因此按一個鍵只會重新設定一個格子的樣式,不會重新繪製任何內容。
#無障礙設計
- 螢幕閱讀器只會找到一個文字欄位,其名稱由
accessibilityLabel提供(說明驗證碼的用途及長度:「驗證碼,6 位數字」),其值為驗證碼;格子對螢幕閱讀器隱藏。當masked時,欄位為安全欄位,因此驗證碼不會被朗讀。 - 鍵盤由平台提供:手機上為數字鍵盤,桌面電腦上為任何鍵盤(只接受數字),以及 Backspace。Tab 可像移至任何文字欄位一樣移至輸入元件。
- 當
disabled時,它不會取得焦點,螢幕閱讀器會說明它已停用。
有關標籤、角色及播報的一般說明,請參閱 無障礙設計。
#平台備註
- iOS:欄位為驗證碼欄位(
textContentTypeoneTimeCode),因此 QuickType 列會提供來自「訊息」或「郵件」的驗證碼,並會彈出數字鍵盤。masked欄位在失去焦點後再次輸入時會重新開始,與 iOS 的安全欄位一致。 - Android:
autofillHintssmsOTPCode讓鍵盤和自動填入服務可提供短訊中的驗證碼;並會彈出數字鍵盤。 - macOS、Windows、Linux 和網頁:輸入和貼上會傳送至欄位(在瀏覽器中,使用
inputmode="numeric"以顯示手機的數字鍵盤),而指標移到格子上時會顯示 I-beam 指標。