Input OTP

About#

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

Installation#

pnpm add @ag/ui

Usage#

import {
  InputOTP,
  InputOTPGroup,
  InputOTPSeparator,
  InputOTPSlot,
} from "@ag/ui"

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

Composition#

Use the following composition to build an InputOTP:

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

Pattern#

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

import { REGEXP_ONLY_DIGITS_AND_CHARS } from "input-otp"

;<InputOTP maxLength={6} pattern={REGEXP_ONLY_DIGITS_AND_CHARS}>
  ...
</InputOTP>

Examples#

Separator#

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

Disabled#

Use the disabled prop to disable the input.

Controlled#

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

Invalid#

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

Four Digits#

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

Alphanumeric#

Use REGEXP_ONLY_DIGITS_AND_CHARS to accept both letters and numbers.

Form#

RTL#

To enable RTL support in shadcn/ui, see the RTL configuration guide.

API Reference#

See the input-otp documentation for more information.