Native Solid 2 fork. Original documentation and designs © WorkOS; historical posts retain their original context.

One-Time Password Field

A group of single-character text inputs to handle one-time password verification.

Styling solution Source file Download runnable sandbox

import { unstable_OneTimePasswordField as OneTimePasswordField } from "@radix-solid/primitives";
import styles from "./styles.module.css";
const OneTimePasswordFieldDemo = () => <OneTimePasswordField.Root class={styles.Root}>
		<OneTimePasswordField.Input class={styles.Input} />
		<OneTimePasswordField.Input class={styles.Input} />
		<OneTimePasswordField.Input class={styles.Input} />
		<OneTimePasswordField.Input class={styles.Input} />
		<OneTimePasswordField.Input class={styles.Input} />
		<OneTimePasswordField.Input class={styles.Input} />
		<OneTimePasswordField.HiddenInput />
	</OneTimePasswordField.Root>;
export default OneTimePasswordFieldDemo;

Features

Keyboard navigation mimicking the behavior of a single input field
Overriding values on paste
Password manager autofill support
Input validation for numeric and alphanumeric values
Auto-submit on completion
Hidden input to provide a single value to form data

Anatomy

Import all parts and piece them together.

import { unstable_OneTimePasswordField as OneTimePasswordField } from "@radix-solid/primitives";
export default () => <OneTimePasswordField.Root>
		{/* one Input for each character of the value */}
		<OneTimePasswordField.Input />
		{/* single HiddenInput to store the full value */}
		<OneTimePasswordField.HiddenInput />
	</OneTimePasswordField.Root>;

API Reference

Root

Contains all the parts of a one-time password field.

Prop	Type	Default
`asChild`	`boolean`	`false`
`autoComplete`	`enum`	`one-time-code`
`autoFocus`	`boolean`	—
`value`	`string`	—
`defaultValue`	`string`	—
`onValueChange`	`function`	—
`autoSubmit`	`boolean`	`false`
`onAutoSubmit`	`function`	—
`disabled`	`boolean`	`false`
`dir`	`enum`	`"ltr"`
`orientation`	`enum`	`"vertical"`
`form`	`string`	—
`name`	`string`	—
`placeholder`	`string`	—
`readOnly`	`boolean`	`false`
`sanitizeValue`	`function`	—
`type`	`enum`	`"text"`
`validationType`	`enum`	`"numeric"`

Data attribute	Values
`[data-orientation]`	`"vertical" \| "horizontal"`

Input

Renders a text input representing a single character in the value.

Prop	Type	Default
`asChild`	`boolean`	`false`

Data attribute	Values
`[data-index]`	The index corresponding with the index of the character relative to the root field value

HiddenInput

Prop	Type	Default
`asChild`	`boolean`	`false`

Examples

Basic usage

// This will render a field with 6 inputs, for use with
// 6-character passwords. Render an Input component for
// each character of accepted password's length.
<OneTimePasswordField.Root>
	<OneTimePasswordField.Input />
	<OneTimePasswordField.Input />
	<OneTimePasswordField.Input />
	<OneTimePasswordField.Input />
	<OneTimePasswordField.Input />
	<OneTimePasswordField.Input />
	<OneTimePasswordField.HiddenInput />
</OneTimePasswordField.Root>;

The Root component accepts arbitrary children, so rendering a visually segmented list is as simple as rendering separators between inputs. We recommend hiding decorative elements from assistive tech with aria-hidden and avoid rendering other meaningful content within Root since each child element is expected to belong to the parent with the group role.

import { Separator } from "@radix-solid/primitives";
<>
<OneTimePasswordField.Root>
	<OneTimePasswordField.Input />
	<Separator.Root aria-hidden="true" />
	<OneTimePasswordField.Input />
	<Separator.Root aria-hidden="true" />
	<OneTimePasswordField.Input />
	<Separator.Root aria-hidden="true" />
	<OneTimePasswordField.Input />
	<OneTimePasswordField.HiddenInput />
</OneTimePasswordField.Root>
</>;

Auto-submit form when password is entered

Use the autoSubmit prop to submit an associated form when all inputs are filled.

import type { JSX } from "@solidjs/web";
function Verify(p: { validCode: string }) {
  const PASSWORD_LENGTH = 6;
  const handleSubmit: JSX.EventHandler<HTMLFormElement, SubmitEvent> = event => {
    event.preventDefault();
    const formData = new FormData(event.currentTarget);
    if (formData.get("otp") === p.validCode) {
      window.location.assign("/authenticated");
    } else {
      window.alert("Invalid code");
    }
  }
  return <form onSubmit={handleSubmit}>
			<OneTimePasswordField.Root name="otp" autoSubmit>
				{Array.from({ length: PASSWORD_LENGTH }, () => <OneTimePasswordField.Input />)}
				{/* HiddenInput is required for the form to have data associated with the field */}
				<OneTimePasswordField.HiddenInput />
			</OneTimePasswordField.Root>
			<button>Submit</button>
		</form>;
}

Controlled value

import { createSignal } from "solid-js";
function Verify(p: { validCode: string }) {
  const [value, setValue] = createSignal("");
  const PASSWORD_LENGTH = 6;
  function handleSubmit() {
    if (value() === p.validCode) {
      window.location.assign("/authenticated");
    } else {
      window.alert("Invalid code");
    }
  }
  return <OneTimePasswordField.Root autoSubmit value={value()} onAutoSubmit={handleSubmit} onValueChange={setValue}>
			{Array.from({ length: PASSWORD_LENGTH }, () => <OneTimePasswordField.Input />)}
		</OneTimePasswordField.Root>;
}

Accessibility

At the time of writing, there is no singular established pattern in WCAG guidelines for implementing one-time password fields as separate inputs. The behavior aims to get as close as possible to having the field act as a single input, with a few exceptions to match user expectations based on our initial research, testing, and gathering feedback.

This component is implemented as input elements within a container with a role of group to indicate that child inputs are related. Inputs can be navigated and focused using direction keys, and typing input will move focus to the next input until the last input is reached.

Pasting a value into the field will replace the contents of all inputs, regardless of the currently focused input. Based on our research this seems to align with most user expectations, where values are often pasted from password-managers or an email.

Keyboard Interactions

Key	Description
`Enter`	Attempts to submit an associated `form` if one is found
`Tab`	Moves focus to the next focusable element outside of the `Root`
`Shift + Tab`	Moves focus to the previous focusable element outside of the `Root`
`ArrowDown`	Moves focus to the next `Input` when `orientation` is `vertical`.
`ArrowUp`	Moves focus to the previous `Input` when `orientation` is `vertical`.
`ArrowRight`	Moves focus to the next `Input` when `orientation` is `horizontal`.
`ArrowLeft`	Moves focus to the previous `Input` when `orientation` is `horizontal`.
`Home`	Moves focus to the first `Input`.
`End`	Moves focus to the last `Input`.
`Delete`	Removes the character in the currently focused `Input` and shifts later values back
`Backspace`	Removes the character in the currently focused `Input` and moves focus to the previous `Input`
`Command + Backspace`	Clears the value of all `Input` elements