Back to Tuist

DigitInput

noora/docs/components/digitinput.md

4.204.03.0 KB
Original Source
<!-- Generated by scripts/generate-web-components.js. Do not edit directly. -->

DigitInput

Collects a fixed-length verification or personal identification code.

html
<noora-digit-input characters="6" one-time-code></noora-digit-input>

Attributes

AttributeType or allowed valuesDefaultDescription
typealphanumeric, numeric, alphabetic"numeric"Limits accepted characters.
charactersnumber6Sets the number of fields.
placeholderstring""Sets each field placeholder.
one-time-codebooleanfalseEnables one-time-code autofill.
errorbooleanfalseShows the error state.
disabledbooleanfalseDisables all fields.
valuestring""Gets or sets the combined value.
namestring""Sets the hidden submitted field name.

Events

EventTypeDescription
inputInputEventEmitted while the entered code changes.
changeEventEmitted when every field contains a valid character.
noora-inputCustomEvent<{ value: string }>Emitted with the current code after a valid input.
noora-completeCustomEvent<{ value: string }>Emitted when every field contains a valid character.
noora-invalidCustomEvent<{ value: string }>Emitted when an entered or pasted value is rejected.

Styling parts

PartDescription
rootThe field group.
inputEach character input.

The component emits noora-complete when every field contains a character.

Input types

Choose numeric, alphanumeric, or alphabetic validation.

html
<noora-digit-input type="numeric" characters="6" placeholder="•"></noora-digit-input>
<noora-digit-input type="alphanumeric" characters="4" placeholder="•"></noora-digit-input>
<noora-digit-input type="alphabetic" characters="3" placeholder="•"></noora-digit-input>

Character counts

Collect short, medium, and long codes.

html
<noora-digit-input characters="4" placeholder="•"></noora-digit-input>
<noora-digit-input characters="6" placeholder="•"></noora-digit-input>
<noora-digit-input characters="8" placeholder="•"></noora-digit-input>

One-time codes

Enable browser-assisted one-time-code entry.

html
<noora-digit-input characters="6" one-time-code placeholder="•"></noora-digit-input>
<noora-digit-input characters="4" one-time-code placeholder="0"></noora-digit-input>

States

Compare default, disabled, and error states.

html
<noora-digit-input characters="4" placeholder="•"></noora-digit-input>
<noora-digit-input characters="4" placeholder="•" disabled></noora-digit-input>
<noora-digit-input characters="4" placeholder="•" error></noora-digit-input>

Placeholders

Use dots, dashes, or empty fields.

html
<noora-digit-input characters="6" placeholder="•"></noora-digit-input>
<noora-digit-input characters="6" placeholder="-"></noora-digit-input>
<noora-digit-input characters="6"></noora-digit-input>