Input OTP

import {
  InputOTP,
  InputOTPGroup,

About

Input OTP is built on top of input-otp by @guilherme_rodz.

Installation

pnpmnpmyarnbun
pnpm dlx shadcn@latest add input-otp
Copy

Usage

Copyimport {
  InputOTP,
  InputOTPGroup,
  InputOTPSeparator,
  InputOTPSlot,
} from "@/components/ui/input-otp"

Copy<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>

Pattern

Use the pattern prop to define a custom pattern for the OTP input.

Copyimport { 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"

Examples

Separator

Use the <InputOTPSeparator /> component to add a separator between input groups.

import {
  InputOTP,
  InputOTPGroup,

Disabled

Use the disabled prop to disable the input.

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

Controlled

Use the value and onChange props to control the input value.

"use client"

import * as React from "react"

Invalid

Use aria-invalid on the slots to show an error state.

"use client"

import * as React from "react"

Four Digits

A common pattern for PIN codes. This uses the pattern={REGEXP_ONLY_DIGITS} prop.

"use client"

import { REGEXP_ONLY_DIGITS } from "input-otp"

Alphanumeric

Use REGEXP_ONLY_DIGITS_AND_CHARS to accept both letters and numbers.

"use client"

import { REGEXP_ONLY_DIGITS_AND_CHARS } from "input-otp"

Form

import { RefreshCwIcon } from "lucide-react"

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

RTL

To enable RTL support in StyleDriven UI, see the RTL configuration guide.

"use client"

import * as React from "react"

API Reference

See the input-otp documentation for more information.