Zum Inhalt springen
1.6k

OTP-Eingabe

Einmalige Codeeingabe für 2FA, Anmeldebestätigung und PIN-Bildschirme – Felder, in die man den Code einfügen kann, mit neobrutalistischen Rahmen und harten Schatten.

import {
  InputOTP,
  InputOTPGroup,

Das Input OTP ist ein segmentiertes Feld für Einmalcodes: visuelle Slots über einem einzigen nativen Input, sodass Einfügen und das mobile Code-Autofill von Haus aus funktionieren. Beide Backend-Varianten umhüllen dieselbe input-otp-Bibliothek von @guilherme_rodz – darunter liegt weder ein Radix- noch ein Base-Primitive –, mit Slots nach dem neobrutalistischen Rezept: dicke Rahmen, harte Schatten und kräftige Typografie.

Typische Anwendungsfälle:

  • Zwei-Faktor-Authentifizierung – der sechsstellige TOTP- oder SMS-Code nach der Anmeldung mit Passwort.
  • E-Mail- und Telefonverifizierung – bestätige die Inhaberschaft bei Registrierung, Checkout oder Kontowiederherstellung.
  • PIN-Eingabe – vierstellige Codes für Bildschirmsperren oder Zahlungsbestätigungen (siehe das Beispiel „Vier Ziffern“).

Über

Input OTP basiert auf input-otp von @guilherme_rodz.

Installation

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

Installiere die folgenden Abhängigkeiten:

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

Kopiere den folgenden Code und füge ihn in dein Projekt ein.

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 }

Passe die Importpfade an deine Projektkonfiguration an.

Verwendung

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>

Komposition

Verwende die folgende Komposition, um ein InputOTP zu erstellen:

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

Pattern

Verwende die Prop pattern, um ein benutzerdefiniertes Muster für die OTP-Eingabe zu definieren.

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"

Beispiele

Trenner

Verwende die Komponente <InputOTPSeparator />, um einen Trenner zwischen Eingabegruppen hinzuzufügen.

import {
  InputOTP,
  InputOTPGroup,

Deaktiviert

Verwende die Prop disabled, um die Eingabe zu deaktivieren.

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

Kontrolliert

Verwende die Props value und onChange, um den Eingabewert zu steuern.

"use client"

import * as React from "react"

Ungültig

Verwende aria-invalid an den Slots, um einen Fehlerzustand anzuzeigen.

"use client"

import * as React from "react"

Vier Ziffern

Ein gängiges Muster für PIN-Codes. Es verwendet die Prop pattern={REGEXP_ONLY_DIGITS}.

"use client"

import { REGEXP_ONLY_DIGITS } from "input-otp"

Alphanumerisch

Verwende REGEXP_ONLY_DIGITS_AND_CHARS, um sowohl Buchstaben als auch Zahlen zu akzeptieren.

"use client"

import { REGEXP_ONLY_DIGITS_AND_CHARS } from "input-otp"

Formular

import { RefreshCwIcon } from "lucide-react"

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

RTL

Um RTL-Unterstützung in Neobrutalism zu aktivieren, siehe die RTL-Konfigurationsanleitung.

"use client"

import * as React from "react"

Barrierefreiheit

Für OTP-Felder gibt es kein WAI-ARIA-APG-Pattern, und es braucht auch keins: input-otp rendert hinter den visuellen Slots ein einziges echtes <input> mit autocomplete="one-time-code", assistive Technologien kündigen also ein einzelnes Textfeld an, und mobile Tastaturen können den eingehenden Code vorschlagen. Die Slots sind rein präsentational – beschrifte das Feld selbst (per FormLabel oder aria-label) und gib aria-invalid an die Slots weiter, um das Fehler-Styling zu aktivieren.

Die Tastaturinteraktionen folgen dem nativen Textfeldverhalten und sind in der Radix- und der Base-Variante identisch:

TasteAktion
Tab / Shift + TabBewegt den Fokus in das Feld hinein / aus ihm heraus (ein einziger Tab-Stopp)
ArrowLeft / ArrowRightBewegt den Cursor zwischen den Slots
Home / EndSpringt zum ersten / letzten Slot
Backspace / DeleteLöscht das vorherige / nächste Zeichen
Ctrl/Cmd + VEinfügen – der Code füllt die Slots, wenn er zu pattern passt

API-Referenz

Weitere Informationen findest du in der input-otp-Dokumentation.