דילוג לתוכן

קלט OTP

הזנת קוד חד-פעמי עבור אימות דו-שלבי (2FA), אימות כניסה ומסכי PIN — שדות התומכים בהדבקה עם מסגרות בסגנון ניאו-ברוטליסטי וצללים חדים.

import {
  InputOTP,
  InputOTPGroup,

ה-input OTP הוא שדה קוד חד-פעמי מקטע: חריצים ויזואליים מעל input מקורי יחיד, כך שהדבקה ומילוי אוטומטי של קוד במובייל עובדים מהקופסה. שני הווריאנטים של ה-backend עוטפים את אותה ספריית input-otp של @guilherme_rodz — אין פרימיטיב של Radix או Base מתחת — עם חריצים מעוצבים לפי המתכון הנאו-ברוטליסטי: מסגרות עבות, צללים חדים וטיפוגרפיה מודגשת.

השתמשו בו כש:

  • אימות דו-שלבי — קוד TOTP או SMS בן 6 ספרות אחרי כניסה עם סיסמה.
  • אימות אימייל וטלפון — מאשרים בעלות בהרשמה, checkout או שחזור חשבון.
  • הזנת PIN — קודים בני 4 ספרות לנעילת מסך או אישור תשלום (ראו את דוגמת Four Digits).

אודות

Input OTP בנוי על גבי input-otp מאת @guilherme_rodz.

התקנה

pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/input-otp.json
npx shadcn@latest add https://neobrutalism.com/r/base/input-otp.json
yarn dlx shadcn@latest add https://neobrutalism.com/r/base/input-otp.json
bunx --bun shadcn@latest add https://neobrutalism.com/r/base/input-otp.json

התקינו את התלויות הבאות:

pnpm add input-otp
npm install input-otp
yarn add input-otp
bun add input-otp

העתיקו והדביקו את הקוד הבא לתוך הפרויקט שלכם.

components/ui/input-otp.tsx
"use client"

import * as React from "react"
import { OTPInput, OTPInputContext } from "input-otp"
import { MinusIcon } from "lucide-react"

import { cn } from "@/lib/utils"

function InputOTP({
  className,
  containerClassName,
  ...props
}: React.ComponentProps<typeof OTPInput> & {
  containerClassName?: string
}) {
  return (
    <OTPInput
      data-slot="input-otp"
      containerClassName={cn(
        "cn-input-otp flex items-center has-disabled:opacity-50",
        containerClassName
      )}
      spellCheck={false}
      className={cn("disabled:cursor-not-allowed", className)}
      {...props}
    />
  )
}

function InputOTPGroup({ className, ...props }: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="input-otp-group"
      className={cn(
        "flex items-center rounded has-aria-invalid:border-destructive",
        className
      )}
      {...props}
    />
  )
}

function InputOTPSlot({
  index,
  className,
  ...props
}: React.ComponentProps<"div"> & {
  index: number
}) {
  const inputOTPContext = React.useContext(OTPInputContext)
  const { char, hasFakeCaret, isActive } = inputOTPContext?.slots[index] ?? {}

  return (
    <div
      data-slot="input-otp-slot"
      data-active={isActive}
      className={cn(
        "relative flex size-8 items-center justify-center border-y-2 border-r-2 bg-input text-sm shadow-sm transition-all outline-none first:rounded-l first:border-l-2 last:rounded-r aria-invalid:border-destructive data-[active=true]:z-10 data-[active=true]:outline-2 data-[active=true]:outline-primary data-[active=true]:aria-invalid:border-destructive",
        className
      )}
      {...props}
    >
      {char}
      {hasFakeCaret && (
        <div className="pointer-events-none absolute inset-0 flex items-center justify-center">
          <div className="h-4 w-px animate-caret-blink bg-foreground duration-1000" />
        </div>
      )}
    </div>
  )
}

function InputOTPSeparator({ ...props }: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="input-otp-separator"
      className="flex items-center [&_svg:not([class*='size-'])]:size-4"
      role="separator"
      {...props}
    >
      <MinusIcon />
    </div>
  )
}

export { InputOTP, InputOTPGroup, InputOTPSlot, InputOTPSeparator }

עדכנו את נתיבי הייבוא כך שיתאימו למבנה הפרויקט שלכם.

