Перейти до вмісту
1.6k

Ввід OTP

Поле для введення одноразового коду для двофакторної аутентифікації (2FA), підтвердження входу та екрани введення PIN-коду — поля, що підтримують вставку тексту, з необруталістичними рамками та різкими тінями.

import {
  InputOTP,
  InputOTPGroup,

Input OTP — сегментоване поле одноразового коду: візуальні слоти поверх одного нативного input, тож вставка й мобільне автозаповнення коду працюють «з коробки». Обидва варіанти бекенду обгортають ту саму бібліотеку input-otp від @guilherme_rodz — під ними немає примітиву Radix чи Base — зі слотами, оформленими за рецептом необруталізму: товсті рамки, різкі тіні та масивний шрифт.

Коли це стане в пригоді:

  • Двофакторна автентифікація — 6-значний TOTP або SMS-код після входу з паролем.
  • Підтвердження email і телефону — підтвердити володіння під час реєстрації, 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

Використовуйте проп 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Переносить фокус у поле / з нього (один tab stop)
ArrowLeft / ArrowRightПереміщує каретку між слотами
Home / EndПереходить до першого / останнього слота
Backspace / DeleteВидаляє попередній / наступний символ
Ctrl/Cmd + VВставка — код заповнює слоти, якщо відповідає pattern

Довідник API

Докладніше див. у документації input-otp.