--- title: Calendar description: A date field component that allows users to enter and edit date. component: true links: doc: https://react-day-picker.js.org --- ## Blocks We have built a collection of 30+ calendar blocks that you can use to build your own calendar components. See all calendar blocks in the [Blocks Library](/blocks/calendar) page. ## Installation CLI Manual ```bash npx shadcn@latest add calendar ``` Install the following dependencies: ```bash npm install react-day-picker date-fns ``` Add the `Button` component to your project. The `Calendar` component uses the `Button` component. Make sure you have it installed in your project. Copy and paste the following code into your project. Update the import paths to match your project setup. ## Usage ```tsx showLineNumbers import { Calendar } from "@/components/ui/calendar" ``` ```tsx showLineNumbers const [date, setDate] = React.useState(new Date()) return ( ) ``` See the [React DayPicker](https://react-day-picker.js.org) documentation for more information. ## About The `Calendar` component is built on top of [React DayPicker](https://react-day-picker.js.org). ## Customization See the [React DayPicker](https://react-day-picker.js.org/docs/customization) documentation for more information on how to customize the `Calendar` component. ## Date Picker You can use the `` component to build a date picker. See the [Date Picker](/docs/components/date-picker) page for more information. ## Persian / Hijri / Jalali Calendar To use the Persian calendar, edit `components/ui/calendar.tsx` and replace `react-day-picker` with `react-day-picker/persian`. ```diff - import { DayPicker } from "react-day-picker" + import { DayPicker } from "react-day-picker/persian" ``` ## Selected Date (With TimeZone) The Calendar component accepts a `timeZone` prop to ensure dates are displayed and selected in the user's local timezone. ```tsx showLineNumbers export function CalendarWithTimezone() { const [date, setDate] = React.useState(undefined) const [timeZone, setTimeZone] = React.useState(undefined) React.useEffect(() => { setTimeZone(Intl.DateTimeFormat().resolvedOptions().timeZone) }, []) return ( ) } ``` **Note:** If you notice a selected date offset (for example, selecting the 20th highlights the 19th), make sure the `timeZone` prop is set to the user's local timezone. **Why client-side?** The timezone is detected using `Intl.DateTimeFormat().resolvedOptions().timeZone` inside a `useEffect` to ensure compatibility with server-side rendering. Detecting the timezone during render would cause hydration mismatches, as the server and client may be in different timezones. ## Examples ### Range Calendar ### Month and Year Selector ### Date of Birth Picker ### Date and Time Picker ### Natural Language Picker This component uses the `chrono-node` library to parse natural language dates. ### Custom Cell Size You can customize the size of calendar cells using the `--cell-size` CSS variable. You can also make it responsive by using breakpoint-specific values: ```tsx showLineNumbers ``` Or use fixed values: ```tsx showLineNumbers ``` ## Upgrade Guide ### Tailwind v4 If you're already using Tailwind v4, you can upgrade to the latest version of the `Calendar` component by running the following command: ```bash npx shadcn@latest add calendar ``` When you're prompted to overwrite the existing `Calendar` component, select `Yes`. **If you have made any changes to the `Calendar` component, you will need to merge your changes with the new version.** This will update the `Calendar` component and `react-day-picker` to the latest version. Next, follow the [React DayPicker](https://daypicker.dev/upgrading) upgrade guide to upgrade your existing components to the latest version. #### Installing Blocks After upgrading the `Calendar` component, you can install the new blocks by running the `shadcn@latest add` command. ```bash npx shadcn@latest add calendar-02 ``` This will install the latest version of the calendar blocks. ### Tailwind v3 If you're using Tailwind v3, you can upgrade to the latest version of the `Calendar` by copying the following code to your `calendar.tsx` file. ```tsx showLineNumbers title="components/ui/calendar.tsx" "use client" import * as React from "react" import { ChevronDownIcon, ChevronLeftIcon, ChevronRightIcon, } from "lucide-react" import { DayButton, DayPicker, getDefaultClassNames } from "react-day-picker" import { cn } from "@/lib/utils" import { Button, buttonVariants } from "@/components/ui/button" function Calendar({ className, classNames, showOutsideDays = true, captionLayout = "label", buttonVariant = "ghost", formatters, components, ...props }: React.ComponentProps & { buttonVariant?: React.ComponentProps["variant"] }) { const defaultClassNames = getDefaultClassNames() return ( svg]:rotate-180`, String.raw`rtl:**:[.rdp-button\_previous>svg]:rotate-180`, className )} captionLayout={captionLayout} formatters={{ formatMonthDropdown: (date) => date.toLocaleString("default", { month: "short" }), ...formatters, }} classNames={{ root: cn("w-fit", defaultClassNames.root), months: cn( "relative flex flex-col gap-4 md:flex-row", defaultClassNames.months ), month: cn("flex w-full flex-col gap-4", defaultClassNames.month), nav: cn( "absolute inset-x-0 top-0 flex w-full items-center justify-between gap-1", defaultClassNames.nav ), button_previous: cn( buttonVariants({ variant: buttonVariant }), "h-[--cell-size] w-[--cell-size] select-none p-0 aria-disabled:opacity-50", defaultClassNames.button_previous ), button_next: cn( buttonVariants({ variant: buttonVariant }), "h-[--cell-size] w-[--cell-size] select-none p-0 aria-disabled:opacity-50", defaultClassNames.button_next ), month_caption: cn( "flex h-[--cell-size] w-full items-center justify-center px-[--cell-size]", defaultClassNames.month_caption ), dropdowns: cn( "flex h-[--cell-size] w-full items-center justify-center gap-1.5 text-sm font-medium", defaultClassNames.dropdowns ), dropdown_root: cn( "has-focus:border-ring border-input shadow-xs has-focus:ring-ring/50 has-focus:ring-[3px] relative rounded-md border", defaultClassNames.dropdown_root ), dropdown: cn("absolute inset-0 opacity-0", defaultClassNames.dropdown), caption_label: cn( "select-none font-medium", captionLayout === "label" ? "text-sm" : "[&>svg]:text-muted-foreground flex h-8 items-center gap-1 rounded-md pl-2 pr-1 text-sm [&>svg]:size-3.5", defaultClassNames.caption_label ), table: "w-full border-collapse", weekdays: cn("flex", defaultClassNames.weekdays), weekday: cn( "text-muted-foreground flex-1 select-none rounded-md text-[0.8rem] font-normal", defaultClassNames.weekday ), week: cn("mt-2 flex w-full", defaultClassNames.week), week_number_header: cn( "w-[--cell-size] select-none", defaultClassNames.week_number_header ), week_number: cn( "text-muted-foreground select-none text-[0.8rem]", defaultClassNames.week_number ), day: cn( "relative w-full h-full p-0 text-center [&:last-child[data-selected=true]_button]:rounded-r-md group/day aspect-square select-none", props.showWeekNumber ? "[&:nth-child(2)[data-selected=true]_button]:rounded-l-md" : "[&:first-child[data-selected=true]_button]:rounded-l-md", defaultClassNames.day ), range_start: cn( "bg-accent rounded-l-md", defaultClassNames.range_start ), range_middle: cn("rounded-none", defaultClassNames.range_middle), range_end: cn("bg-accent rounded-r-md", defaultClassNames.range_end), today: cn( "bg-accent text-accent-foreground rounded-md data-[selected=true]:rounded-none", defaultClassNames.today ), outside: cn( "text-muted-foreground aria-selected:text-muted-foreground", defaultClassNames.outside ), disabled: cn( "text-muted-foreground opacity-50", defaultClassNames.disabled ), hidden: cn("invisible", defaultClassNames.hidden), ...classNames, }} components={{ Root: ({ className, rootRef, ...props }) => { return (
) }, Chevron: ({ className, orientation, ...props }) => { if (orientation === "left") { return ( ) } if (orientation === "right") { return ( ) } return ( ) }, DayButton: CalendarDayButton, WeekNumber: ({ children, ...props }) => { return (
{children}
) }, ...components, }} {...props} /> ) } function CalendarDayButton({ className, day, modifiers, ...props }: React.ComponentProps) { const defaultClassNames = getDefaultClassNames() const ref = React.useRef(null) React.useEffect(() => { if (modifiers.focused) ref.current?.focus() }, [modifiers.focused]) return (