API Reference
Use this reference to inspect the exported APIs for DayPicker and its calendar packages. Start with @daypicker/react for the core component API, then use the calendar package pages when you import a calendar-specific DayPicker.
Packages
| Package | Use it for |
|---|---|
| @daypicker/react | Core DayPicker exports: the React component, props, custom component contracts, hooks, utilities, formatters, labels, and shared types. |
| @daypicker/buddhist | Buddhist calendar exports, including the Thai calendar DayPicker component, locale constants, and date-library helpers. |
| @daypicker/ethiopic | Ethiopic calendar exports, including the Ethiopic DayPicker component, locale constants, and date-library helpers. |
| @daypicker/hebrew | Hebrew calendar exports, including the Hebrew DayPicker component, locale constants, and date-library helpers. |
| @daypicker/hijri | Hijri calendar exports, including the Umm al-Qura DayPicker component, locale constants, and date-library helpers. |
| @daypicker/persian | Persian calendar exports, including the Jalali DayPicker component, locale constants, and date-library helpers. |
Common Tasks
- Configure the calendar with DayPicker and DayPickerProps.
- Customize rendered elements with Components and CustomComponents.
- Translate labels and formatted text with Labels and Formatters.
- Use a calendar package when you need its calendar-specific DayPicker, locales, or date-library helpers.
Components
Component contracts live in @daypicker/react. Use the Components group to inspect the default renderers and CustomComponents to see which components can be replaced with the components prop.