mirror of
https://github.com/hanzoai/shadcn.git
synced 2026-10-30 18:22:59 +00:00
zeekay
05fc512820
Upstream sync from shadcn-ui/ui (1686 commits since last merge base). Key changes: - packages/shadcn upgraded to 4.1.0 (CLI font transformers, scaffold from github, chart colors) - apps/v4 replaces apps/www as the primary docs/registry app - Font system: 25+ heading font registries, font markers utility, @supports override - Chart improvements: recharts v3 compat, radial chart fixes - templates/ updated with monorepo variants (astro, vite, react-router, start) - skills/shadcn AI skill definitions added - deprecated/ removed (auth, auth-firebase, cli, www) Preserved Hanzo-only paths: app/, pkg/, demo/, docs/, template/next/
154 lines
3.1 KiB
Plaintext
154 lines
3.1 KiB
Plaintext
---
|
|
title: Input OTP
|
|
description: Accessible one-time password component with copy-paste functionality.
|
|
base: radix
|
|
component: true
|
|
links:
|
|
doc: https://input-otp.rodz.dev
|
|
---
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-demo" />
|
|
|
|
## About
|
|
|
|
Input OTP is built on top of [input-otp](https://github.com/guilhermerodz/input-otp) by [@guilherme_rodz](https://twitter.com/guilherme_rodz).
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add input-otp
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install input-otp
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="input-otp"
|
|
title="components/ui/input-otp.tsx"
|
|
styleName="radix-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
InputOTP,
|
|
InputOTPGroup,
|
|
InputOTPSeparator,
|
|
InputOTPSlot,
|
|
} from "@/components/ui/input-otp"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<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.
|
|
|
|
```tsx showLineNumbers {1,5}
|
|
import { REGEXP_ONLY_DIGITS_AND_CHARS } from "input-otp"
|
|
|
|
;<InputOTP maxLength={6} pattern={REGEXP_ONLY_DIGITS_AND_CHARS}>
|
|
...
|
|
</InputOTP>
|
|
```
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-pattern" />
|
|
|
|
## Examples
|
|
|
|
### Separator
|
|
|
|
Use the `<InputOTPSeparator />` component to add a separator between input groups.
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-separator" />
|
|
|
|
### Disabled
|
|
|
|
Use the `disabled` prop to disable the input.
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-disabled" />
|
|
|
|
### Controlled
|
|
|
|
Use the `value` and `onChange` props to control the input value.
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-controlled" />
|
|
|
|
### Invalid
|
|
|
|
Use `aria-invalid` on the slots to show an error state.
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-invalid" />
|
|
|
|
### Four Digits
|
|
|
|
A common pattern for PIN codes. This uses the `pattern={REGEXP_ONLY_DIGITS}` prop.
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-four-digits" />
|
|
|
|
### Alphanumeric
|
|
|
|
Use `REGEXP_ONLY_DIGITS_AND_CHARS` to accept both letters and numbers.
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-alphanumeric" />
|
|
|
|
### Form
|
|
|
|
<ComponentPreview
|
|
styleName="radix-nova"
|
|
name="input-otp-form"
|
|
previewClassName="h-[30rem]"
|
|
/>
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="radix-nova" name="input-otp-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
See the [input-otp](https://input-otp.rodz.dev) documentation for more information.
|