Skip to main content

OTP

Ant Design

The OTP component is Ant Design's one-time code input. It shows one box per character for entering a verification or sign-in code.

Properties​

Property
Description
Expected Value
LabelText shown with the code boxes.Text. Default: Verification code
ExtraHelp text shown under the field. A validation message replaces it while the value is not valid.Text
TooltipText shown from an info icon after the label.Text
LayoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.vertical, horizontal. Default: vertical
LengthNumber of characters in the code, and so the number of boxes.Number. Default: 6
CharactersCharacters the boxes accept. numeric takes digits only; alphanumeric also takes letters, which show in upper case.numeric, alphanumeric. Default: numeric
MaskHides each typed character behind a dot.On or off. Default: Off
ValueThe code the boxes start with. Characters the code doesn't accept are dropped, and it's cut to Length.Text
VariantBorder style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line.outlined, filled, borderless, underlined. Default: outlined
SizeHeight and text size of the field.small, middle, large. Default: middle

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the code changes.
On completeTriggers when every box is filled.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set valueFills the boxes with the given Value.components.otp1.setFieldValue("")
ClearSets the code back to the Value property, which empties the boxes when Value is empty.components.otp1.resetFields()
FocusMoves keyboard focus to the code boxes.components.otp1.focus()
Set visibilityShows the component when true, hides it when false.components.otp1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.otp1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.otp1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown with the code boxes.{{components.otp1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is not valid.{{components.otp1.extra}}
tooltipText shown from an info icon after the label.{{components.otp1.tooltip}}
layoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.{{components.otp1.layout}}
lengthNumber of characters in the code, and so the number of boxes.{{components.otp1.length}}
charactersCharacters the boxes accept. numeric takes digits only; alphanumeric also takes letters, which show in upper case.{{components.otp1.characters}}
maskHides each typed character behind a dot.{{components.otp1.mask}}
valueThe code the boxes start with. Characters the code doesn't accept are dropped, and it's cut to Length.{{components.otp1.value}}
variantBorder style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line.{{components.otp1.variant}}
sizeHeight and text size of the field.{{components.otp1.size}}
isCompletetrue when every box is filled.{{components.otp1.isComplete}}
isVisibleWhether the component is visible.{{components.otp1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.otp1.isLoading}}
isDisabledWhether the component is disabled.{{components.otp1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.