Blazorise One Time Input API
Explore the Blazorise One Time Input API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the One Time Input documentation.
API
Parameters
| Parameter | Default | Type |
|---|---|---|
AriaDescribedBy | — | string |
Specifies the aria-describedby attribute value. When set, this value is rendered as-is and overrides help and validation message ids generated by Field and Validation. | ||
AriaInvalid | — | string |
Specifies the aria-invalid attribute value. When set, this value is rendered as-is and overrides the validation-derived aria-invalid state. | ||
AriaLabelledBy | — | string |
Specifies the aria-labelledby attribute value. When set, this value is rendered as-is. Some non-labelable controls can otherwise derive it automatically from a parent FieldLabel or FieldsLabel. | ||
AriaRequired | false | bool |
Specifies the aria-required attribute value. When set, this value overrides the required-field state resolved from the parent Validation. | ||
Autofocus | false | bool |
Set's the focus to the component after the rendering is done. | ||
ChildContent | null | RenderFragment |
Specifies the content to be rendered inside this OneTimeInput. | ||
Digits | 6 | int |
Specifies the number of input slots to render. | ||
Disabled | false | bool |
Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter. | ||
Feedback | null | RenderFragment |
Placeholder for validation messages. | ||
Group | — | string |
Specifies the slot grouping definition, such as 2,3. | ||
InputMode | Numeric | TextInputMode |
Specifies the input mode used by each slot input. Possible values: NoneTextTelUrlEmailNumericDecimalSearch | ||
Pattern | — | string |
Specifies the regex pattern used by pattern-based validation. | ||
ReadOnly | false | bool |
Add the readonly boolean attribute on an input to prevent modification of the input’s value. | ||
Role | Text | TextRole |
Specifies the role of each slot input. Possible values: TextEmailPasswordUrlSearchTelephone | ||
Size | Default | Size? |
Sets the size of the input control. When omitted, uses the parent Addons size, then the theme input size, then Size.Default. | ||
TabIndex | null | int? |
If defined, indicates that its element can be focused and can participates in sequential keyboard navigation. | ||
Value | null | TValue |
Specifies the value inside the input field. | ||
ValueExpression | null | Expression<Func<TValue>> |
Specifies an expression that identifies the input value. | ||
Events
| Event | Type |
|---|---|
Blur | EventCallback<FocusEventArgs> |
The blur event fires when an element has lost focus. | |
CustomValidationValue | Func<TValue> |
Used to provide custom validation value on which the validation will be processed with the Validator handler. Should be used carefully as it's only meant for some special cases when input is used in a wrapper component, like Autocomplete or SelectList. | |
FocusIn | EventCallback<FocusEventArgs> |
Notifies when the input box gains focus. | |
FocusOut | EventCallback<FocusEventArgs> |
Notifies when the input box loses focus. | |
KeyDown | EventCallback<KeyboardEventArgs> |
Notifies when a key is pressed down while the control has focus. | |
KeyPress | EventCallback<KeyboardEventArgs> |
Notifies when a key is pressed while the control has focus. | |
KeyUp | EventCallback<KeyboardEventArgs> |
Notifies when a key is released while the control has focus. | |
OnFocus | EventCallback<FocusEventArgs> |
Notifies when the input box gains or loses focus. | |
ValueChanged | EventCallback<TValue> |
Occurs after value has changed. | |
Methods
| Method | Return | Parameters |
|---|---|---|
Focus | Task | bool scrollToElement |
Sets the focus on the underline element.
| ||
Revalidate | Task | — |
Forces the Validation (if any is used) to re-validate with the new custom or internal value.
| ||