Upgrading
Upgrade to v8
DayPicker v8 is a major upgrade for DayPicker with new props and styles. Follow the checklist for a smooth upgrade.
Checklist
- Upgrade the dependency. DayPicker now has date-fns as peer dependency.
- npm
- Yarn
- pnpm
npm install react-day-picker@latest date-fns
yarn add react-day-picker@latest date-fns
pnpm add react-day-picker@latest date-fns
- Remove the types package, if you were using it:
- npm
- Yarn
- pnpm
npm uninstall @types/react-day-picker
yarn remove @types/react-day-picker
pnpm remove @types/react-day-picker
- Update the CSS import:
- import `react-day-picker/lib/style.css`
+ import `react-day-picker/dist/style.css` - Update your custom styles. See the Styling Guide for more information.
- Update the changed props. See the list below.
- Replace
DateUtils
with date-fns. Use date-fns instead of DateUtils to handle dates.- Replace
addDayToRange
with addToRange, which is still exported in v8
- Replace
Updated Props
showWeekNumbers
has been renamed toshowWeekNumber
todayButton
has been removed. See Controlling the current month for an example implementing the same feature.initialMonth
has been renamed todefaultMonth
. See Navigating months for more details about usingmonth
anddefaultMonth
.canChangeMonth
has been renamed todisableNavigation
selectedDays
has been renamed toselected
. See also: Selecting Days guide.disabledDays
has been renamed todisabled
. See also: Disabling days.
ISO weeks
This version use the locale setting to calculate the week days and numbers. The previous versions were using ISO week dates. To toggle the ISO week dates, use the ISOWeek
prop.
DayPickerInput
The DayPickerInput
component has been removed. If you upgrade to v8, you will need to rewrite your implementation:
- See Input Fields Guide for an example
- Please note that
useInput hookhas been deprecated since v8.10.0.