שימוש

import {
  InputOTP,
  InputOTPGroup,
  InputOTPSeparator,
  InputOTPSlot,
} from "@/components/ui/input-otp"
<InputOTP maxLength={6}>
  <InputOTPGroup>
    <InputOTPSlot index={0} />
    <InputOTPSlot index={1} />
    <InputOTPSlot index={2} />
  </InputOTPGroup>
  <InputOTPSeparator />
  <InputOTPGroup>
    <InputOTPSlot index={3} />
    <InputOTPSlot index={4} />
    <InputOTPSlot index={5} />
  </InputOTPGroup>
</InputOTP>

קומפוזיציה

השתמשו בקומפוזיציה הבאה כדי לבנות InputOTP:

InputOTP
├── InputOTPGroup
│   ├── InputOTPSlot
│   ├── InputOTPSlot
│   └── InputOTPSlot
├── InputOTPSeparator
├── InputOTPGroup
│   ├── InputOTPSlot
│   ├── InputOTPSlot
│   └── InputOTPSlot
├── InputOTPSeparator
└── InputOTPGroup
    ├── InputOTPSlot
    └── InputOTPSlot

Pattern

השתמשו ב-prop בשם pattern כדי להגדיר תבנית מותאמת אישית עבור שדה ה-OTP.

import { REGEXP_ONLY_DIGITS_AND_CHARS } from "input-otp"
 
;<InputOTP maxLength={6} pattern={REGEXP_ONLY_DIGITS_AND_CHARS}>
  ...
</InputOTP>
"use client"

import { REGEXP_ONLY_DIGITS } from "input-otp"

דוגמאות

מפריד

השתמשו ברכיב <InputOTPSeparator /> כדי להוסיף מפריד בין קבוצות הקלט.

import {
  InputOTP,
  InputOTPGroup,

מושבת

השתמשו ב-prop בשם disabled כדי להשבית את שדה הקלט.

import { Field, FieldLabel } from "@/components/ui/field"
import {
  InputOTP,

נשלט

השתמשו ב-props בשם value ו-onChange כדי לשלוט בערך שדה הקלט.

"use client"

import * as React from "react"

לא תקין

השתמשו ב-aria-invalid על המשבצות כדי להציג מצב שגיאה.

"use client"

import * as React from "react"

ארבע ספרות

תבנית נפוצה לקודי PIN. היא משתמשת ב-prop בשם pattern={REGEXP_ONLY_DIGITS}.

"use client"

import { REGEXP_ONLY_DIGITS } from "input-otp"

אלפאנומרי

השתמשו ב-REGEXP_ONLY_DIGITS_AND_CHARS כדי לקבל גם אותיות וגם ספרות.

"use client"

import { REGEXP_ONLY_DIGITS_AND_CHARS } from "input-otp"

טופס

import { RefreshCwIcon } from "lucide-react"

import { Button } from "@/components/ui/button"

RTL

כדי להפעיל RTL ב-Neobrutalism, עיינו במדריך ההגדרה של RTL.

"use client"

import * as React from "react"

נגישות

אין דפוס WAI-ARIA APG לשדות OTP, ואין צורך בו: input-otp מרנדר <input> אמיתי אחד עם autocomplete="one-time-code" מאחורי החריצים הוויזואליים, כך שטכנולוגיה מסייעת מכריזה על שדה טקסט יחיד ומקלדות מובייל יכולות להציע את הקוד הנכנס. החריצים מצגתיים — תנו לייבל לשדה עצמו (FormLabel או aria-label), והעבירו aria-invalid לחריצים לעיצוב שגיאה.

אינטראקציות מקלדת עוקבות אחרי התנהגות שדה טקסט מקורי וזהות בווריאנטים של Radix ו-Base:

מקשפעולה
Tab / Shift + Tabמעבירים מוקד אל / מתוך השדה (tab stop אחד)
ArrowLeft / ArrowRightמעבירים את הסמן בין חריצים
Home / Endקופצים לחריץ הראשון / האחרון
Backspace / Deleteמוחקים את התו הקודם / הבא
Ctrl/Cmd + Vמדביקים — הקוד ממלא את החריצים אם הוא תואם ל-pattern

תיעוד ה-API

למידע נוסף, עיינו בתיעוד של input-otp.