Skip to content
WebJs
Menu

Accessible one-time password component with copy-paste functionality.

import { html } from '@webjsdev/core';
import { inputClass } from '#components/ui/input.ts';

export default function InputOTPDemo() {
  return html`
    <ui-input-otp>
      <input id="input-otp-demo" name="otp" aria-label="One-time code" value="123456" class=${inputClass()} maxlength="6" inputmode="numeric" autocomplete="one-time-code">
      <ui-input-otp-group>
        <ui-input-otp-slot index="0"></ui-input-otp-slot>
        <ui-input-otp-slot index="1"></ui-input-otp-slot>
        <ui-input-otp-slot index="2"></ui-input-otp-slot>
        <ui-input-otp-slot index="3"></ui-input-otp-slot>
        <ui-input-otp-slot index="4"></ui-input-otp-slot>
        <ui-input-otp-slot index="5"></ui-input-otp-slot>
      </ui-input-otp-group>
    </ui-input-otp>
  `;
}
View Code

About

Input OTP is built on one real <input> that you author. Without JavaScript it is an ordinary text field the form submits. With JavaScript the element lays that same input, transparent, over the slots and draws each character in its box, so typing, pasting, SMS autofill and the mobile keyboard all still go to the real input. It uses no library.

Installation

pnpm dlx @webjsdev/ui add input-otp

Usage

import { inputClass } from '#components/ui/input.ts';
import '#components/ui/input-otp.ts';
<ui-input-otp>
  <input id="otp" name="otp" aria-label="One-time code" class=${inputClass()} maxlength="6" inputmode="numeric" autocomplete="one-time-code">
  <ui-input-otp-group>
    <ui-input-otp-slot index="0"></ui-input-otp-slot>
    <ui-input-otp-slot index="1"></ui-input-otp-slot>
    <ui-input-otp-slot index="2"></ui-input-otp-slot>
  </ui-input-otp-group>
  <ui-input-otp-separator></ui-input-otp-separator>
  <ui-input-otp-group>
    <ui-input-otp-slot index="3"></ui-input-otp-slot>
    <ui-input-otp-slot index="4"></ui-input-otp-slot>
    <ui-input-otp-slot index="5"></ui-input-otp-slot>
  </ui-input-otp-group>
</ui-input-otp>

Composition

Use the following composition to build an input OTP:

<ui-input-otp>
├── <input>
├── <ui-input-otp-group>
│   ├── <ui-input-otp-slot>
│   ├── <ui-input-otp-slot>
│   └── <ui-input-otp-slot>
├── <ui-input-otp-separator>
├── <ui-input-otp-group>
│   ├── <ui-input-otp-slot>
│   ├── <ui-input-otp-slot>
│   └── <ui-input-otp-slot>
├── <ui-input-otp-separator>
└── <ui-input-otp-group>
    ├── <ui-input-otp-slot>
    └── <ui-input-otp-slot>

Pattern

Use the input's own pattern attribute to define a custom pattern for the OTP input. A keystroke that would make the value stop matching it is refused.

<ui-input-otp>
  <input class=${inputClass()} maxlength="6" pattern="[a-zA-Z0-9]*" autocomplete="one-time-code">
  ...
</ui-input-otp>
import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { fieldClass, fieldLabelClass } from '#components/ui/field.ts';
import { inputClass } from '#components/ui/input.ts';

// input-otp's REGEXP_ONLY_DIGITS, as the input's own pattern attribute.
const REGEXP_ONLY_DIGITS = '[0-9]*';

export default function InputOTPPattern() {
  return html`
    <div role="group" data-slot="field" data-orientation="vertical" class=${cn(fieldClass(), 'w-fit')}>
      <label data-slot="field-label" for="digits-only" class=${fieldLabelClass()}>Digits Only</label>
      <ui-input-otp>
        <input id="digits-only" class=${inputClass()} maxlength="6" pattern=${REGEXP_ONLY_DIGITS} inputmode="numeric" autocomplete="one-time-code">
        <ui-input-otp-group>
          <ui-input-otp-slot index="0"></ui-input-otp-slot>
          <ui-input-otp-slot index="1"></ui-input-otp-slot>
          <ui-input-otp-slot index="2"></ui-input-otp-slot>
          <ui-input-otp-slot index="3"></ui-input-otp-slot>
          <ui-input-otp-slot index="4"></ui-input-otp-slot>
          <ui-input-otp-slot index="5"></ui-input-otp-slot>
        </ui-input-otp-group>
      </ui-input-otp>
    </div>
  `;
}
View Code

Separator

Use the <ui-input-otp-separator> element to add a separator between input groups.

import { html } from '@webjsdev/core';
import { inputClass } from '#components/ui/input.ts';

