Convert Figma logo to code with AI

wojtekmaj logoreact-date-picker

A date picker for your React app.

1,258
195
1,258
22

Top Related Projects

A simple and reusable datepicker component for React

An easily internationalizable, mobile-friendly datepicker library for the web

Date & Time pickers for Material UI (support from v1 to v4)

React Calendar

DayPicker is a customizable date picker component for React. Add date pickers, calendars, and date inputs to your web applications.

Quick Overview

React-Date-Picker is a lightweight, customizable date picker component for React applications. It provides a simple and intuitive interface for users to select dates, with support for various date formats and localization options.

Pros

  • Easy to integrate with existing React projects
  • Highly customizable appearance and behavior
  • Supports keyboard navigation and accessibility features
  • Lightweight with minimal dependencies

Cons

  • Limited built-in styling options, requiring custom CSS for advanced designs
  • May require additional configuration for complex date selection scenarios
  • Documentation could be more comprehensive for advanced use cases
  • Lacks some advanced features found in larger date picker libraries

Code Examples

  1. Basic usage:
import React, { useState } from 'react';
import DatePicker from 'react-date-picker';

function MyApp() {
  const [value, onChange] = useState(new Date());

  return (
    <div>
      <DatePicker onChange={onChange} value={value} />
    </div>
  );
}
  1. Custom date format:
import React, { useState } from 'react';
import DatePicker from 'react-date-picker';

function MyApp() {
  const [value, onChange] = useState(new Date());

  return (
    <div>
      <DatePicker
        onChange={onChange}
        value={value}
        format="y-MM-dd"
      />
    </div>
  );
}
  1. Disabled dates:
import React, { useState } from 'react';
import DatePicker from 'react-date-picker';

function MyApp() {
  const [value, onChange] = useState(new Date());

  return (
    <div>
      <DatePicker
        onChange={onChange}
        value={value}
        minDate={new Date()}
        maxDate={new Date(2023, 12, 31)}
      />
    </div>
  );
}

Getting Started

  1. Install the package:
npm install react-date-picker
  1. Import and use the component in your React application:
import React, { useState } from 'react';
import DatePicker from 'react-date-picker';
import 'react-date-picker/dist/DatePicker.css';

function App() {
  const [value, onChange] = useState(new Date());

  return (
    <div>
      <DatePicker onChange={onChange} value={value} />
    </div>
  );
}

export default App;

Note: Don't forget to import the CSS file to ensure proper styling.

Competitor Comparisons

A simple and reusable datepicker component for React

Pros of react-datepicker

  • More comprehensive feature set, including time selection and range selection
  • Highly customizable appearance and behavior
  • Larger community and more frequent updates

Cons of react-datepicker

  • Larger bundle size due to more features
  • Steeper learning curve for advanced customizations

Code Comparison

react-datepicker:

import DatePicker from "react-datepicker";

<DatePicker
  selected={startDate}
  onChange={(date) => setStartDate(date)}
  showTimeSelect
  dateFormat="Pp"
/>

react-date-picker:

import DatePicker from "react-date-picker";

<DatePicker
  onChange={setDate}
  value={date}
/>

react-datepicker offers more built-in options like time selection and custom date formatting, while react-date-picker provides a simpler API for basic date picking functionality.

react-datepicker is generally more feature-rich and flexible, but this comes at the cost of a larger bundle size and potentially more complex setup for advanced use cases. react-date-picker, on the other hand, offers a more straightforward implementation for basic date picking needs, with a smaller footprint and simpler API.

The choice between these libraries depends on the specific requirements of your project, such as the need for advanced features, customization options, and bundle size considerations.

An easily internationalizable, mobile-friendly datepicker library for the web

Pros of react-dates

  • More comprehensive date range selection functionality
  • Highly customizable with extensive theming options
  • Better support for internationalization and localization

