MudBlazor - Blazor Component Library

Pages

Numeric Field

Properties

Data
Name	Type	Default	Description
`Text`	string	null	The text to be displayed.
`Value`	T	null	The value of this input element.
Validation
`Counter`	int?	null	If set, will display the counter, value 0 will display current count but no stop count.
`Error`	bool	False	If true, the label will be displayed in an error state.
`ErrorId`	string	null	The ErrorId that will be used by aria-describedby if Error true
`ErrorText`	string	null	The ErrorText that will be displayed if Error true.
`For`	Expression<Func<T>>	null	Specify an expression which returns the model's field for which validation messages should be displayed.
`Max`	T	null	The maximum value for the input.
`MaxLength`	int	524288	Maximum number of characters that the input will accept
`Min`	T	null	The minimum value for the input.
`Pattern`	string	"[0-9,.\-]"	The pattern attribute, when specified, is a regular expression which the input's value must match in order for the value to pass constraint validation. It must be a valid JavaScript regular expression Defaults to [0-9,.\-] To get a numerical keyboard on safari, use the pattern. The default pattern should achieve numerical keyboard. Note: this pattern is also used to prevent all input except numbers and allowed characters. So for instance to allow only numbers, no signs and no commas you might change it to [0-9.]
`Required`	bool	False	If true, this form input is required to be filled out.
`RequiredError`	string	"Required"	The error text that will be displayed if the input is not filled out but required.
`Validation`	object		A validation func or a validation attribute. Supported types are: Func<T, bool> ... will output the standard error message "Invalid" if false Func<T, string> ... outputs the result as error message, no error if null Func<T, IEnumerable< string >> ... outputs all the returned error messages, no error if empty Func<object, string, IEnumerable< string >> input Form.Model, Full Path of Member ... outputs all the returned error messages, no error if empty Func<T, Task< bool >> ... will output the standard error message "Invalid" if false Func<T, Task< string >> ... outputs the result as error message, no error if null Func<T, Task<IEnumerable< string >>> ... outputs all the returned error messages, no error if empty Func<object, string, Task<IEnumerable< string >>> input Form.Model, Full Path of Member ... outputs all the returned error messages, no error if empty System.ComponentModel.DataAnnotations.ValidationAttribute instances
Behavior
`Adornment`	Adornment	Adornment.None	The Adornment if used. By default, it is set to None.
`AdornmentIcon`	string	null	Icon that will be used if Adornment is set to Start or End.
`AdornmentText`	string	null	Text that will be used if Adornment is set to Start or End, the Text overrides Icon.
`AutoFocus`	bool	False	If true the input will focus automatically.
`Clearable`	bool	False	Show clear button.
`Converter`	Converter<T, string>		The generic converter of the component.
`Culture`	CultureInfo		The culture of the component.
`DebounceInterval`	double	0	Interval to be awaited in milliseconds before changing the Text value
`Disabled`	bool	False	If true, the input element will be disabled.
`Format`	string	null	Conversion format parameter for ToString(), can be used for formatting primitive types, DateTimes and TimeSpans
`HelperText`	string	null	The HelperText will be displayed below the text field.
`HelperTextOnFocus`	bool	False	If true, the helper text will only be visible on focus.
`Immediate`	bool	False	If true, the input will update the Value immediately on typing. If false, the Value is updated only on Enter.
`InputMode`	InputMode	InputMode.numeric	Hints at the type of data that might be entered by the user while editing the input. Defaults to numeric
`InvertMouseWheel`	bool	False	Reverts mouse wheel up and down events, if true.
`KeyDownPreventDefault`	bool	False	Prevent the default action for the KeyDown event.
`KeyUpPreventDefault`	bool	False	Prevent the default action for the KeyUp event.
`Label`	string	null	If string has value the label text will be displayed in the input, and scaled down at the top if the input has value.
`Lines`	int	1	A multiline input (textarea) will be shown, if set to more than one line.
`OnlyValidateIfDirty`	bool	False	The validation is only triggered if the user has changed the input value at least once. By default, it is false
`Placeholder`	string	null	The short hint displayed in the input before the user enters a value.
`ReadOnly`	bool	False	If true, the input will be read-only.
`Step`	T	null	The increment added/subtracted by the spin buttons.
`TextUpdateSuppression`	bool	True	When TextUpdateSuppression is true (which is default) the text can not be updated by bindings while the component is focused in BSS (not WASM). This solves issue #1012: Textfield swallowing chars when typing rapidly If you need to update the input's text while it is focused you can set this parameter to false. Note: on WASM text update suppression is not active, so this parameter has no effect.
Appearance
`AdornmentAriaLabel`	string		The aria-label of the adornment.
`AdornmentColor`	Color	Color.Default	The color of the adornment if used. It supports the theme colors.
`DisableUnderLine`	bool	False	If true, the input will not have an underline.
`FullWidth`	bool	False	If true, the input will take up the full width of its container.
`HideSpinButtons`	bool	False	Hides the spin buttons, the user can still change value with keyboard arrows and manual update.
`IconSize`	Size	Size.Medium	The Icon Size.
`Margin`	Margin	Margin.None	Will adjust vertical spacing.
`ShrinkLabel`	bool	False	ShrinkLabel prevents the label from moving down into the field when the field is empty.
`Variant`	Variant	Variant.Text	Variant to use.
Common
`Class`	string	null	User class names, separated by space.
`Style`	string	null	User styles, applied on top of the component's own classes and styles.
`Tag`	object	null	Use Tag to attach any user data object to the component for your convenience.
`UserAttributes`	Dictionary<string, object>		UserAttributes carries all attributes you add to the component that don't match any of its parameters. They will be splatted onto the underlying HTML tag.

EventCallbacks

Name	Type	Description
`OnAdornmentClick`	EventCallback<MouseEventArgs>	Button click event if set and Adornment used.
`OnBlur`	EventCallback<FocusEventArgs>	Fired when the element loses focus.
`OnDebounceIntervalElapsed`	EventCallback<string>	callback to be called when the debounce interval has elapsed receives the Text as a parameter
`OnInternalInputChanged`	EventCallback<ChangeEventArgs>	Fired when the element changes internally its text value.
`OnKeyDown`	EventCallback<KeyboardEventArgs>	Fired on the KeyDown event.
`OnKeyUp`	EventCallback<KeyboardEventArgs>	Fired on the KeyUp event.
`TextChanged`	EventCallback<string>	Fired when the text value changes.
`ValueChanged`	EventCallback<T>	Fired when the Value property changes.

Methods

Name	Parameters	Return	Description
`ValueTask BlurAsync()`		ValueTask
`Task Decrement()`		Task	Substracts a Step from the Value
`ValueTask FocusAsync()`		ValueTask
`ForceRender(bool forceTextUpdate)`	bool forceTextUpdate
`Task ForceUpdate()`		Task	Sync the value, values and text, calls validation manually. Useful to call after user changes value or text programmatically.
`string GetErrorText()`		string : Error text/message	Return the validation error text or the conversion error message.
`Task Increment()`		Task	Adds a Step to the Value
`Task ResetAsync()`		Task	Reset the value and the validation.
`ResetValidation()`			Reset the validation.
`ValueTask SelectAsync()`		ValueTask
`ValueTask SelectRangeAsync(int pos1, int pos2)`	int pos1 int pos2	ValueTask
`Task Validate()`		Task	Cause this component to validate its value.

MudNumericField<T> API

Pages

Properties

Data

Validation

Behavior

Appearance

Common

EventCallbacks

Methods