export default function InputOTPWithSeparator() {
  return html`
    <ui-input-otp>
      <input id="input-otp-separator" aria-label="One-time code" class=${inputClass()} maxlength="6" inputmode="numeric" autocomplete="one-time-code">
      <ui-input-otp-group>
        <ui-input-otp-slot index="0"></ui-input-otp-slot>
        <ui-input-otp-slot index="1"></ui-input-otp-slot>
      </ui-input-otp-group>
      <ui-input-otp-separator></ui-input-otp-separator>
      <ui-input-otp-group>
        <ui-input-otp-slot index="2"></ui-input-otp-slot>
        <ui-input-otp-slot index="3"></ui-input-otp-slot>
      </ui-input-otp-group>
      <ui-input-otp-separator></ui-input-otp-separator>
      <ui-input-otp-group>
        <ui-input-otp-slot index="4"></ui-input-otp-slot>
        <ui-input-otp-slot index="5"></ui-input-otp-slot>
      </ui-input-otp-group>
    </ui-input-otp>
  `;
}
View Code

Disabled

Use the disabled attribute on the input to disable it.

import { html } from '@webjsdev/core';
import { inputClass } from '#components/ui/input.ts';

export default function InputOTPDisabled() {
  return html`
    <ui-input-otp>
      <input aria-label="One-time code" value="123456" disabled class=${inputClass()} maxlength="6" inputmode="numeric" autocomplete="one-time-code">
      <ui-input-otp-group>
        <ui-input-otp-slot index="0"></ui-input-otp-slot>
        <ui-input-otp-slot index="1"></ui-input-otp-slot>
        <ui-input-otp-slot index="2"></ui-input-otp-slot>
      </ui-input-otp-group>
      <ui-input-otp-separator></ui-input-otp-separator>
      <ui-input-otp-group>
        <ui-input-otp-slot index="3"></ui-input-otp-slot>
        <ui-input-otp-slot index="4"></ui-input-otp-slot>
        <ui-input-otp-slot index="5"></ui-input-otp-slot>
      </ui-input-otp-group>
    </ui-input-otp>
  `;
}
View Code

Controlled

