Otp Field

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add otp-field

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update otp-field

Preview

import { Box } from "@registry/components/ui/box"
import { OTPField, OTPFieldInput } from "@registry/components/ui/otp-field"

const OTP_LENGTH = 6

Usage

Place OTPFieldInput cells inside OTPField and use OTPFieldSeparator to split groups.

Set length to the code length and provide a label. Use onValueComplete to react when all cells are filled; validate the code on the server.

Import from the local file installed by the CLI.

"use client"

import { OTPField, OTPFieldInput } from "@/components/ui/otp-field"

export function Preview() {
  return (
    <fieldset>
      <legend>Verification code</legend>
      <OTPField length={6}>
        <OTPFieldInput aria-label="Digit 1 of 6" />
        <OTPFieldInput aria-label="Digit 2 of 6" />
        <OTPFieldInput aria-label="Digit 3 of 6" />
        <OTPFieldInput aria-label="Digit 4 of 6" />
        <OTPFieldInput aria-label="Digit 5 of 6" />
        <OTPFieldInput aria-label="Digit 6 of 6" />
      </OTPField>
    </fieldset>
  )
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.