Input OTP

One-time password input with individual digit boxes, auto-focus advance, blinking cursor, and paste support.

This component requires softui.js for interactive behavior.

Default

A 6-digit code in two groups of three.

<div class="sui-otp" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

<script>
  // Listen for completion (the event bubbles, so document works too):
  document.querySelector('.sui-otp').addEventListener('sui-otp-complete', (e) => {
    console.log('OTP entered:', e.detail.value);
  });
</script>

Four Digits

A compact 4-digit PIN input without separators.

<div class="sui-otp" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

Alphanumeric

Add data-sui-otp-pattern="alphanumeric" to accept letters and digits.

<div class="sui-otp" data-sui-otp data-sui-otp-pattern="alphanumeric">
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator sui-otp-separator-dot"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

Connected

Add sui-otp-connected for slots that share a single inset surface with no gap between them.

<!-- Connected with separator -->
<div class="sui-otp sui-otp-connected" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

<!-- Connected without separator -->
<div class="sui-otp sui-otp-connected" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

With Separator

Put sui-otp-separator (dash) or sui-otp-separator-dot between groups.

<!-- Dash separator -->
<div class="sui-otp" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

<!-- Dot separator -->
<div class="sui-otp" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator sui-otp-separator-dot"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator sui-otp-separator-dot"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

Sizes

Add sui-otp-sm or sui-otp-lg for size variants.

<!-- Small -->
<div class="sui-otp sui-otp-sm" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

<!-- Default -->
<div class="sui-otp" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

<!-- Large -->
<div class="sui-otp sui-otp-lg" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

Disabled

<div class="sui-otp" data-sui-otp data-sui-otp-disabled>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>

Error State

Add sui-otp-error to indicate an invalid code.

Invalid verification code. Please try again.
<div class="sui-otp sui-otp-error" data-sui-otp>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
  <div class="sui-otp-separator"></div>
  <div class="sui-otp-group">
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
    <div class="sui-otp-slot"></div>
  </div>
</div>
<span class="sui-hint sui-hint-error">Invalid verification code. Please try again.</span>

Reference

Attribute / Class / EventDescription
data-sui-otpTurns sui-otp into a code input: click to focus, type or paste a code, and focus moves slot to slot. The slot count sets the code length.
data-sui-otp-pattern"digits" (default) or "alphanumeric". Alphanumeric input is uppercased.
data-sui-otp-disabledRenders the slots but does not accept input.
sui-otp-completeFires on the sui-otp element when every slot is filled, with detail.value. Bubbles.
sui-otp-connectedSlots share one inset surface with no gap.
sui-otp-separatorDash between groups; add sui-otp-separator-dot for a dot.
sui-otp-sm / sui-otp-lgSmaller or larger slots.
sui-otp-errorError styling for an invalid code.

Delete this item?

This action cannot be undone. This will permanently delete the item and remove all associated data.