Skip to content
Components
@app-studio/components

OTP Input

A component to securely input one-time passwords or verification codes digit by digit.

View component source

Import

ts
import { OTPInput } from '@app-studio/components';

New to the library? Complete installation and provider setup first.

Interactive examples

Try the component, then open Code to copy the complete example.

INTERACTIVE EXAMPLE

Loading preview…

Props

Required props are marked below. A dash indicates an unspecified default. Design system configuration can override implementation defaults.

Scroll horizontally to see every column.

OTPInput
PropTypeDefaultDescription
idstring—See the type and source declaration for this property.Source
erroranyfalseError state — usually a string for the error message, or a boolean toggle.Source
helperTextstring—Helper text rendered below the input (hint / error / explanation).Source
namestring—Field name used by forms and Formik bindings.Source
labelstring—Visible label rendered alongside the input. Form-library wrappers (Switch, TextField, Checkbox, …) consume this. Not a native HTML attribute on <input>, but conventionally part of the form-control prop surface.Source
lengthnumber6See the type and source declaration for this property.Source
placeholderstring''Hint displayed while the field is empty.Source
isReadOnlybooleanfalseKeeps the value visible without allowing edits.Source
isDisabledbooleanfalseDisables user interaction.Source
isAutoFocusbooleanfalseSee the type and source declaration for this property.Source
typeOTPInputType
"number""text""password"
'text'See the type and source declaration for this property.Source
onComplete((value: string) => void)—Called when the input is complete.Source
onChange((value: string) => void)—Called with the new field value. Check the signature for the exact payload.Source
onChangeText((value: string) => void)—See the type and source declaration for this property.Source
onBlur((event: any) => void)—See the type and source declaration for this property.Source
onKeyPress((e: React.KeyboardEvent<HTMLInputElement>) => void)—See the type and source declaration for this property.Source
onKeyDown((e: React.KeyboardEvent<HTMLInputElement>) => void)—See the type and source declaration for this property.Source
onClick(() => void)—Called when the user activates the component.Source
onFocus(() => void)—See the type and source declaration for this property.Source
patternstring | RegExp—See the type and source declaration for this property.Source
pasteTransformer((pasted: string) => string)—See the type and source declaration for this property.Source
stepValuesnumber[]—See the type and source declaration for this property.Source
sizeSize
"sm""md""lg""xs""xl"
'md'Size preset for the component.Source
shadowViewProps | Shadow | Elevation—Shadow or elevation styling.Source
shapeShape
"square""rounded""pill""default"
'rounded'Shape preset for the component.Source
variantVariant
"outline""default""none"
'outline'Visual treatment of the component.Source
gapnumber8This feature is well established and works across many devices and browser versions. It’s been available across browsers since October 2017. **Syntax**: `<'row-gap'> <'column-gap'>?` | Chrome | Firefox | Safari | Edge | IE | | :----: | :-----: | :------: | :----: | :-: | | **57** | **52** | **10.1** | **16** | No |Source
viewsOTPInputStyles{}Style overrides for the named internal parts.Source
secureTextEntryboolean—See the type and source declaration for this property.Source
Common inherited styling props (6)

Scroll horizontally to see every column.

OTPInput inherited
PropTypeDefaultDescription
mediaRecord<string, CssProps>—See the type and source declaration for this property.
askeyof JSX.IntrinsicElements
"symbol""object""slot""style""title""pattern""form""animate""clipPath""filter""marker""mask""a""abbr""address""area""article""aside""audio""b""base""bdi""bdo""big""blockquote""body""br""button""canvas""caption""center""cite""code""col""colgroup""data""datalist""dd""del""details""dfn""dialog""div""dl""dt""em""embed""fieldset""figcaption""figure""footer""h1""h2""h3""h4""h5""h6""head""header""hgroup""hr""html""i""iframe""img""input""ins""kbd""keygen""label""legend""li""link""main""map""mark""menu""menuitem""meta""meter""nav""noindex""noscript""ol""optgroup""option""output""p""param""picture""pre""progress""q""rp""rt""ruby""s""samp""search""script""section""select""small""source""span""strong""sub""summary""sup""table""template""tbody""td""textarea""tfoot""th""thead""time""tr""track""u""ul""var""video""wbr""webview""svg""animateMotion""animateTransform""circle""defs""desc""ellipse""feBlend""feColorMatrix""feComponentTransfer""feComposite""feConvolveMatrix""feDiffuseLighting""feDisplacementMap""feDistantLight""feDropShadow""feFlood""feFuncA""feFuncB""feFuncG""feFuncR""feGaussianBlur""feImage""feMerge""feMergeNode""feMorphology""feOffset""fePointLight""feSpecularLighting""feSpotLight""feTile""feTurbulence""foreignObject""g""image""line""linearGradient""metadata""mpath""path""polygon""polyline""radialGradient""rect""set""stop""switch""text""textPath""tspan""use""view"
—See the type and source declaration for this property.
themeMode"light" | "dark"
"light""dark"
—See the type and source declaration for this property.
_hoverstring | CssProps—See the type and source declaration for this property.
_activestring | CssProps—See the type and source declaration for this property.
_focusstring | CssProps—See the type and source declaration for this property.

For shared layout, color, and responsive properties, read Styling & composition and Responsive layouts. Additional native element attributes depend on the target platform.

Usage guidance

  • Give controls a visible label or an accessible name, and verify keyboard interaction. See Accessibility.
  • For controlled inputs, update the value from the callback shown in the props table. Keep application state in your component or form library.
  • These previews run in the browser. Check React Native setup for platform requirements and differences.
Browse documentation source