> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/shadcn-ui/ui/llms.txt
> Use this file to discover all available pages before exploring further.

# Calendar

> A date calendar component for date selection.

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npx shadcn@latest add calendar
  ```

  ```bash yarn theme={null}
  yarn dlx shadcn@latest add calendar
  ```

  ```bash pnpm theme={null}
  pnpm dlx shadcn@latest add calendar
  ```
</CodeGroup>

## Usage

```tsx theme={null}
import { Calendar } from "@/components/ui/calendar"
```

```tsx theme={null}
const [date, setDate] = React.useState<Date | undefined>(new Date())

<Calendar
  mode="single"
  selected={date}
  onSelect={setDate}
/>
```

## Component Code

The Calendar component is built on top of `react-day-picker` and provides extensive customization options.

```tsx theme={null}
"use client"

import * as React from "react"
import { ChevronLeftIcon, ChevronRightIcon } from "lucide-react"
import { DayPicker } from "react-day-picker"
import { cn } from "@/lib/utils"
import { buttonVariants } from "@/components/ui/button"

function Calendar({
  className,
  classNames,
  showOutsideDays = true,
  captionLayout = "label",
  buttonVariant = "ghost",
  ...props
}: React.ComponentProps<typeof DayPicker> & {
  buttonVariant?: "ghost" | "outline" | "default"
}) {
  return (
    <DayPicker
      showOutsideDays={showOutsideDays}
      captionLayout={captionLayout}
      className={cn("p-3", className)}
      classNames={{
        months: "flex flex-col sm:flex-row gap-4",
        month: "gap-4",
        caption: "flex justify-center pt-1 relative items-center",
        caption_label: "text-sm font-medium",
        nav: "flex items-center",
        nav_button: cn(
          buttonVariants({ variant: buttonVariant }),
          "h-7 w-7 bg-transparent p-0 opacity-50 hover:opacity-100"
        ),
        table: "w-full border-collapse",
        head_row: "flex",
        head_cell: "text-muted-foreground rounded-md w-8 font-normal text-[0.8rem]",
        row: "flex w-full mt-2",
        cell: cn(
          "relative p-0 text-center text-sm focus-within:relative focus-within:z-20 [&:has([aria-selected])]:bg-accent",
          props.mode === "range"
            ? "[&:has(>.day-range-end)]:rounded-r-md [&:has(>.day-range-start)]:rounded-l-md first:[&:has([aria-selected])]:rounded-l-md last:[&:has([aria-selected])]:rounded-r-md"
            : "[&:has([aria-selected])]:rounded-md"
        ),
        day: cn(
          buttonVariants({ variant: "ghost" }),
          "h-8 w-8 p-0 font-normal aria-selected:opacity-100"
        ),
        day_selected:
          "bg-primary text-primary-foreground hover:bg-primary hover:text-primary-foreground focus:bg-primary focus:text-primary-foreground",
        day_today: "bg-accent text-accent-foreground",
        day_outside: "text-muted-foreground opacity-50",
        day_disabled: "text-muted-foreground opacity-50",
        day_range_middle:
          "aria-selected:bg-accent aria-selected:text-accent-foreground",
        day_hidden: "invisible",
        ...classNames,
      }}
      components={{
        IconLeft: () => <ChevronLeftIcon className="h-4 w-4" />,
        IconRight: () => <ChevronRightIcon className="h-4 w-4" />,
      }}
      {...props}
    />
  )
}

export { Calendar }
```

## Examples

<Tabs>
  <Tab title="Single Date">
    Select a single date.

    ```tsx theme={null}
    const [date, setDate] = React.useState<Date | undefined>(new Date())

    <Calendar
      mode="single"
      selected={date}
      onSelect={setDate}
    />
    ```
  </Tab>

  <Tab title="Date Range">
    Select a range of dates.

    ```tsx theme={null}
    const [dateRange, setDateRange] = React.useState<DateRange | undefined>()

    <Calendar
      mode="range"
      selected={dateRange}
      onSelect={setDateRange}
    />
    ```
  </Tab>

  <Tab title="Multiple Dates">
    Select multiple dates.

    ```tsx theme={null}
    const [dates, setDates] = React.useState<Date[] | undefined>([])

    <Calendar
      mode="multiple"
      selected={dates}
      onSelect={setDates}
    />
    ```
  </Tab>

  <Tab title="With Disabled Dates">
    Disable specific dates or date ranges.

    ```tsx theme={null}
    const [date, setDate] = React.useState<Date | undefined>()

    <Calendar
      mode="single"
      selected={date}
      onSelect={setDate}
      disabled={[
        { from: new Date(2024, 0, 1), to: new Date(2024, 0, 7) },
        new Date(2024, 0, 15)
      ]}
    />
    ```
  </Tab>
</Tabs>

## Modes

The Calendar component supports different selection modes:

* `single` - Select a single date
* `multiple` - Select multiple dates
* `range` - Select a date range
* `default` - No selection

## API Reference

### Calendar

The Calendar component accepts all props from `react-day-picker` plus:

| Prop              | Type                                                       | Default   |
| ----------------- | ---------------------------------------------------------- | --------- |
| `mode`            | `"single" \| "multiple" \| "range" \| "default"`           | -         |
| `selected`        | `Date \| Date[] \| DateRange`                              | -         |
| `onSelect`        | `(date) => void`                                           | -         |
| `disabled`        | `Date \| Date[] \| DateRange \| ((date: Date) => boolean)` | -         |
| `showOutsideDays` | `boolean`                                                  | `true`    |
| `captionLayout`   | `"label" \| "dropdown" \| "dropdown-buttons"`              | `"label"` |
| `buttonVariant`   | `"ghost" \| "outline" \| "default"`                        | `"ghost"` |
| `className`       | `string`                                                   | -         |

For more props and detailed documentation, see the [react-day-picker documentation](https://react-day-picker.js.org/).