MudBlazor

MudDatePicker API

Properties

Name Type Default Description
AutoClose
Boolean

False

If AutoClose is set to true and PickerActions are defined, selecting a day will close the MudDatePicker.
Date
Nullable<DateTime>

null

The currently selected date (two-way bindable). If null, then nothing was selected.
Inherited from MudBaseDatePicker
ClosingDelay
Int32

100

Milliseconds to wait before closing the picker. This helps the user see that the date was selected before the popover disappears.
DateFormat
String

"M/d/yyyy"

String Format for selected date view
DisplayMonths
Int32

1

Number of months to display in the calendar
FirstDayOfWeek
Nullable<DayOfWeek>

null

Defines on which day the week starts. Depends on the value of Culture.
IsDateDisabledFunc
Func<DateTime, Boolean>

Function to determine whether a date is disabled
MaxDate
Nullable<DateTime>

null

Max selectable date.
MaxMonthColumns
Nullable<Int32>

null

Maximum number of months in one row
MinDate
Nullable<DateTime>

null

Max selectable date.
NextIcon
String
Custom next icon.
OpenTo
OpenTo

OpenTo.Date

First view to show in the MudDatePicker.
PickerMonth
Nullable<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.
PreviousIcon
String
Custom previous icon.
ShowWeekNumbers
Boolean

False

Display week numbers according to the Culture parameter. If no culture is defined, CultureInfo.CurrentCulture will be used.
StartMonth
Nullable<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".
Inherited from MudPicker<Nullable<DateTime>>
Adornment
Adornment

Adornment.End

Sets if the icon will be att start or end, set to false to disable.
AdornmentColor
Color

Color.Default

The color of the adornment if used. It supports the theme colors.
AdornmentIcon
String
Sets the icon of the input text field
AllowKeyboardInput
Boolean

False

Allows text input from keyboard.
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.
Disabled
Boolean

False

If true, the picker will be disabled.
DisableToolbar
Boolean

False

Hide toolbar and show only date/time views.
Editable
Boolean

False

If true, the picker will be editable.
Elevation
Int32

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.
HelperText
String

null

If string has value, HelperText will be applied.
HelperTextOnFocus
Boolean

False

If true, the helper text will only be visible on focus.
IconSize
Size

Size.Medium

Sets the Icon Size.
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.
Margin
Margin

Margin.None

Will adjust vertical spacing.
Orientation
Orientation

Orientation.Portrait

What orientation to render in when in PickerVariant Static Mode.
PickerActions
RenderFragment

null

Define the action buttons here
PickerVariant
PickerVariant

PickerVariant.Inline

Picker container option
Placeholder
String

null

The short hint displayed in the input before the user enters a value.
ReadOnly
Boolean

False

If true, no date or time can be defined.
Rounded
Boolean

False

If true, border-radius is set to theme default when in Static Mode.
Square
Boolean

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.
Text
String

null

The currently selected string value (two-way bindable)
ToolBarClass
String

null

User class names for picker's ToolBar, separated by space
Variant
Variant

Variant.Text

Variant of the text input
Inherited from MudFormComponent<Nullable<DateTime>, String>
Converter
Converter<Nullable<DateTime>, String>

The generic converter of the component.
Culture
CultureInfo

The culture of the component.
Error
Boolean

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<Nullable<DateTime>>>

null

Specify an expression which returns the model's field for which validation messages should be displayed. Currently only string fields are supported.
Required
Boolean

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
Inherited from MudComponentBase
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<Nullable<DateTime>>
Fired when the DateFormat changes.
PickerClosed
EventCallback
Fired when the dropdown / dialog closes
PickerMonthChanged
EventCallback<Nullable<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.
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 error has occurred. This application may no longer respond until reloaded. Reload 🗙