Перейти к содержимому
1.6k

Ввод OTP

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

import {
  InputOTP,
  InputOTPGroup,

Input OTP — сегментированное поле одноразового кода: визуальные слоты поверх одного нативного input, поэтому вставка и mobile autofill кода работают из коробки. Обе backend-вариации оборачивают одну и ту же библиотеку 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" за визуальными слотами, поэтому ассистивные технологии объявляют одно текстовое поле, а мобильные клавиатуры могут подсказать входящий код. Слоты презентационные — labelите само поле (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.