The input holds the value, so set its value attribute for the starting code and read input.value (or the element's value) for the current one. The element fires ui-value-change with { detail: { value } } on every change, and the input fires its native input event.

Enter your one-time password.
import { html } from '@webjsdev/core';
import { inputClass } from '#components/ui/input.ts';

// shadcn's demo keeps the code in React state to echo it below the slots.
// The element reports every change as a ui-value-change event carrying the
// value, so a listener on it can write the line below. Shown here at rest.
export default function InputOTPControlled() {
  const value = '';

  return html`
    <div class="space-y-2">
      <ui-input-otp>
        <input id="input-otp-controlled" aria-label="One-time password" value=${value} class=${inputClass()} maxlength="6" inputmode="numeric" autocomplete="one-time-code">
        <ui-input-otp-group>
          <ui-input-otp-slot index="0"></ui-input-otp-slot>
          <ui-input-otp-slot index="1"></ui-input-otp-slot>
          <ui-input-otp-slot index="2"></ui-input-otp-slot>
          <ui-input-otp-slot index="3"></ui-input-otp-slot>
          <ui-input-otp-slot index="4"></ui-input-otp-slot>
          <ui-input-otp-slot index="5"></ui-input-otp-slot>
        </ui-input-otp-group>
      </ui-input-otp>
      <div class="text-center text-sm">
        ${value === '' ? 'Enter your one-time password.' : html`You entered: ${value}`}
      </div>
    </div>
  `;
}
View Code

Invalid

Use aria-invalid="true" on the input to show an error state. The element passes it on to every slot.

import { html } from '@webjsdev/core';
import { inputClass } from '#components/ui/input.ts';

// aria-invalid goes on the real input; the element passes it to every slot.
export default function InputOTPInvalid() {
  return html`
    <ui-input-otp>
      <input id="input-otp-invalid" aria-label="One-time code" aria-invalid="true" value="000000" class=${inputClass()} maxlength="6" inputmode="numeric" autocomplete="one-time-code">
      <ui-input-otp-group>
        <ui-input-otp-slot index="0"></ui-input-otp-slot>
        <ui-input-otp-slot index="1"></ui-input-otp-slot>
      </ui-input-otp-group>
      <ui-input-otp-separator></ui-input-otp-separator>
      <ui-input-otp-group>
        <ui-input-otp-slot index="2"></ui-input-otp-slot>
        <ui-input-otp-slot index="3"></ui-input-otp-slot>
      </ui-input-otp-group>
      <ui-input-otp-separator></ui-input-otp-separator>
      <ui-input-otp-group>
        <ui-input-otp-slot index="4"></ui-input-otp-slot>
        <ui-input-otp-slot index="5"></ui-input-otp-slot>
      </ui-input-otp-group>
    </ui-input-otp>
  `;
}
View Code

Four Digits

A common pattern for PIN codes. This uses maxlength="4" with a digits-only pattern="[0-9]*".

import { html } from '@webjsdev/core';
import { inputClass } from '#components/ui/input.ts';

// input-otp's REGEXP_ONLY_DIGITS, as the input's own pattern attribute.
const REGEXP_ONLY_DIGITS = '[0-9]*';

export default function InputOTPFourDigits() {
  return html`
    <ui-input-otp>
      <input id="input-otp-four-digits" aria-label="PIN" class=${inputClass()} maxlength="4" pattern=${REGEXP_ONLY_DIGITS} inputmode="numeric" autocomplete="one-time-code">
      <ui-input-otp-group>
        <ui-input-otp-slot index="0"></ui-input-otp-slot>
        <ui-input-otp-slot index="1"></ui-input-otp-slot>
        <ui-input-otp-slot index="2"></ui-input-otp-slot>
        <ui-input-otp-slot index="3"></ui-input-otp-slot>
      </ui-input-otp-group>
    </ui-input-otp>
  `;
}
View Code

Alphanumeric

Use pattern="[a-zA-Z0-9]*" to accept both letters and numbers.

import { html } from '@webjsdev/core';
import { inputClass } from '#components/ui/input.ts';

// input-otp's REGEXP_ONLY_DIGITS_AND_CHARS, as the input's own pattern attribute.
const REGEXP_ONLY_DIGITS_AND_CHARS = '[a-zA-Z0-9]*';

export default function InputOTPAlphanumeric() {
  return html`
    <ui-input-otp>
      <input id="input-otp-alphanumeric" aria-label="One-time code" class=${inputClass()} maxlength="6" pattern=${REGEXP_ONLY_DIGITS_AND_CHARS} autocomplete="one-time-code">
      <ui-input-otp-group>
        <ui-input-otp-slot index="0"></ui-input-otp-slot>
        <ui-input-otp-slot index="1"></ui-input-otp-slot>
        <ui-input-otp-slot index="2"></ui-input-otp-slot>
      </ui-input-otp-group>
      <ui-input-otp-separator></ui-input-otp-separator>
      <ui-input-otp-group>
        <ui-input-otp-slot index="3"></ui-input-otp-slot>
        <ui-input-otp-slot index="4"></ui-input-otp-slot>
        <ui-input-otp-slot index="5"></ui-input-otp-slot>
      </ui-input-otp-group>
    </ui-input-otp>
  `;
}
View Code

Form

Verify your login
Enter the verification code we sent to your email address: [email protected].

I no longer have access to this email address.

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';
import {
  cardClass, cardHeaderClass, cardTitleClass, cardDescriptionClass,
  cardContentClass, cardFooterClass,
} from '#components/ui/card.ts';
import { fieldClass, fieldLabelClass, fieldDescriptionClass } from '#components/ui/field.ts';
import { inputClass } from '#components/ui/input.ts';
import { RefreshCwIcon } from '#lib/ui/lucide.ts';

// The slot hosts sit inside the group's rendered box, so the size rule
// reaches them with ** (any descendant) where shadcn writes *.
const GROUP = '**:data-[slot=input-otp-slot]:h-12 **:data-[slot=input-otp-slot]:w-11 **:data-[slot=input-otp-slot]:text-xl';

export default function InputOTPForm() {
  return html`
    <div data-slot="card" data-size="default" class=${cn(cardClass(), 'mx-auto max-w-md')}>
      <div data-slot="card-header" class=${cardHeaderClass()}>
        <div data-slot="card-title" class=${cardTitleClass()}>Verify your login</div>
        <div data-slot="card-description" class=${cardDescriptionClass()}>
          Enter the verification code we sent to your email address:${' '}
          <span class="font-medium">[email protected]</span>.
        </div>
      </div>
      <div data-slot="card-content" class=${cardContentClass()}>
        <div role="group" data-slot="field" data-orientation="vertical" class=${fieldClass()}>
          <div class="flex items-center justify-between">
            <label data-slot="field-label" for="otp-verification" class=${fieldLabelClass()}>
              Verification code
            </label>
            <button type="button" data-slot="button" data-variant="outline" data-size="xs" class=${buttonClass({ variant: 'outline', size: 'xs' })}>
              ${RefreshCwIcon()}
              Resend Code
            </button>
          </div>
          <ui-input-otp>
            <input id="otp-verification" name="otp" required class=${inputClass()} maxlength="6" inputmode="numeric" autocomplete="one-time-code">
            <ui-input-otp-group class=${GROUP}>
              <ui-input-otp-slot index="0"></ui-input-otp-slot>
              <ui-input-otp-slot index="1"></ui-input-otp-slot>
              <ui-input-otp-slot index="2"></ui-input-otp-slot>
            </ui-input-otp-group>
            <ui-input-otp-separator class="mx-2"></ui-input-otp-separator>
            <ui-input-otp-group class=${GROUP}>
              <ui-input-otp-slot index="3"></ui-input-otp-slot>
              <ui-input-otp-slot index="4"></ui-input-otp-slot>
              <ui-input-otp-slot index="5"></ui-input-otp-slot>
            </ui-input-otp-group>
          </ui-input-otp>
          <p data-slot="field-description" class=${fieldDescriptionClass()}>
            <a href="#">I no longer have access to this email address.</a>
          </p>
        </div>
      </div>
      <div data-slot="card-footer" class=${cardFooterClass()}>
        <div role="group" data-slot="field" data-orientation="vertical" class=${fieldClass()}>
          <button type="submit" data-slot="button" data-variant="default" data-size="default" class=${cn(buttonClass(), 'w-full')}>
            Verify
          </button>
          <div class="text-sm text-muted-foreground">
            Having trouble signing in?${' '}
            <a href="#" class="underline underline-offset-4 transition-colors hover:text-primary">
              Contact support
            </a>
          </div>
        </div>
      </div>
    </div>
  `;
}
View Code

RTL

To enable RTL support, see the RTL configuration guide.

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { fieldClass, fieldLabelClass } from '#components/ui/field.ts';
import { inputClass } from '#components/ui/input.ts';

const translations = {
  en: {
    dir: 'ltr',
    values: {
      verificationCode: 'Verification code',
    },
  },
  ar: {
    dir: 'rtl',
    values: {
      verificationCode: 'رمز التحقق',
    },
  },
  he: {
    dir: 'rtl',
    values: {
      verificationCode: 'קוד אימות',
    },
  },
};

export default function InputOTPRtl() {
  const lang = 'ar';
  const { dir, values: t } = translations[lang];

  return html`
    <div role="group" data-slot="field" data-orientation="vertical" dir=${dir} lang=${lang} class=${cn(fieldClass(), 'mx-auto max-w-xs')}>
      <label data-slot="field-label" for="input-otp-rtl" class=${fieldLabelClass()}>${t.verificationCode}</label>
      <ui-input-otp dir=${dir}>
        <input id="input-otp-rtl" value="123456" class=${inputClass()} maxlength="6" inputmode="numeric" autocomplete="one-time-code">
        <ui-input-otp-group>
          <ui-input-otp-slot index="0"></ui-input-otp-slot>
          <ui-input-otp-slot index="1"></ui-input-otp-slot>
          <ui-input-otp-slot index="2"></ui-input-otp-slot>
          <ui-input-otp-slot index="3"></ui-input-otp-slot>
          <ui-input-otp-slot index="4"></ui-input-otp-slot>
          <ui-input-otp-slot index="5"></ui-input-otp-slot>
        </ui-input-otp-group>
      </ui-input-otp>
    </div>
  `;
}
View Code

API Reference

The kit does not use the input-otp library. <ui-input-otp> enhances one real <input> that you author: without JavaScript the page shows an ordinary text field the form submits. With JavaScript the element lays that same input, transparent, over the slots, so typing, pasting, SMS autofill and the mobile keyboard all still go to the real input.

ui-input-otp

The root. It wraps the input and the groups, and is configured through the input's own attributes.

Input attributePurpose
maxlengthHow many characters the code has. Without it, the number of slots.
patternA keystroke that would make the value stop matching is refused.
valueThe starting code.
disabledDisables the input and dims the slots.
aria-invalid"true" shows the error state on every slot.
autocomplete="one-time-code"Lets the browser fill the code from an SMS.
inputmode="numeric"Shows the number pad on phones for a numeric code.
EventDetailWhen
ui-value-change{ value: string }The code changed.
ui-complete{ value: string }Every slot is filled.

The element also exposes value, maxLength and input (the enhanced input) as properties.

ui-input-otp-group

Groups slots into one joined row. A class written on it stays on the host.

ui-input-otp-slot

AttributeTypeDefault
indexnumber0

Draws the character at index and the blinking caret. The slot styles its own host, so a class written on it is kept, and it carries data-slot="input-otp-slot" and data-active.

ui-input-otp-separator

A dash between groups.

The slots, groups and separator are decoration hidden from assistive technology. The real input is what a screen reader meets, so give it a <label for> or an aria-label.