Blazor Date Picker Overview
The Blazor Date Picker component allows the user to choose a date from a visual Gregorian calendar or type it into a date input that can accept only dates. You can control the date format of the input, how the user navigates through the calendar, and which dates the user cannot select.
The Date Picker component is part of Telerik UI for Blazor, a
professional grade UI library with 100+ native components for building modern and feature-rich applications. To try it out sign up for a free 30-day trial.
Creating Blazor Date Picker
Use the
TelerikDatePickertag to add the component to your razor page.Bind a
DateTimeobject to the componentOptionally, provide custom
Format,MinandMaxvalues
Basic Date Picker with custom format, min and max
The selected date is: @datePickerValue.ToShortDateString()
<br />
<TelerikDatePicker @bind-Value="datePickerValue"
Format="dd MMMM yyyy"
Min="@Min" Max="@Max">
</TelerikDatePicker>
@code {
DateTime datePickerValue { get; set; } = DateTime.Now;
public DateTime Min = new DateTime(1990, 1, 1, 8, 15, 0);
public DateTime Max = new DateTime(2025, 1, 1, 19, 30, 45);
}
Date Input Typing Settings
The DatePicker textbox is a DateInput component, which provides various parameters to configure the keyboard typing experience. The settings are related to:
- Caret placement;
- Two-digit year values;
- Automatic correction of invalid date segments.
See the DateInput keyboard documentation for details and examples. The same DateInput parameters with the same behavior exist for the DatePicker.
Increment Steps
The Date Picker enables the end users to change the selected value by clicking the rendered arrows. You can set the increment and decrement steps through the nested DatePickerSteps tag and its parameters. Read more about the Blazor Date Picker increment steps...
Events
The Blazor Date Picker generates events that you can handle and further customize its behavior. Read more about the Blazor Date Picker events....
Validation
You can ensure that the component value is acceptable by using the built-in validation. Read more about input validation....
Header Template
The DatePicker allows you to customize the rendering of the Calendar popup header. Learn more from the Header Template article.
Adaptive Rendering
The component supports different popup rendering depending on the screen size. Read more about the Adaptive Rendering functionality and how to enable it...
Week Numbers
The Calendar popup can display the ISO week number on each row of date cells. See the ShowWeekNumbers parameter below.
Date Picker Parameters
The Blazor Date Picker provides various parameters that allow you to configure the component:
| Attribute | Type and Default Value | Description |
|---|---|---|
AdaptiveMode |
AdaptiveMode enum ( None) |
The adaptive mode of the component. |
AutoComplete |
string ( "off") |
The autocomplete HTML attribute of the input. |
BottomView |
CalendarView enum ( Month) |
Defines the bottommost view in the popup calendar to which the user can navigate to. |
DebounceDelay |
int ( 150) |
Time in milliseconds between the last typed symbol and the value update. Use it to balance between client-side performance and number of database queries. |
DisabledDates |
List<DateTime> |
A list of dates that cannot be selected. |
Enabled |
bool |
Specifies whether typing in the input and clicking the button is allowed. |
Format |
string |
The format of the DatePicker's DateInput. Read more about supported data formats in Telerik DateInput for Blazor UI article. |
Id |
string |
The id attribute on the <input /> element. Use it to attach a <label for=""> to the input. |
Max |
DateTime ( DateTime(2099, 12, 31, 23, 59, 59)) |
The latest date that the user can select. |
Min |
DateTime ( DateTime(1900, 1, 1, 0, 0, 0)) |
The earliest date that the user can select. |
Placeholder |
string |
Maps to the placeholder attribute of the HTML element. The Placeholder will appear if the component is bound to a nullable DateTime object - DateTime?. It will not be rendered if the component is bound to the default value of a non-nullable DateTime object. The Placeholder value will be displayed when the input is not focused. Once the user focuses it to start typing, the Format Placeholder (default or customized one) will override the Placeholder to indicate the format the date should be entered in. |
TabIndex |
int? |
Maps to the tabindex attribute of the HTML element. You can use it to customize the order in which the inputs in your form focus with the Tab key. |
Title |
string |
The title text rendered in the header of the popup(action sheet). Applicable only when AdaptiveMode is set to Auto. |
ValidateOn |
ValidationEvent enum ( Input) |
Configures the event that will trigger validation (if validation is enabled). Read more at Validation Modes for Simple Inputs. |
Value |
DateTime or DateTime?
|
The current value of the component. Supports two-way binding. |
View |
CalendarView enum ( Month) |
The current view that will be displayed in the popup calendar. |
ShowWeekNumbers |
bool |
Sets if the popup Calendar will display week numbers, according to the ISO-8601 format. Note that the ISO week number may differ from the conventional .NET week number. |
The Date Picker is, essentially, a DateInput and a Calendar and the properties it exposes are mapped to the corresponding properties of these two components. You can read more about their behavior in the respective components' documentation.
Typing User Experience
The component provides multiple parameters, which control the caret placement, two-digit year values and the auto-correct behavior of the textbox. See the DateInput documentation for details.
Styling and Appearance
The following parameters enable you to customize the appearance of the Blazor Date Picker:
| Attribute | Type and Default Value | Description |
|---|---|---|
Class |
string |
The custom CSS class rendered on the wrapping element. |
PopupClass |
string |
An additional CSS class to customize the appearance of the Date Picker's dropdown. |
PopupHeight |
string |
Defines the height of the DatePicker's Popup. Defaults to auto. |
PopupWidth |
string |
Defines the width of the DatePicker's Popup. Defaults to auto. |
Width |
string |
Defines the width of the DatePicker. Defaults to 280px. |
You can find more options for customizing the Date Picker styling in the Appearance article.
Format Placeholder
It is possible to set custom strings as placeholders for each date format segment. This feature is available for the following Telerik UI for Blazor components:
- DateInput
- DatePicker
- DateRangePicker
- DateTimePicker
- TimePicker
To set up the FormatPlaceholder, use the <*Component*FormatPlaceholder> nested tag. It allows you to set format placeholders by using the following parameters:
DayMonthYearHourMinuteSecondWeekday
By default, the value for all parameters is null, which applies the full format specifier.
DatePicker Reference and Methods
Add a reference to the component instance to use the Date Picker's methods.
| Method | Description |
|---|---|
Close |
Closes the Calendar popup. |
FocusAsync |
Focuses the Date Picker textbox. Always await this call, as it relies on JSInterop. |
NavigateTo |
Navigates to a specified date and view. The method expects a DateTime and CalendarView arguments. |
Open |
Opens the Calendar popup. |
Refresh |
Re-renders the Calendar popup. |
<TelerikDatePicker @ref="@DatePickerRef"
@bind-Value="@DatePickerValue"
Width="200px" />
<TelerikButton OnClick="@FocusPicker">Focus DatePicker</TelerikButton>
<TelerikButton OnClick="@OpenPicker">Open DatePicker Calendar</TelerikButton>
@code {
// the component type depends on the value type
private TelerikDatePicker<DateTime> DatePickerRef { get; set; }
private DateTime DatePickerValue { get; set; } = DateTime.Now;
private async Task FocusPicker()
{
await DatePickerRef.FocusAsync();
}
private void OpenPicker()
{
DatePickerRef.Open();
}
}