Cons of react-dates

  • Larger bundle size and more dependencies
  • Steeper learning curve due to more complex API
  • Less frequent updates and maintenance

Code Comparison

react-dates:

import { DateRangePicker } from 'react-dates';

<DateRangePicker
  startDate={this.state.startDate}
  startDateId="start_date_id"
  endDate={this.state.endDate}
  endDateId="end_date_id"
  onDatesChange={({ startDate, endDate }) => this.setState({ startDate, endDate })}
  focusedInput={this.state.focusedInput}
  onFocusChange={focusedInput => this.setState({ focusedInput })}
/>

react-date-picker:

import DatePicker from 'react-date-picker';

<DatePicker
  onChange={this.onChange}
  value={this.state.date}
/>

The code comparison shows that react-dates requires more configuration for a date range picker, while react-date-picker offers a simpler API for single date selection. react-dates provides more flexibility but at the cost of increased complexity, whereas react-date-picker focuses on simplicity and ease of use for basic date picking functionality.

Date & Time pickers for Material UI (support from v1 to v4)

Pros of material-ui-pickers

  • Integrated with Material-UI design system, providing consistent styling
  • Offers a wider range of date/time picker components (e.g., date, time, datetime)
  • Better support for internationalization and localization

Cons of material-ui-pickers

  • Larger bundle size due to Material-UI dependencies
  • Steeper learning curve for developers not familiar with Material-UI
  • Less flexibility for custom styling outside of Material-UI theming

Code Comparison

react-date-picker:

import DatePicker from 'react-date-picker';

function MyApp() {
  const [value, onChange] = useState(new Date());
  return <DatePicker onChange={onChange} value={value} />;
}

material-ui-pickers:

import { DatePicker } from '@material-ui/pickers';

function MyApp() {
  const [selectedDate, handleDateChange] = useState(new Date());
  return <DatePicker value={selectedDate} onChange={handleDateChange} />;
}

Both libraries offer similar basic functionality, but material-ui-pickers provides a more comprehensive set of components and better integration with Material-UI. react-date-picker is lighter and more focused on providing a simple date picker component, while material-ui-pickers offers a broader range of date and time selection tools within the Material-UI ecosystem.

React Calendar

Pros of calendar

  • More comprehensive calendar functionality, including support for various calendar systems (e.g., Gregorian, Chinese, Islamic)
  • Greater customization options for styling and layout
  • Extensive API for advanced use cases and integration with other components

Cons of calendar

  • Steeper learning curve due to more complex API and configuration options
  • Larger bundle size, which may impact performance for simpler use cases
  • Less focused on date picking specifically, requiring more setup for basic date selection

Code Comparison

react-date-picker:

import DatePicker from 'react-date-picker';

function MyApp() {
  const [value, onChange] = useState(new Date());
  return <DatePicker onChange={onChange} value={value} />;
}

calendar:

import Calendar from 'rc-calendar';

function MyApp() {
  const [value, setValue] = useState(moment());
  return (
    <Calendar
      value={value}
      onSelect={(date) => setValue(date)}
      fullscreen={false}
    />
  );
}

The react-date-picker example shows a simpler implementation for basic date picking, while the calendar example demonstrates more configuration options but requires additional setup.

DayPicker is a customizable date picker component for React. Add date pickers, calendars, and date inputs to your web applications.

Pros of react-day-picker

  • More customizable and flexible, allowing for complex date selection scenarios
  • Extensive documentation and examples, making it easier to implement various use cases
  • Supports multiple languages and localization out of the box

Cons of react-day-picker

  • Larger bundle size, which may impact performance in some applications
  • Steeper learning curve due to its extensive API and configuration options

Code Comparison

react-day-picker:

import { DayPicker } from 'react-day-picker';

function MyDatePicker() {
  return <DayPicker mode="single" />;
}

react-date-picker:

import DatePicker from 'react-date-picker';

function MyDatePicker() {
  return <DatePicker onChange={onChange} value={value} />;
}

