Blazorise Date Picker API

Explore the Blazorise Date Picker API reference for parameters, events, methods, and related types.

For examples and usage guidance, see the Date Picker documentation.

API

Parameters

ParameterDefaultType
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.
AriaRequiredfalsebool

Specifies the aria-required attribute value.
When set, this value overrides the required-field state resolved from the parent Validation.
Autofocusfalsebool

Set's the focus to the component after the rendering is done.
ChildContentnullRenderFragment

Specifies the content to be rendered inside this DatePicker.
ColorColor.DefaultColor

Defines the intent of the input.
DefaultHour12int

Specifies the initial value of the hour element.
DefaultMinute0int

Specifies the initial value of the minute element.
Disabledfalsebool

Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter.
DisabledDatesnullIEnumerable

List of disabled dates that the user should not be able to pick.
DisabledDaysnullIEnumerable<DayOfWeek>

List of disabled days in a week that the user should not be able to pick.
DisableMobiletruebool

Prevents the browser's native picker from being used on mobile devices.
DisplayFormatyyyy-MM-ddstring

Specifies the display format of the date input using the picker format syntax supported by earlier versions.
Week mode additionally supports w, ww, and wo for the week number and its English ordinal form.

When omitted, resolves the display format from InputMode and DateFormat.

EnabledDatesnullIEnumerable

List of enabled dates that the user should be able to pick.
FeedbacknullRenderFragment

Placeholder for validation messages.
FirstDayOfWeekDayOfWeek.MondayDayOfWeek

Specifies the first day of the week used for date calculations.
In week mode this controls the visual calendar layout. Selected values continue to represent ISO Monday-to-Sunday weeks.
Inlinefalsebool

Display the calendar in an always-open state with the inline option.
InputFormat—string

Specifies the input format mask of the date input using Blazorise's InputMask integration.
Week mode supports the w and ww week-number tokens.
InputModeDateDateInputMode

Hints at the type of data that might be entered by the user while editing the element or its contents.
Possible values:DateDateTimeMonthWeek
IntentnullIntent

Defines the intent of the input.
MaxnullDateTimeOffset?

The latest date to accept. Updating this value does not change the selected date, even if it exceeds the new maximum.
MinnullDateTimeOffset?

The earliest date to accept. Updating this value does not change the selected date, even if it falls below the new minimum.
OnScreenKeyboardfalsebool

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.
OnScreenKeyboardEnterKeyBehaviorInput-dependentOnScreenKeyboardEnterKeyBehavior

Specifies how the on-screen keyboard enter key should behave for this input component.
Possible values:DefaultNewLineSubmitHideKeyDown
When omitted, uses the cascading override, then the global option, then the input component's behavior.
OnScreenKeyboardLayoutInput-dependentOnScreenKeyboardLayout

Specifies the on-screen keyboard layout for this input component. When not explicitly set, the global accessibility option is used.
Possible values:TextNumericDecimalEmailUrlTelephone
When omitted, uses the global default layout, then the input component's layout.
OnScreenKeyboardShowModeFocusOnScreenKeyboardShowMode

Gets or sets how the on-screen keyboard is shown for this input.
Possible values:DefaultFocusManual
When omitted, uses the global show mode; Default resolves to Focus.
OpenTriggerAllPickerOpenTrigger

Defines which interactions can open the calendar menu.
Possible values:NoneClickFocusOpenKeysAll
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.
Plaintextfalsebool

Sets the class to remove the default form field styling and preserve the correct margin and padding.
RangeSeparator" to "string

Overrides the range separator that is used to separate date values when SelectionMode is set to Range.
When omitted, uses the localized range separator, falling back to " to ".
ReadOnlyfalsebool

Add the readonly boolean attribute on an input to prevent modification of the input’s value.
SelectionModeSingleDateInputSelectionMode

Specifies the mode in which the dates can be selected.
Possible values:SingleRangeMultiple
ShowClearButtonfalsebool

Determines whether to show the clear button in the calendar menu.
ShowTodayButtonfalsebool

Determines whether to show the today button in the calendar menu.
ShowWeekNumbersfalsebool

Determines whether the calendar menu will show week numbers.
Week numbers are always shown when InputMode is Week.
SizeDefaultSize?

Sets the size of the input control.
When omitted, uses the parent Addons size, then the theme input size, then Size.Default.
StaticPickertruebool

If enabled, the calendar menu will be positioned as static.
TabIndexnullint?

If defined, indicates that its element can be focused and can participates in sequential keyboard navigation.
TimeAs24hrfalsebool

Displays time picker in 24 hour mode without AM/PM selection when enabled.
ValuenullTValue

Specifies the value inside the input field.
ValueExpressionnullExpression<Func<TValue>>

Specifies an expression that identifies the input value.

Events

EventType
BlurEventCallback<FocusEventArgs>

The blur event fires when an element has lost focus.
CustomValidationValueFunc<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.
FocusInEventCallback<FocusEventArgs>

Notifies when the input box gains focus.
FocusOutEventCallback<FocusEventArgs>

Notifies when the input box loses focus.
KeyDownEventCallback<KeyboardEventArgs>

Notifies when a key is pressed down while the control has focus.
KeyPressEventCallback<KeyboardEventArgs>

Notifies when a key is pressed while the control has focus.
KeyUpEventCallback<KeyboardEventArgs>

Notifies when a key is released while the control has focus.
OnFocusEventCallback<FocusEventArgs>

Notifies when the input box gains or loses focus.
ValueChangedEventCallback<TValue>

Occurs after value has changed.

Methods

MethodReturnParameters
CloseAsyncValueTask—

Closes the calendar dropdown.
OpenAsyncValueTask—

Opens the calendar dropdown.
ToggleAsyncValueTask—

Shows/opens the calendar if its closed, hides/closes it otherwise.
SelectTaskbool focus

Select all text in the underline component.
ShowOnScreenKeyboardTaskbool focus

Shows the on-screen keyboard for this input.
FocusTaskbool scrollToElement

Sets the focus on the underline element.
RevalidateTask—

Forces the Validation (if any is used) to re-validate with the new custom or internal value.
On this page