OTP

InputsComposerBuilt

One-time password input composed of individual single-character digit fields.

Overview

Purpose

The OTP component one-time password input composed of individual single-character digit fields.within our design system. It follows our composer layer principles, ensuring consistency and reusability across applications.

When to Use

  • Use when you need collecting user input
  • Appropriate for inputs contexts
  • Follows composer component patterns

When Not to Use

  • Avoid when simpler alternatives exist
  • Don't use for display-only content
  • Consider alternatives for edge cases

Live Example

import React from 'react';
import OTP from './components/OTP';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <OTP {...props}>
        {props.children || 'Example otp content'}
      </OTP>
    </div>
  );
}
Open on CodeSandboxOpen Sandbox

Anatomy

Understanding the structure of the OTP component helps ensure proper implementation and customization.

Property Description Type
rootSlot rendered into [data-slot="otp"].Root
groupSlot rendered into [data-slot="otp-group"].Slot
fieldSlot rendered into [data-slot="otp-field"].Slot (required)

Variants & States

import React from 'react';
import OTP from './components/OTP';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <OTP {...props}>
        {props.children || 'Example otp content'}
      </OTP>
    </div>
  );
}
Open on CodeSandboxOpen Sandbox

API Reference

Props

No props extracted. Props may be inherited or use complex types.

Accessibility

Standards Compliance

This component follows WCAG 2.1 AA guidelines and includes proper ARIA attributes, keyboard navigation, and screen reader support.

Accessibility Checklist

  • ○ Keyboard navigation support
  • ○ Screen reader compatibility
  • ○ Color contrast compliance
  • ○ Focus management
  • ○ ARIA attributes
  • ○ Reduced motion support

Usage Guidelines

Do

  • Use consistent spacing and sizing
  • Follow established patterns
  • Provide clear labels and descriptions
  • Test with assistive technologies

Don't

  • Override core functionality
  • Use without proper context
  • Ignore accessibility requirements
  • Modify without design system approval

Examples

Basic Usage

Simple implementation with default props and common configurations.

import React from 'react';
import OTP from './components/OTP';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <OTP {...props}>
        {props.children || 'Example otp content'}
      </OTP>
    </div>
  );
}
Open on CodeSandboxOpen Sandbox

Advanced Usage

Complex patterns including composition, state management, and real-world scenarios.

import React from 'react';

export default function App() {
  return (
    <div style={{ 
      padding: '2rem', 
      display: 'flex',
      flexDirection: 'column',
      gap: '1.5rem'
    }}>
      <h3>OTP - Advanced Patterns</h3>
      <p>Advanced usage patterns for OTP include:</p>
      <ul>
        <li>Composition with other components</li>
        <li>Custom styling and theming</li>
        <li>Controlled vs uncontrolled patterns</li>
        <li>Form integration</li>
        <li>Accessibility enhancements</li>
      </ul>
      <p style={{ color: '#6b7280', fontStyle: 'italic' }}>
        Full advanced examples coming soon.
      </p>
    </div>
  );
}
Open on CodeSandboxOpen Sandbox

Development Tools

Use these tools to analyze the component's performance, design tokens, and accessibility during development.

Contribute

Help us improve the OTP component documentation. Found an issue or have suggestions?

Edit this pageReport an issueContribution guidelines

Related Components

Calendar

Interactive calendar grid for selecting a single date or a date range.

Inputs • composers

Checkbox

Binary or tri-state input for boolean selection. Supports indeterminate state for partial group selection.

Inputs • primitives

CheckboxGroup

Grouped options with label.

Inputs • compounds

ColorPicker

Input + palette.

Inputs • compounds

DatePicker

Input + calendar popover.

Inputs • compounds

FileInput

File picker + label.

Inputs • compounds