Both libraries offer simple implementation for basic date picking functionality. However, react-day-picker provides more options for customization and complex scenarios, while react-date-picker focuses on a straightforward, lightweight approach.

react-day-picker is better suited for projects requiring advanced date selection features and extensive customization. On the other hand, react-date-picker is ideal for simpler use cases and projects where minimizing bundle size is a priority.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

npm downloads CI

React-Date-Picker

A date picker for your React app.

  • Pick days, months, years, or even decades
  • Supports virtually any language
  • No moment.js needed

tl;dr

  • Install by executing npm install react-date-picker or yarn add react-date-picker.
  • Import by adding import DatePicker from 'react-date-picker'.
  • Use by adding <DatePicker />. Use onChange prop for getting new values.

Demo

A minimal demo page can be found in sample directory.

Online demo is also available!

Consider native alternative

If you don't need to support legacy browsers and don't need the advanced features this package provides, consider using native date input instead. It's more accessible, adds no extra weight to your bundle, and works better on mobile devices.

<input aria-label="Date" type="date" />

Looking for a time picker or a datetime picker?

React-Date-Picker will play nicely with React-Time-Picker and React-DateTime-Picker. Check them out!

Getting started

Compatibility

Your project needs to use React 16.3 or later. If you use an older version of React, please refer to the table below to find a suitable React-Date-Picker version.

React versionNewest compatible React-Date-Picker version
≥16.8latest
≥16.38.x
≥16.07.x

React-Calendar, on which React-Date-Picker relies heavily, uses modern web technologies. That's why it's so fast, lightweight and easy to style. This, however, comes at a cost of supporting only modern browsers.

Installation

Add React-Date-Picker to your project by executing npm install react-date-picker or yarn add react-date-picker.

Usage

Here's an example of basic usage:

import { useState } from 'react';
import DatePicker from 'react-date-picker';

type ValuePiece = Date | null;

type Value = ValuePiece | [ValuePiece, ValuePiece];

function MyApp() {
  const [value, onChange] = useState<Value>(new Date());

  return (
    <div>
      <DatePicker onChange={onChange} value={value} />
    </div>
  );
}

Custom styling

If you want to use default React-Date-Picker and React-Calendar styling to build upon it, you can import them by using:

import 'react-date-picker/dist/DatePicker.css';
import 'react-calendar/dist/Calendar.css';

User guide

DatePicker

Displays an input field complete with custom inputs, native input, and a calendar.

Props

Prop nameDescriptionDefault valueExample values
autoFocusAutomatically focuses the input on mount.n/atrue
calendarAriaLabelaria-label for the calendar button.n/a"Toggle calendar"
calendarPropsProps to pass to React-Calendar component.n/aSee React-Calendar documentation
calendarIconContent of the calendar button. Setting the value explicitly to null will hide the icon.(default icon)
  • String: "Calendar"
  • React element: <CalendarIcon />
  • React function: CalendarIcon
classNameClass name(s) that will be added along with "react-date-picker" to the main React-Date-Picker <div> element.n/a
  • String: "class1 class2"
  • Array of strings: ["class1", "class2 class3"]
clearAriaLabelaria-label for the clear button.n/a"Clear value"
clearIconContent of the clear button. Setting the value explicitly to null will hide the icon.(default icon)
  • String: "Clear"
  • React element: <ClearIcon />
  • React function: ClearIcon
