React Date Picker Component Overview

    The Ignite UI for React Date Picker is a feature rich component used for entering a date through manual text input or choosing date values from a calendar dialog that pops up. Lightweight and simple to use, the Date Picker lets users navigate to a desired date with several view options – month, year, and decade. It also supports common validation properties such as minimum and maximum date constraints and required fields.

    The Ignite UI for React Date Picker Component lets users pick a single date through a month-view calendar dropdown or editable input field. The React Date Picker also supports a dialog mode for selection from the calendar only, locale-aware and customizable date formatting and validation integration.

    [!NOTE] The IgrDatePicker is a brand new component from Ignite UI for React version 18.7.0. The old IgrDatePicker prior to this version has been renamed to XDatePicker and its respective documentation page can be found under "Deprecated Components"

    React Date Picker Example

    Below you can see a sample that demonstrates how the Date Picker works when users are enabled to pick a date through a manual text input and click on the calendar icon on the left to navigate to it. See how to render it.

    Getting Started with React Date Picker

    First, you need to install the Ignite UI for React by running the following command:

    npm install igniteui-react

    You will then need to import the IgrDatePicker, its necessary CSS, and register its module, like so:

    import { IgrDatePicker, IgrDatePickerModule } from 'igniteui-react';
import 'igniteui-webcomponents/themes/light/bootstrap.css';

IgrDatePickerModule.register();

    For a complete introduction to the Ignite UI for React, read the Getting Started topic.

    Using the React Date Picker Component

    Display Date Picker

    To instantiate a IgrDatePicker in its default dropdown state, use the following code:

    <IgrDatePicker></IgrDatePicker>

    Options

    The IgrDatePicker can be bound to a date.

    const DatePicker = document.querySelector('igc-date-picker') as IgcDatePickerComponent;
const date = new Date();

DatePicker.value = date;

    datePickerRef.current.value = new Date();

    Projecting components

    With prefix and suffix slots we can add different content before and after the main content of the Input.

    <IgrDatePicker>
    <IgrIcon 
        slot="suffix" 
        name="arrow_upward" 
        collection="material" 
        class="small" 
        onClick={() => datePickerRef.current.stepUp(DatePart.Month)}>
    </IgrIcon>
</IgrDatePicker>

    The above snippet will add an additional icon at the end of the input, right after the default clear icon. This will not remove the default toggle icon, though as prefixes and suffixes can be stacked one after the other.

    Customizing the toggle and clear icons

    The calendar and clear icon could be templated by using the calendar and clear slots:

    <IgrDatePicker>
    <IgrIcon slot="calendar" name="calendar" collection="material" class="small"></IgrIcon>
    <IgrIcon slot="clear" name="delete" collection="material" class="small"></IgrIcon>
</IgrDatePicker>

    Custom action buttons

    The picker's action buttons can be templated using the actions slot:

    <IgrDatePicker>
    <IgrButton 
        slot='actions' 
        onClick={() => datePickerRef.current.showWeekNumbers = true}>
        <span>Show Week Numbers</span>
    </IgrButton>
</IgrDatePicker>

    Keyboard Navigation

    The IgrDatePicker has intuitive keyboard navigation that makes it easy to increment, decrement, or jump through different DateParts among others without having to touch the mouse.

    Keys Description
    ← Move one character to the beginning
    → Move one character to the end
    Home Move to the beginning
    End Move to the end
    Ctrl / Command + ← Move to the beginning of the date/time section - current one or left one
    Ctrl / Command + → Move to the end of the date/time section - current on or right one
    Focus on a date/time part + ↓ Decrements a date/time part
    Focus on a date/time part + ↑ Increments a date/time part
    Ctrl / Command + ; Sets the current date/time as the value of the editor
    Esc Closes the calendar pop-up and focuses the input field

    Examples

    Dialog Mode

    The IgrDatePicker also supports a dialog mode:

    <IgrDatePicker mode="dialog"></IgrDatePicker>

    Display and input format

    inputFormat and displayFormat are properties which can be set to make the picker's editor follow a specified format. The inputFormat is locale based, so if none is provided, the picker will default to the one used by the browser.

    A good thing to note is that the Date Picker Component will always add a leading zero on the date and month portions if they were provided in a format that does not have it, e.g. d/M/yy becomes dd/MM/yy. This applies only during editing.

    displayFormat is used to format the picker's input when it is not focused. If no displayFormat is provided, the picker will use the inputFormat as its displayFormat.

    More information about these can be found in the IgrDateTimeInput format section.

    Increment and decrement

    The IgrDatePicker exposes stepUp and stepDown methods. Both of which come from the IgrDateTimeInput and can be used for incrementing and decrementing a specific DatePart of the currently set date.

    <IgrDatePicker>
    <IgrIcon 
        slot="prefix" 
        name="arrow_upward" 
        collection="material" 
        onClick={() => datePickerRef.current.stepUp(DatePart.Month)}>
    </IgrIcon>
    <IgrIcon 
        slot="suffix" 
        name="arrow_downward" 
        collection="material" 
        onClick={() => datePickerRef.current.stepDown(DatePart.Month)}>
    </IgrIcon>
</IgrDatePicker>

    In Forms

    The IgrDatePicker could be used in a form element, the component's min and max properties act as form validators.

    In forms, we can handle the change event of the component and update the value of the label.

    Calendar Specific settings

    The IgrDatePicker can modify some of the calendar's settings via the properties that the Date Picker exposes. Some of these include visibleMonths which allows more than one calendar to be displayed when the picker expands, weekStart which determines the starting day of the week, showWeekNumbers which shows the number for each week in the year and more.

    Internationalization

    The localization of the IgrDatePicker can be controlled through its locale input.

    Here is how a IgrDatePicker with Japanese locale definition would look like:

    <IgrDatePicker locale="ja-JP"></IgrDatePicker>

    Styling

    The IgrDatePicker component derives from the IgrInput and IgrCalendar component, so it exposes all available CSS parts. See Input Styling and Calendar Styling for reference.

    igc-date-picker::part(header) {
  background-color: var(--ig-primary-500);
  color: var(--ig-primary-500-contrast);
}
igc-date-picker::part(calendar-content) {
  background-color: var(--ig-surface-300);
}
igc-date-picker::part(date-inner current) {
  color: var(--ig-info-300);
  background-color: var(--ig-surface-300);
}
igc-date-picker::part(navigation-button):hover,
igc-date-picker::part(months-navigation):hover,
igc-date-picker::part(years-navigation):hover {
  color: var(--ig-secondary-500);
}
igc-date-picker::part(month-inner current),
igc-date-picker::part(year-inner current),
igc-date-picker::part(navigation-button),
igc-date-picker::part(months-navigation),
igc-date-picker::part(years-navigation) {
  color: var(--ig-info-300);
}
igc-date-picker::part(date-inner selected),
igc-date-picker::part(month-inner selected),
igc-date-picker::part(year-inner selected) {
  color: var(--ig-secondary-500-contrast);
  background-color: var(--ig-secondary-500);
}

    API References

    Additional Resources