MudDatePicker API

Properties
Name Type Default Description
Data
Date
DateTime?
null The currently selected date (two-way bindable). If null, then nothing was selected.
Text
string
null The currently selected string value (two-way bindable)
Validation
Error
bool
False If true, the label will be displayed in an error state.
ErrorText
string
null The ErrorText that will be displayed if Error true.
For
Expression<Func<DateTime?>>
null Specify an expression which returns the model's field for which validation messages should be displayed. Currently only string fields are supported.
IsDateDisabledFunc
Func<DateTime, bool>
Function to determine whether a date is disabled
MaxDate
DateTime?
null Max selectable date.
MinDate
DateTime?
null Min selectable date.
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 Sets if the icon will be att start or end, set to false to disable.
AdornmentIcon
string
Sets the icon of the input text field
Converter
Converter<DateTime?, string>
The generic converter of the component.
Culture
CultureInfo
The culture of the component.
DateFormat
string
"M/d/yyyy" String Format for selected date view
Disabled
bool
False If true, the picker will be disabled.
Editable
bool
False If true, the picker will be editable.
HelperText
string
null If string has value, HelperText will be applied.
HelperTextOnFocus
bool
False If true, the helper text will only be visible on focus.
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.
Mask
IMask
null A mask for structured input of the date (requires Editable to be true).
PickerVariant
PickerVariant
PickerVariant.Inline Picker container option
Placeholder
string
null The short hint displayed in the input before the user enters a value.
ReadOnly
bool
False If true, no date or time can be defined.
Appearance
AdornmentAriaLabel
string
"Open Date Picker" Sets the aria-label of the input text field icon
AdornmentColor
Color
Color.Default The color of the adornment if used. It supports the theme colors.
AnchorOrigin
Origin
Origin.TopLeft Gets or sets the origin of the popover's anchor. Defaults to Origin.TopLeft
IconSize
Size
Size.Medium Sets the Icon Size.
Margin
Margin
Margin.None Will adjust vertical spacing.
TransformOrigin
Origin
Origin.TopLeft Gets or sets the origin of the popover's transform. Defaults to Origin.TopLeft
Variant
Variant
Variant.Text Variant of the text input
Picker behavior
AutoClose
bool
False If AutoClose is set to true and PickerActions are defined, selecting a day will close the MudDatePicker.
ClosingDelay
int
100 Milliseconds to wait before closing the picker. This helps the user see that the date was selected before the popover disappears.
DisplayMonths
int
1 Number of months to display in the calendar
FirstDayOfWeek
DayOfWeek?
null Defines on which day the week starts. Depends on the value of Culture.
FixDay
int?
null Set a predefined fix day - no day can be selected
FixMonth
int?
null Set a predefined fix month - no month can be selected
FixYear
int?
null Set a predefined fix year - no year can be selected
OpenTo
OpenTo
OpenTo.Date First view to show in the MudDatePicker.
PickerActions
RenderFragment<MudPicker<DateTime?>>
null Define the action buttons here
PickerMonth
DateTime?
null The current month of the date picker (two-way bindable). This changes when the user browses through the calender. The month is represented as a DateTime which is always the first day of that month. You can also set this to define which month is initially shown. If not set, the current month is shown.
ShowWeekNumbers
bool
False Display week numbers according to the Culture parameter. If no culture is defined, CultureInfo.CurrentCulture will be used.
StartMonth
DateTime?
null Start month when opening the picker.
TitleDateFormat
string
"ddd, dd MMM" Format of the selected date in the title. By default, this is "ddd, dd MMM" which abbreviates day and month names. For instance, display the long names like this "dddd, dd. MMMM".
Picker appearance
ClassActions
string
null CSS class that will be applied to the action buttons container
Color
Color
Color.Primary The color of the toolbar, selected and active. It supports the theme colors.
DisableToolbar
bool
False Hide toolbar and show only date/time views.
Elevation
int
8 The higher the number, the heavier the drop-shadow. 0 for no shadow set to 8 by default in inline mode and 0 in static mode.
MaxMonthColumns
int?
null Maximum number of months in one row
NextIcon
string
Custom next icon.
Orientation
Orientation
Orientation.Portrait What orientation to render in when in PickerVariant Static Mode.
PreviousIcon
string
Custom previous icon.
Rounded
bool
False If true, border-radius is set to theme default when in Static Mode.
Square
bool
False If true, border-radius is set to 0 this is set to true automatically in static mode but can be overridden with Rounded bool.
ToolBarClass
string
null User class names for picker's ToolBar, separated by space
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
DateChanged EventCallback<DateTime?> Fired when the DateFormat changes.
PickerClosed EventCallback Fired when the dropdown / dialog closes
PickerMonthChanged EventCallback<DateTime?> Fired when the date changes.
PickerOpened EventCallback Fired when the dropdown / dialog opens
TextChanged EventCallback<string> Fired when the text changes.
Methods
Name Parameters Return Description
Clear(bool close)
bool close
Close(bool submit)
bool submit
ValueTask FocusAsync()
ValueTask
string GetErrorText()
string : Error text/message
Return the validation error text or the conversion error message.
GoToDate() Scrolls to the date.
Task GoToDate(DateTime date, bool submitDate)
DateTime date
bool submitDate
Task
Scrolls to the defined date.
Open()
Reset() Reset the value and the validation.
ResetValidation() Reset the validation.
ScrollToYear()
ValueTask SelectAsync()
ValueTask
ValueTask SelectRangeAsync(int pos1, int pos2)
int pos1
int pos2
ValueTask
ToggleOpen()
Task Validate()
Task
Cause this component to validate its value.
An unhandled error has occurred. Reload 🗙