mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-25 21:56:08 +00:00
420 lines
12 KiB
Plaintext
420 lines
12 KiB
Plaintext
---
|
|
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
|
|
---
|
|
|
|
<ComponentPreview
|
|
name="calendar-demo"
|
|
title="Calendar"
|
|
description="A calendar showing the current date."
|
|
/>
|
|
|
|
## 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
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">CLI</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add calendar
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps>
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install react-day-picker date-fns
|
|
```
|
|
|
|
<Step>Add the `Button` component to your project.</Step>
|
|
|
|
The `Calendar` component uses the `Button` component. Make sure you have it installed in your project.
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource name="calendar" title="components/ui/calendar.tsx" />
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import { Calendar } from "@/components/ui/calendar"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
const [date, setDate] = React.useState<Date | undefined>(new Date())
|
|
|
|
return (
|
|
<Calendar
|
|
mode="single"
|
|
selected={date}
|
|
onSelect={setDate}
|
|
className="rounded-lg border"
|
|
/>
|
|
)
|
|
```
|
|
|
|
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 `<Calendar>` 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"
|
|
```
|
|
|
|
<ComponentPreview
|
|
name="calendar-hijri"
|
|
title="Persian / Hijri / Jalali Calendar"
|
|
description="A Persian calendar."
|
|
/>
|
|
|
|
## Examples
|
|
|
|
### Range Calendar
|
|
|
|
<ComponentPreview
|
|
name="calendar-02"
|
|
title="Range Calendar"
|
|
description="A calendar showing the current date and range selection."
|
|
className="**:[.preview]:h-auto lg:**:[.preview]:h-[450px]"
|
|
/>
|
|
|
|
### Month and Year Selector
|
|
|
|
<ComponentPreview
|
|
name="calendar-13"
|
|
title="Month and Year Selector"
|
|
description="A calendar with month and year dropdowns."
|
|
/>
|
|
|
|
### Date of Birth Picker
|
|
|
|
<ComponentPreview
|
|
name="calendar-22"
|
|
title="Date of Birth Picker"
|
|
description="A calendar with date of birth picker."
|
|
/>
|
|
|
|
### Date and Time Picker
|
|
|
|
<ComponentPreview
|
|
name="calendar-24"
|
|
title="Date and Time Picker"
|
|
description="A calendar with date and time picker."
|
|
/>
|
|
|
|
### Natural Language Picker
|
|
|
|
This component uses the `chrono-node` library to parse natural language dates.
|
|
|
|
<ComponentPreview
|
|
name="calendar-29"
|
|
title="Natural Language Picker"
|
|
description="A calendar with natural language picker."
|
|
/>
|
|
|
|
### Form
|
|
|
|
<ComponentPreview name="calendar-form" />
|
|
|
|
## 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.
|
|
|
|
<CodeCollapsibleWrapper>
|
|
|
|
```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<typeof DayPicker> & {
|
|
buttonVariant?: React.ComponentProps<typeof Button>["variant"]
|
|
}) {
|
|
const defaultClassNames = getDefaultClassNames()
|
|
|
|
return (
|
|
<DayPicker
|
|
showOutsideDays={showOutsideDays}
|
|
className={cn(
|
|
"bg-background group/calendar p-3 [--cell-size:2rem] [[data-slot=card-content]_&]:bg-transparent [[data-slot=popover-content]_&]:bg-transparent",
|
|
String.raw`rtl:**:[.rdp-button\_next>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(
|
|
"group/day relative aspect-square h-full w-full select-none p-0 text-center [&:first-child[data-selected=true]_button]:rounded-l-md [&:last-child[data-selected=true]_button]:rounded-r-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 (
|
|
<div
|
|
data-slot="calendar"
|
|
ref={rootRef}
|
|
className={cn(className)}
|
|
{...props}
|
|
/>
|
|
)
|
|
},
|
|
Chevron: ({ className, orientation, ...props }) => {
|
|
if (orientation === "left") {
|
|
return (
|
|
<ChevronLeftIcon className={cn("size-4", className)} {...props} />
|
|
)
|
|
}
|
|
|
|
if (orientation === "right") {
|
|
return (
|
|
<ChevronRightIcon
|
|
className={cn("size-4", className)}
|
|
{...props}
|
|
/>
|
|
)
|
|
}
|
|
|
|
return (
|
|
<ChevronDownIcon className={cn("size-4", className)} {...props} />
|
|
)
|
|
},
|
|
DayButton: CalendarDayButton,
|
|
WeekNumber: ({ children, ...props }) => {
|
|
return (
|
|
<td {...props}>
|
|
<div className="flex size-[--cell-size] items-center justify-center text-center">
|
|
{children}
|
|
</div>
|
|
</td>
|
|
)
|
|
},
|
|
...components,
|
|
}}
|
|
{...props}
|
|
/>
|
|
)
|
|
}
|
|
|
|
function CalendarDayButton({
|
|
className,
|
|
day,
|
|
modifiers,
|
|
...props
|
|
}: React.ComponentProps<typeof DayButton>) {
|
|
const defaultClassNames = getDefaultClassNames()
|
|
|
|
const ref = React.useRef<HTMLButtonElement>(null)
|
|
React.useEffect(() => {
|
|
if (modifiers.focused) ref.current?.focus()
|
|
}, [modifiers.focused])
|
|
|
|
return (
|
|
<Button
|
|
ref={ref}
|
|
variant="ghost"
|
|
size="icon"
|
|
data-day={day.date.toLocaleDateString()}
|
|
data-selected-single={
|
|
modifiers.selected &&
|
|
!modifiers.range_start &&
|
|
!modifiers.range_end &&
|
|
!modifiers.range_middle
|
|
}
|
|
data-range-start={modifiers.range_start}
|
|
data-range-end={modifiers.range_end}
|
|
data-range-middle={modifiers.range_middle}
|
|
className={cn(
|
|
"data-[selected-single=true]:bg-primary data-[selected-single=true]:text-primary-foreground data-[range-middle=true]:bg-accent data-[range-middle=true]:text-accent-foreground data-[range-start=true]:bg-primary data-[range-start=true]:text-primary-foreground data-[range-end=true]:bg-primary data-[range-end=true]:text-primary-foreground group-data-[focused=true]/day:border-ring group-data-[focused=true]/day:ring-ring/50 flex aspect-square h-auto w-full min-w-[--cell-size] flex-col gap-1 font-normal leading-none data-[range-end=true]:rounded-md data-[range-middle=true]:rounded-none data-[range-start=true]:rounded-md group-data-[focused=true]/day:relative group-data-[focused=true]/day:z-10 group-data-[focused=true]/day:ring-[3px] [&>span]:text-xs [&>span]:opacity-70",
|
|
defaultClassNames.day,
|
|
className
|
|
)}
|
|
{...props}
|
|
/>
|
|
)
|
|
}
|
|
|
|
export { Calendar, CalendarDayButton }
|
|
```
|
|
|
|
</CodeCollapsibleWrapper>
|
|
|
|
**If you have made any changes to the `Calendar` component, you will need to merge your changes with the new version.**
|
|
|
|
Then follow the [React DayPicker](https://daypicker.dev/upgrading) upgrade guide to upgrade your dependencies and 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.
|