OtpInput
The OTP input is used for MFA procedure of authenticating users by a one-time password.
Usage
Basic
AutoFocus
Style & Class
Visibility
Visible: [ ]
Hidden: [ ]
Collapsed: [ ]
InputType
Direction
Controlled
Validation
Implementation
BitOtpInput parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| AutoFocus | bool | false | If true, the first input is focused. |
| Classes | BitOtpInputClassStyles? | null | Custom CSS classes for different parts of the BitOtpInput. |
| Direction | BitOtpInputDirection | BitOtpInputDirection.LeftToRight | The OtpInput direction in four available directions. |
| InputType | BitOtpInputType | BitOtpInputType.Text | Type of input shown as text, number, and password. |
| Length | int | 0 | Length of input in Otp. |
| OnInput | EventCallback<ChangeEventArgs> | Callback for when OtpInput value changed. | |
| OnKeyDown | EventCallback<KeyboardEventArgs> | Callback for when a keyboard key is pressed. | |
| OnFocusIn | EventCallback<FocusEventArgs> | Callback for when OtpInput is focused in. | |
| OnFocusOut | EventCallback<FocusEventArgs> | Callback for when OtpInput is focused out. | |
| OnPaste | EventCallback<ClipboardEventArgs> | Callback for when in the OtpInput paste a content. | |
| OnChange | EventCallback<string?> | Callback for when the OtpInput value change. | |
| Styles | BitOtpInputClassStyles? | null | Custom CSS styles for different parts of the BitOtpInput. |
BitInputBase parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| DisplayName | string? | null | Gets or sets the display name for this field. |
| InputHtmlAttributes | IReadOnlyDictionary<string, object>? | null | Gets or sets a collection of additional attributes that will be applied to the created element. |
| Value | TValue? | null | Gets or sets the value of the input. This should be used with two-way binding. |
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. |
| 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 |
|---|---|---|---|
| Input | string? | null | Custom CSS classes/styles for each input in otp input. |
BitOtpInputDirection 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. |
BitOtpInputType enum
Name |
Value |
Description |
|---|---|---|
| LeftToRight | 0 | The OtpInput showed in the left to right direction. |
| RightToLeft | 1 | The OtpInput showed in the right to left direction. |
| TopToBottom | 2 | The OtpInput showed in the top to bottom direction. |
| BottomToTop | 3 | The OtpInput showed in the bottom to top direction. |
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). |