Skip to content
Page

Input OTP

One-time code entry split into slots.

Code: —
import { InputOTP, InputOTPSlot } from "@pelagornis/page/components";

The preview above renders this file. Copy it into src/components/ to start from it.

src/components/InputOtpExample.tsx
import { useState } from "react";
import { InputOTP, InputOTPSlot, Stack, Text } from "@pelagornis/page/components";
export default function InputOTPDemo() {
const [code, setCode] = useState("");
return (
<Stack gap="sizeSmall" align="center">
<InputOTP maxLength={6} value={code} onValueChange={setCode} pattern={/\d/} aria-label="Verification code">
{Array.from({ length: 6 }, (_, index) => (
<InputOTPSlot key={index} index={index} />
))}
</InputOTP>
<Text variant="captionMd">Code: {code || "—"}</Text>
</Stack>
);
}

Input OTP is composed from parts that share React state. Children written in MDX are rendered as separate islands, so the parts can’t reach each other. Put the composition in a .tsx file, like the example above, and import that file instead.

src/content/docs/example.mdx
---
title: Example
---
import InputOtpExample from "../../components/InputOtpExample";
<InputOtpExample client:load />

client:load hydrates the island on page load. Use client:visible for content far down the page.

Markdoc tags render Astro components, and this one needs client state. Wrap the example in an .astro file that hydrates it, then register that file as a tag.

src/components/markdoc/InputOtpExample.astro
---
import InputOtpExample from "../InputOtpExample";
---
<InputOtpExample client:load />
markdoc.config.mjs
import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";
export default defineMarkdocConfig({
extends: [starlightMarkdoc(), pageMarkdoc()],
tags: {
"input-otp-example": {
render: component("./src/components/markdoc/InputOtpExample.astro"),
selfClosing: true,
},
},
});
src/content/docs/example.mdoc
{% input-otp-example /%}

Values the component accepts for each variant prop.

PropValues
sizesm md lg

Parts of the component and the data-refineui role each one renders.

PartRole
rootinput-otp
slotinput-otp-slot

Keys the component handles when it has focus.

KeyAction
ArrowLeftprevious-trigger
ArrowRightnext-trigger