Calendar

Usage

import { Calendar } from '@heroui/react';

Anatomy

import {Calendar} from '@heroui/react';

export default () => (
  <Calendar aria-label="Event date">
    <Calendar.Header>
      <Calendar.Heading />
      <Calendar.NavButton slot="previous" />
      <Calendar.NavButton slot="next" />
    </Calendar.Header>
    <Calendar.Grid>
      <Calendar.GridHeader>
        {(day) => <Calendar.HeaderCell>{day}</Calendar.HeaderCell>}
      </Calendar.GridHeader>
      <Calendar.GridBody>
        {(date) => <Calendar.Cell date={date} />}
      </Calendar.GridBody>
    </Calendar.Grid>
  </Calendar>
)

Examples

Disabled

Read Only

Default Value

Year Picker

Calendar.YearPickerTrigger, Calendar.YearPickerGrid, and their body/cell subcomponents provide an integrated year navigation pattern.

Controlled

Use controlled value and focusedValue for external state coordination and custom shortcuts.

Min and Max Dates

Unavailable Dates

Use isDateUnavailable to block dates such as weekends, holidays, or booked slots.

Weeks in Month

Set weeksInMonth to a fixed value (for example, 6) to keep the grid height stable when navigating between months. Use with care in non-Gregorian locales, similar to firstDayOfWeek.

Week View

Set visibleDuration={{ weeks: n }} to show one or more weeks at a time. Navigation advances by the visible week range. Use pageBehavior="single" to move one week at a time when showing multiple weeks.

Day View

Set visibleDuration={{ days: n }} to show a rolling window of consecutive days. Navigation advances by the visible day range. Use pageBehavior="single" to move one day at a time when showing multiple days.

Multiple Selection

Set selectionMode="multiple" to let users select several dates. value, defaultValue, and onChange use an array of dates.

Focused Value

Programmatically control which date is focused using focusedValue and onFocusChange.

Cell Indicators

You can customize Calendar.Cell children and use Calendar.CellIndicator to display metadata like events.

Custom Navigation Icons

Pass children to Calendar.NavButton to replace the default chevron icons.

Multiple Months

Render multiple grids with visibleDuration and offset for booking and planning experiences.

Real-World Example

International Calendars

By default, Calendar displays dates using the calendar system for the user's locale. You can override this by wrapping your Calendar with I18nProvider and setting the Unicode calendar locale extension.

The example below shows the Indian calendar system:

Note: The onChange event always returns a date in the same calendar system as the value or defaultValue (Gregorian if no value is provided), regardless of the displayed locale. This ensures your application logic works consistently with a single calendar system while still displaying dates in the user's preferred format.

Customization

Tailwind CSS

Global CSS

@layer components {
  .calendar {
    @apply w-72 rounded-2xl border border-border bg-surface p-3 shadow-sm;
  }

  .calendar__heading {
    @apply text-sm font-semibold text-default-700;
  }

  .calendar__cell[data-selected="true"] {
    @apply bg-accent text-accent-foreground;
  }
}

Styling Reference

HeroUI follows the BEM methodology to ensure component variants and states are reusable and easy to customize.

CSS Classes

Calendar uses these classes in packages/styles/components/calendar.css and packages/styles/components/calendar-year-picker.css:

• .calendar - Root container.
• .calendar__header - Header row containing nav buttons and heading.
• .calendar__heading - Current month label.
• .calendar__nav-button - Previous/next navigation controls.
• .calendar__grid - Main day grid.
• .calendar__grid-header - Weekday header row wrapper.
• .calendar__grid-body - Date rows wrapper.
• .calendar__header-cell - Weekday header cell.
• .calendar__cell - Interactive day cell.
• .calendar__cell-indicator - Dot indicator inside a day cell.
• .calendar-year-picker__trigger - Year picker toggle button.
• .calendar-year-picker__trigger-heading - Heading text inside year picker trigger.
• .calendar-year-picker__trigger-indicator - Indicator icon inside year picker trigger.
• .calendar-year-picker__year-grid - Overlay grid of selectable years.
• .calendar-year-picker__year-cell - Individual year option.

Interactive States

Calendar supports both pseudo-classes and React Aria data attributes:

• Selected: [data-selected="true"]
• Today: [data-today="true"]
• Unavailable: [data-unavailable="true"]
• Outside month: [data-outside-month="true"]
• Hovered: :hover or [data-hovered="true"]
• Pressed: :active or [data-pressed="true"]
• Focus visible: :focus-visible or [data-focus-visible="true"]
• Disabled: :disabled or [data-disabled="true"]

API Reference

Calendar

Calendar inherits all props from React Aria Calendar.

Composition Parts

Year Picker Parts

Year picker subcomponents inherit formatting props from React Aria useCalendarHeading and useCalendarYearPicker.

Calendar.Cell Render Props

When Calendar.Cell children is a function, React Aria render props are available:

For a complete list of supported calendar systems and their identifiers, see:

• React Aria Calendar Implementations
• React Aria International Calendars

Related packages

• @internationalized/date — date types (CalendarDate, CalendarDateTime, ZonedDateTime) and utilities used by all date components
• I18nProvider — override locale for a subtree
• useLocale — read the current locale and layout direction

Related Components