跳到内容

OTP 输入

用于双因素认证(2FA)、登录验证和PIN输入界面的单次代码输入框——支持粘贴的输入框,配有新粗野主义风格的边框和硬阴影。

import {
  InputOTP,
  InputOTPGroup,

OTP 输入是分段式一次性验证码字段:视觉上是多个槽位,底下仍是单个原生输入,因此粘贴与手机验证码自动填充开箱即用。两个后端变体都包装同一套由 @guilherme_rodz 提供的 input-otp 库——底下没有 Radix 或 Base 基元——槽位按新粗野主义配方处理:粗边框、硬阴影、加粗字体。

适合以下场景:

  • 双因素认证——密码登录后的 6 位 TOTP 或短信验证码。
  • 邮箱与手机验证——注册、结算或找回账户时确认归属。
  • PIN 输入——锁屏或支付确认用的 4 位码(见「四位数字」示例)。

概述

Input OTP 构建于 @guilherme_rodz 打造的 input-otp 之上。

安装

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,

受控

使用 valueonChange 属性来控制输入值。

"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

若要在 Neobrutalism 中启用 RTL 支持,请参阅 RTL 配置指南

"use client"

import * as React from "react"

无障碍

OTP 字段没有 WAI-ARIA APG 模式,也不需要:input-otp 在视觉槽位背后渲染一个带 autocomplete="one-time-code" 的真实 <input>,因此辅助技术会播报为单个文本字段,移动键盘也能建议刚收到的验证码。槽位只是表现层——请给字段本身加标签(FormLabelaria-label),并通过 aria-invalid 传给槽位以驱动错误样式。

键盘交互遵循原生文本字段行为,在 Radix 与 Base 变体中一致:

按键操作
Tab / Shift + Tab把焦点移入 / 移出字段(仅一个 Tab 停靠点)
ArrowLeft / ArrowRight在槽位之间移动插入符
Home / End跳到第一个 / 最后一个槽位
Backspace / Delete删除前一个 / 后一个字符
Ctrl/Cmd + V粘贴——若匹配 pattern,验证码会填入各槽位

API 参考

更多信息请参阅 input-otp 文档。