wp-calypso/client/components/date-picker/README.md

DatePicker

React component used to display a Date Picker.

---

Example Usage

import { Component } from 'react';
import DatePicker from 'calypso/components/date-picker';

export default class extends Component {
    // ...

    onSelectDay( date ) {
        this.setState( { date: date } );
    }

    render() {
        const events = [
            {
                title: '1 other post scheduled',
                date: new Date( '2015-10-15 10:30' ),
                type: 'scheduled',
                icon: 'time',
            },
            {
                title: 'Happy birthday Damian!',
                date: new Date( '2015-07-18 15:00' ),
                socialIcon: 'path',
            },
        ];

        return (
            <DatePicker
                initialMonth={ new Date( '2015-07-01' ) }
                events={ events }
                onSelectDay={ this.onSelectDay }
                selectedDay={ this.state.date }
            />
        );
    }
}

---

DatePicker

Props

initialMonth - optional Date object that defines the month of the calendar. Default is now.

selectedDay - optional Moment instance to select the current day.

timeReference - optional Moment instance used to adjust the time when a day is selected.

events - optional Array of events.

className - optional Add a custom class property.

onSelectDay - optional Called when day is selected by user.

onMonthChange - optional Called when month is changed by user.

locale - optional String representing the current locale slug (eg: en). Note that the default component exported is already wrapped in the localize HOC which automatically sets this prop for you. Previously this prop was an object of utility overides. This has been moved to a dedicated localUtils prop (see below).

localeUtils - optional Object of locale utility overides which are merged with the default utilities passed into the react-day-picker library. Previously this prop was named locale, but was moved to its own dedicated prop for API consistency with the React Day Picker library.

---