closeCalendarWhether to close the calendar on value selection. Note: It's recommended to use shouldCloseCalendar function instead.truefalse
data-testiddata-testid attribute for the main React-Date-Picker <div> element.n/a"date-picker"
dayAriaLabelaria-label for the day input.n/a"Day"
dayPlaceholderplaceholder for the day input."--""dd"
disableCalendarWhen set to true, will remove the calendar and the button toggling its visibility.falsetrue
disabledWhether the date picker should be disabled.falsetrue
formatInput format based on Unicode Technical Standard #35. Supported values are: y, M, MM, MMM, MMMM, d, dd. Note: When using SSR, setting this prop may help resolving hydration errors caused by locale mismatch between server and client.n/a"y-MM-dd"
idid attribute for the main React-Date-Picker <div> element.n/a"date-picker"
isOpenWhether the calendar should be opened.falsetrue
localeLocale that should be used by the date picker and the calendar. Can be any IETF language tag. Note: When using SSR, setting this prop may help resolving hydration errors caused by locale mismatch between server and client.Server locale/User's browser settings"hu-HU"
maxDateMaximum date that the user can select. Periods partially overlapped by maxDate will also be selectable, although React-Date-Picker will ensure that no later date is selected.n/aDate: new Date()
maxDetailThe most detailed calendar view that the user shall see. View defined here also becomes the one on which clicking an item in the calendar will select a date and pass it to onChange. Can be "month", "year", "decade" or "century"."month""year"
minDateMinimum date that the user can select. Periods partially overlapped by minDate will also be selectable, although React-Date-Picker will ensure that no earlier date is selected.n/aDate: new Date()
monthAriaLabelaria-label for the month input.n/a"Month"
monthPlaceholderplaceholder for the month input."--""mm"
nameInput name."date""myCustomName"
nativeInputAriaLabelaria-label for the native date input.n/a"Date"
onCalendarCloseFunction called when the calendar closes.n/a() => alert('Calendar closed')
onCalendarOpenFunction called when the calendar opens.n/a() => alert('Calendar opened')
onChangeFunction called when the user picks a valid date. If any of the fields were excluded using custom format, new Date(y, 0, 1, 0, 0, 0), where y is the current year, is going to serve as a "base".n/a(value) => alert('New date is: ', value)
onFocusFunction called when the user focuses an input.n/a(event) => alert('Focused input: ', event.target.name)
onInvalidChangeFunction called when the user picks an invalid date.n/a() => alert('Invalid date')
openCalendarOnFocusWhether to open the calendar on input focus. Note: It's recommended to use shouldOpenCalendar function instead.truefalse
portalContainerElement to render the calendar in using portal.n/adocument.getElementById('my-div')
requiredWhether date input should be required.falsetrue
returnValueWhich dates shall be passed by the calendar to the onChange function and onClick{Period} functions. Can be "start", "end" or "range". The latter will cause an array with start and end values to be passed."start""range"
shouldCloseCalendarFunction called before the calendar closes. reason can be "buttonClick", "escape", "outsideAction", or "select". If it returns false, the calendar will not close.n/a({ reason }) => reason !== 'outsideAction'
shouldOpenCalendarFunction called before the calendar opens. reason can be "buttonClick" or "focus". If it returns false, the calendar will not open.n/a({ reason }) => reason !== 'focus'
showLeadingZerosWhether leading zeros should be rendered in date inputs.falsetrue
valueInput value. Note that if you pass an array of values, only first value will be fully utilized.n/a
  • Date: new Date(2017, 0, 1)
  • String: "2017-01-01"
  • An array of dates: [new Date(2017, 0, 1), new Date(2017, 7, 1)]
  • An array of strings: ["2017-01-01", "2017-08-01"]
yearAriaLabelaria-label for the year input.n/a"Year"
yearPlaceholderaria-label for the year input."----""yyyy"

Calendar

DatePicker component passes all props to React-Calendar, with the exception of className (you can use calendarClassName for that instead). There are tons of customizations you can do! For more information, see Calendar component props.

License

The MIT License.

Author

Wojciech Maj Wojciech Maj

Thank you

Sponsors

Thank you to all our sponsors! Become a sponsor and get your image on our README on GitHub.

Backers

Thank you to all our backers! Become a backer and get your image on our README on GitHub.

Top Contributors

Thank you to all our contributors that helped on this project!

Top Contributors

NPM DownloadsLast 30 Days