OtpInput
The OTP input is used for MFA procedure of authenticating users by a one-time password.
Usage
Basic
Basic
Length
Disabled
AutoFocus
InputType
Text
Number
Password
Directions
Default
Reversed
Vertical
Reversed Vertical
Style & Class
Component's Style & Class:
Styles & Classes:
Binding
One-way
Two-way
Events
OnChange
OnChange value:
OnFill
OnFill value:
OnFocusIn
Focus type:
Input index:
OnFocusOut
Focus type:
Input index:
OnInput
Value:
Input index:
OnKeyDown
Key & Code: [] []
Input index:
OnPaste
Focus type:
Input index:
Validation
RTL
Default
Reversed
Vertical
Reversed Vertical
Implementation
BitOtpInput parameters
Name |
Type |
Default value |
Description |
---|---|---|---|
AutoFocus | bool | false | If true, the first input is auto focused. |
Classes | BitOtpInputClassStyles? | null | Custom CSS classes for different parts of the BitOtpInput. |
InputType | BitOtpInputType | BitOtpInputType.Text | Type of the inputs. |
Length | int | 5 | Length of the OTP or number of the inputs. |
OnFill | EventCallback<string?> | Callback for when all of the inputs are filled. | |
OnFocusIn | EventCallback<FocusEventArgs> | onfocusin event callback for each input. | |
OnFocusOut | EventCallback<FocusEventArgs> | onfocusout event callback for each input. | |
OnInput | EventCallback<ChangeEventArgs> | oninput event callback for each input. | |
OnKeyDown | EventCallback<KeyboardEventArgs> | onkeydown event callback for each input. | |
OnPaste | EventCallback<ClipboardEventArgs> | onpaste event callback for each input. | |
Reversed | bool | false | Defines whether to render inputs in the opposite direction. |
Styles | BitOtpInputClassStyles? | null | Custom CSS styles for different parts of the BitOtpInput. |
Vertical | bool | false | Defines whether to render inputs vertically. |
BitOtpInput public members
Name |
Type |
Default value |
Description |
---|---|---|---|
InputElements | ElementReference[] | The ElementReferences to the input elements of the BitOtpInput. | |
FocusAsync | ValueTask | Gives focus to a specific input element of the BitOtpInput. |
BitInputBase parameters
Name |
Type |
Default value |
Description |
---|---|---|---|
DebounceTime | int | 0 | The debounce time in milliseconds. |
DisplayName | string? | null | Gets or sets the display name for this field. |
Immediate | bool | false | Change the content of the input field when the user write text (based on 'oninput' HTML event). |
InputHtmlAttributes | IReadOnlyDictionary<string, object>? | null | Gets or sets a collection of additional attributes that will be applied to the created element. |
Name | string? | null | Gets or sets the name of the element. Allows access by name from the associated form. |
OnChange | EventCallback<TValue?> | Callback for when the input value changes. | |
ThrottleTime | int | 0 | The throttle time in milliseconds. |
Value | TValue? | null | Gets or sets the value of the input. This should be used with two-way binding. |
BitInputBase public members
Name |
Type |
Default value |
Description |
---|---|---|---|
InputElement | ElementReference | The ElementReference of the input element. | |
FocusAsync() | () => ValueTask | Gives focus to the input element. | |
FocusAsync(bool preventScroll) | (bool preventScroll) => ValueTask | Gives focus to the input element. |
BitComponentBase parameters
Name |
Type |
Default value |
Description |
---|---|---|---|
AriaLabel | string? | null | The aria-label of the control for the benefit of screen readers. |
Class | string? | null | Custom CSS class for the root element of the component. |
Dir | BitDir? | null | Determines the component direction. |
HtmlAttributes | Dictionary<string, object> | new Dictionary<string, object>() | Capture and render additional attributes in addition to the component's parameters. |
Id | string? | null | Custom id attribute for the root element. if null the UniqueId will be used instead. |
IsEnabled | bool | true | Whether or not the component is enabled. |
Style | string? | null | Custom CSS style for the root element of the component. |
Visibility | BitVisibility | BitVisibility.Visible | Whether the component is visible, hidden or collapsed. |
BitComponentBase public members
Name |
Type |
Default value |
Description |
---|---|---|---|
UniqueId | Guid | Guid.NewGuid() | The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction. |
RootElement | ElementReference | The ElementReference of the root element. |
BitOtpInputClassStyles properties
Name |
Type |
Default value |
Description |
---|---|---|---|
Root | string? | null | Custom CSS classes/styles for the root element of the otp input. |
Input | string? | null | Custom CSS classes/styles for each input in otp input. |
BitOtpInputType enum
Name |
Value |
Description |
---|---|---|
Text | 0 | The OtpInput characters are shown as text. |
Password | 1 | The OtpInput characters are masked. |
Number | 2 | The OtpInput characters are number. |
BitVisibility enum
Name |
Value |
Description |
---|---|---|
Visible | 0 | The content of the component is visible. |
Hidden | 1 | The content of the component is hidden, but the space it takes on the page remains (visibility:hidden). |
Collapsed | 2 | The component is hidden (display:none). |
BitDir enum
Name |
Value |
Description |
---|---|---|
Ltr | 0 | Ltr (left to right) is to be used for languages that are written from the left to the right (like English). |
Rtl | 1 | Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic). |
Auto | 2 | Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element. |