MudSelect<T> API

Pages
Properties
Name Type Default Description
Data
SelectedValues
IEnumerable<T>
Set of selected values. If MultiSelection is false it will only ever contain a single value. This property is two-way bindable.
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.
MaxLength
int
524288 Maximum number of characters that the input will accept
Pattern
string
null 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 Not Supported in multline input
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
null 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.End 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.
Comparer
IEqualityComparer<T>
null The Comparer to use for comparing selected values internally.
Converter
Converter<T, string>
The generic converter of the component.
Culture
CultureInfo
The culture of the component.
Delimiter
string
", " Parameter to define the delimited string separator.
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.text Hints at the type of data that might be entered by the user while editing the input
KeyDownPreventDefault
bool
False Prevent the default action for the KeyDown event.
KeyPressPreventDefault
bool
False Prevent the default action for the KeyPress 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.
MultiSelectionTextFunc
Func<List<string>, string>
null Function to define a customized multiselection text.
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.
Strict
bool
False If true, the Select's input will not show any values that are not defined in the dropdown. This can be useful if Value is bound to a variable which is initialized to a value which is not in the list and you want the Select to show the label / placeholder instead.
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.
CloseIcon
string
The Close Select Icon
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.
IconSize
Size
Size.Medium The Icon Size.
Margin
Margin
Margin.None Will adjust vertical spacing.
OpenIcon
string
The Open Select Icon
Variant
Variant
Variant.Text Variant to use.
List behavior
ChildContent
RenderFragment
null Add the MudSelectItems here
LockScroll
bool
False If true, prevent scrolling while dropdown is open.
MultiSelection
bool
False If true, multiple values can be selected via checkboxes which are automatically shown in the dropdown
SelectAll
bool
False If set to true and the MultiSelection option is set to true, a "select all" checkbox is added at the top of the list of items.
ToStringFunc
Func<T, string>
Defines how values are displayed in the drop-down list
List appearance
AnchorOrigin
Origin
Origin.TopCenter Set the anchor origin point to determen where the popover will open from.
CheckedIcon
string
Custom checked icon.
Dense
bool
False If true, compact vertical padding will be applied to all Select items.
IndeterminateIcon
string
Custom indeterminate icon.
MaxHeight
int
300 Sets the maxheight the Select can have when open.
PopoverClass
string
null User class names for the popover, separated by space
SelectAllText
string
"Select all" Define the text of the Select All option.
TransformOrigin
Origin
Origin.TopCenter Sets the transform origin point for the popover.
UncheckedIcon
string
Custom unchecked icon.
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.
OnClearButtonClick EventCallback<MouseEventArgs> Button click event for clear button. Called after text and value has been cleared.
OnClose EventCallback Fired when dropdown closes.
OnInternalInputChanged EventCallback<ChangeEventArgs> Fired when the element changes internally its text value.
OnKeyDown EventCallback<KeyboardEventArgs> Fired on the KeyDown event.
OnKeyPress EventCallback<KeyboardEventArgs> Fired on the KeyPress event.
OnKeyUp EventCallback<KeyboardEventArgs> Fired on the KeyUp event.
OnOpen EventCallback Fired when dropdown opens.
SelectedValuesChanged EventCallback<IEnumerable<T>> Fires when SelectedValues changes.
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
CheckGenericTypeMatch(object select_item)
object select_item
Task Clear()
Task
Clear the selection
Task CloseMenu(bool focusAgain)
bool focusAgain
Task
ValueTask FocusAsync()
ValueTask
ForceRender(bool forceTextUpdate)
bool forceTextUpdate
string GetErrorText()
string : Error text/message
Return the validation error text or the conversion error message.
Task OpenMenu()
Task
RegisterShadowItem(MudSelectItem<T> item)
MudSelectItem<T> item
Reset() Reset the value and the validation.
ResetValidation() Reset the validation.
ValueTask SelectAsync()
ValueTask
Task SelectOption(int index)
int index
Task
Task SelectOption(object obj)
object obj
Task
ValueTask SelectRangeAsync(int pos1, int pos2)
int pos1
int pos2
ValueTask
Task ToggleMenu()
Task
UnregisterShadowItem(MudSelectItem<T> item)
MudSelectItem<T> item
Task Validate()
Task
Cause this component to validate its value.
An unhandled error has occurred. Reload 🗙