Przejdź do treści
1.6k

Pole OTP

Pole do wpisania kodu jednorazowego dla uwierzytelniania dwuskładnikowego (2FA), weryfikacji logowania i ekranów PIN — pola obsługujące wklejanie z ramkami w stylu neobrutalistycznym i ostrymi cieniami.

import {
  InputOTP,
  InputOTPGroup,

Input OTP to segmentowe pole na kod jednorazowy: wizualne sloty wyrenderowane nad jednym natywnym polem input, dzięki czemu wklejanie i mobilne autouzupełnianie kodów działają od ręki. Oba warianty backendu opakowują tę samą bibliotekę input-otp autorstwa @guilherme_rodz — pod spodem nie ma prymitywu Radix ani Base — ze slotami ostylowanymi zgodnie z neobrutalistyczną recepturą: grube obramowania, twarde cienie i wyrazista typografia.

Sięgnij po ten komponent, gdy:

  • Uwierzytelnianie dwuskładnikowe — sześciocyfrowy kod TOTP lub SMS po zalogowaniu hasłem.
  • Weryfikacja e-maila i telefonu — potwierdzenie własności podczas rejestracji, płatności lub odzyskiwania konta.
  • Wprowadzanie PIN-u — czterocyfrowe kody do blokad ekranu lub potwierdzania płatności (zobacz przykład Cztery cyfry).

O komponencie

Input OTP jest zbudowany na bazie input-otp autorstwa @guilherme_rodz.

Instalacja

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

Zainstaluj następujące zależności:

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

Skopiuj i wklej poniższy kod do swojego projektu.

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 }

Zaktualizuj ścieżki importu, aby pasowały do konfiguracji twojego projektu.

Użycie

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>

Kompozycja

Użyj następującej kompozycji, aby zbudować InputOTP:

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

Pattern

Użyj propa pattern, aby zdefiniować niestandardowy wzorzec dla pola wprowadzania 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"

Przykłady

Separator

Użyj komponentu <InputOTPSeparator />, aby dodać separator między grupami wprowadzania.

import {
  InputOTP,
  InputOTPGroup,

Wyłączony

Użyj propa disabled, aby wyłączyć pole wprowadzania.

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

Kontrolowany

Użyj propów value i onChange, aby kontrolować wartość pola wprowadzania.

"use client"

import * as React from "react"

Nieprawidłowy

Użyj aria-invalid na slotach, aby wyświetlić stan błędu.

"use client"

import * as React from "react"

Cztery cyfry

Powszechny wzorzec dla kodów PIN. Korzysta z propa pattern={REGEXP_ONLY_DIGITS}.

"use client"

import { REGEXP_ONLY_DIGITS } from "input-otp"

Alfanumeryczny

Użyj REGEXP_ONLY_DIGITS_AND_CHARS, aby akceptować zarówno litery, jak i cyfry.

"use client"

import { REGEXP_ONLY_DIGITS_AND_CHARS } from "input-otp"

Formularz

import { RefreshCwIcon } from "lucide-react"

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

RTL

Aby włączyć obsługę RTL w Neobrutalism, zobacz przewodnik konfiguracji RTL.

"use client"

import * as React from "react"

Dostępność

Dla pól OTP nie ma wzorca WAI-ARIA APG i żaden nie jest potrzebny: input-otp renderuje za wizualnymi slotami jedno prawdziwe pole <input> z autocomplete="one-time-code", więc technologie wspomagające ogłaszają pojedyncze pole tekstowe, a klawiatury mobilne mogą podpowiedzieć przychodzący kod. Sloty są prezentacyjne — etykietuj samo pole (FormLabel lub aria-label), a slotom przekazuj aria-invalid dla stylów błędu.

Obsługa klawiatury odpowiada natywnemu zachowaniu pola tekstowego i jest identyczna w wariantach Radix i Base:

KlawiszDziałanie
Tab / Shift + TabPrzenosi fokus do pola / poza nie (jeden przystanek tabulacji)
ArrowLeft / ArrowRightPrzesuwa karetkę między slotami
Home / EndPrzeskakuje do pierwszego / ostatniego slotu
Backspace / DeleteUsuwa poprzedni / następny znak
Ctrl/Cmd + VWkleja — kod wypełnia sloty, jeśli pasuje do pattern

Referencja API

Więcej informacji znajdziesz w dokumentacji input-otp.