الانتقال إلى المحتوى

إدخال OTP

إدخال الرمز لمرة واحدة لأغراض المصادقة الثنائية (2FA) والتحقق من تسجيل الدخول وشاشات رقم التعريف الشخصي (PIN) — حقول تدعم اللصق ذات حدود على الطراز «النيوبروتالستي» وظلال حادة.

import {
  InputOTP,
  InputOTPGroup,

حقل إدخال OTP هو حقل رمز لمرة واحدة مقسم إلى أجزاء: فتحات مرئية معروضة فوق حقل إدخال أصلي واحد، لذا تعمل ميزة اللصق والتعبئة التلقائية للرموز على الأجهزة المحمولة بشكل تلقائي. يستخدم كلا النوعين من الخلفية نفس مكتبة input-otp من @guilherme_rodz — ولا توجد أي عناصر أساسية من Radix أو Base في الخلفية — مع فتحات مصممة وفقًا لأسلوب «النيوبروتالية»: حدود سميكة، وظلال حادة، وخط عريض.

استخدمه عندما:

  • المصادقة الثنائية — رمز TOTP المكون من 6 أرقام أو رمز SMS بعد تسجيل الدخول بكلمة المرور.
  • التحقق عبر البريد الإلكتروني والهاتف — تأكيد الملكية أثناء التسجيل أو إتمام عملية الدفع أو استعادة الحساب.
  • إدخال رقم التعريف الشخصي (PIN) — رموز مكونة من 4 أرقام لقفل الشاشة أو تأكيد الدفع (انظر مثال «الأرقام الأربعة»).

حول

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

استخدم الخاصية 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,

معطّل

استخدم الخاصية disabled لتعطيل حقل الإدخال.

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

مُتحكَّم به

استخدم الخاصيتين value وonChange للتحكم في قيمة حقل الإدخال.

"use client"

import * as React from "react"

غير صالح

استخدم aria-invalid على الخانات لإظهار حالة خطأ.

"use client"

import * as React from "react"

أربعة أرقام

نمط شائع لرموز PIN. يستخدم هذا الخاصية 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نقل التركيز إلى الحقل / إخراجه منه (نقطة توقف واحدة)
ArrowLeft / ArrowRightنقل علامة الإدخال بين الخانات
Home / Endالانتقال إلى الخانة الأولى / الأخيرة
Backspace / Deleteحذف الحرف السابق / التالي
Ctrl/Cmd + Vلصق — يملأ الكود الخانات إذا تطابق مع pattern

مرجع API

لمزيد من المعلومات، راجع وثائق input-otp.