Blazorise Numeric Input API
Explore the Blazorise Numeric Input API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the Numeric 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 NumericInput. | ||
Color | Color.Default | Color |
Defines the intent of the input. | ||
Culture | CultureInfo.InvariantCulture | string |
Helps define the language of an element. See w3schools.com. | ||
Debounce | false | bool? |
If true the entered text will be slightly delayed before submitting it to the internal value. When unspecified, uses BlazoriseOptions.Debounce, falling back to false. | ||
DebounceInterval | 300 | int? |
Interval in milliseconds that entered text will be delayed from submitting to the internal value. When unspecified, uses BlazoriseOptions.DebounceInterval, falling back to 300. | ||
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. | ||
Immediate | true | bool? |
If true the text in will be changed after each key press. Note that setting this will override global settings in Immediate. When unspecified, uses BlazoriseOptions.Immediate, falling back to true. | ||
Intent | null | Intent |
Defines the intent of the input. | ||
Max | Unrestricted | TValue |
The maximum value to accept for this input. When omitted, no maximum constraint is applied. | ||
Min | Unrestricted | TValue |
The minimum value to accept for this input. When omitted, no minimum constraint is applied. | ||
OnScreenKeyboard | false | bool |
Enables the on-screen keyboard for this input component. When not explicitly set, the global accessibility option is used. When omitted, uses the global accessibility setting and enabled input types. | ||
OnScreenKeyboardEnterKeyBehavior | Input-dependent | OnScreenKeyboardEnterKeyBehavior |
Specifies how the on-screen keyboard enter key should behave for this input component. Possible values: DefaultNewLineSubmitHideKeyDownWhen omitted, uses the cascading override, then the global option, then the input component's behavior. | ||
OnScreenKeyboardLayout | Input-dependent | OnScreenKeyboardLayout |
Specifies the on-screen keyboard layout for this input component. When not explicitly set, the global accessibility option is used. Possible values: TextNumericDecimalEmailUrlTelephoneWhen omitted, uses the global default layout, then the input component's layout. | ||
OnScreenKeyboardShowMode | Focus | OnScreenKeyboardShowMode |
Gets or sets how the on-screen keyboard is shown for this input. Possible values: DefaultFocusManualWhen omitted, uses the global show mode; Default resolves to Focus. | ||
Pattern | — | string |
The pattern attribute specifies a regular expression that the input element's value is checked against on form validation. | ||
Placeholder | — | string |
Sets the placeholder for the empty text. | ||
Plaintext | false | bool |
Sets the class to remove the default form field styling and preserve the correct margin and padding. | ||
ReadOnly | false | bool |
Add the readonly boolean attribute on an input to prevent modification of the input’s value. | ||
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. | ||
Step | 1 | decimal? |
Specifies the interval between valid values. | ||
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. | ||
VisibleCharacters | null | int? |
The size attribute specifies the visible width, in characters, of an input element. See w3schools.com. | ||
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 |
|---|---|---|
Select | Task | bool focus |
Select all text in the underline component.
| ||
ShowOnScreenKeyboard | Task | bool focus |
Shows the on-screen keyboard for this input.
| ||
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.
| ||