v4.2.12

Calendar

Display inline calendar to pick single date or dates range
Import
Source
View source code
Docs
Edit this page
Package
@mantine/dates

Usage

Calendar component:

Mo
Tu
We
Th
Fr
Sa
Su
import { useState } from 'react';
import { Calendar } from '@mantine/dates';


function Demo() {
  const [value, setValue] = useState(null);
  return <Calendar value={value} onChange={setValue} />;
}

RangeCalendar component (supports the same props as Calendar component):

Mo
Tu
We
Th
Fr
Sa
Su
import { useState } from 'react';
import { RangeCalendar } from '@mantine/dates';


function Demo() {
  const [value, setValue] = useState<[Date | null, Date | null]>([
    new Date(2021, 11, 1),
    new Date(2021, 11, 5),
  ]);


  return <RangeCalendar value={value} onChange={setValue} />;
}

Multiple selected dates

Set multiple on Calendar component to allow multiple dates selection:

Mo
Tu
We
Th
Fr
Sa
Su
import { useState } from 'react';
import { Calendar } from '@mantine/dates';


function Demo() {
  const [value, setValue] = useState<Date[]>([]);
  return <Calendar multiple value={value} onChange={setValue} />;
}

Custom day renderer

You can provide your own day renderer function with renderDay prop. For example, it can be used to wrap day with Indicator:

Mo
Tu
We
Th
Fr
Sa
Su
import { useState } from 'react';
import { Calendar } from '@mantine/dates';
import { Indicator } from '@mantine/core';


function Demo() {
  const [value, setValue] = useState(null);


  return (
    <Group position="center">
      <Calendar
        value={value}
        onChange={setValue}
        renderDay={(date) => {
          const day = date.getDate();
          return (
            <Indicator size={6} color="red" offset={8} disabled={day !== 16}>
              <div>{day}</div>
            </Indicator>
          );
        }}
      />
    </Group>
  );
}

Controlled month

Control month that is currently displayed with month and onMonthChange props:

import { useState } from 'react';
import { Calendar } from '@mantine/dates';


function Demo() {
  const [month, onMonthChange] = useState(new Date());
  return <Calendar month={month} onMonthChange={onMonthChange} />;
}

Alternatively, set initialMonth prop to set initial month in uncontrolled component:

<Calendar initialMonth={new Date()} />

Level change

Calendar supports three levels: date, month and year. User can access next level by clicking label between next/previous controls. To disable that, set allowLevelChange prop to false:

Mo
Tu
We
Th
Fr
Sa
Su
import { Calendar } from '@mantine/dates';


function Demo() {
  return <Calendar allowLevelChange={false} />;
}

Localization

All @mantine/dates components are built with dayjs library. Default locale is en, to change this follow dayjs localization guide:

// First import locale data
import 'dayjs/locale/ru';

Then set locale prop in component:

Пн
Вт
Ср
Чт
Пт
Сб
Вс
import 'dayjs/locale/ru';
import { useState } from 'react';
import { Calendar } from '@mantine/dates';


function Demo() {
  const [value, setValue] = useState(null);
  return <Calendar value={value} onChange={setValue} locale="ru" />;
}

First day of the week

Change first day of week with firstDayOfWeek prop. It accepts either sunday or monday as values:

Su
Mo
Tu
We
Th
Fr
Sa
import { Calendar } from '@mantine/dates';


function Demo() {
  return <Calendar firstDayOfWeek="sunday" />;
}

Multiple months

Mo
Tu
We
Th
Fr
Sa
Su
Mo
Tu
We
Th
Fr
Sa
Su
Demo is not available, increase viewport size to see it
import { Calendar } from '@mantine/dates';


function Demo() {
  return <Calendar amountOfMonths={2} />;
}

Label format

By default, Calendar will display dates in human-readable format. To change that, provide dayjs format string to the labelFormat prop:

Mo
Tu
We
Th
Fr
Sa
Su
import { useState } from 'react';
import { Calendar } from '@mantine/dates';


function Demo() {
  const [value, setValue] = useState(null);
  return <Calendar value={value} onChange={setValue} labelFormat="MM/YYYY" />;
}

Min and max dates

Set minDate and maxDate props to define minimum and maximum possible dates. Dates which are not included in available interval will be disabled:

Mo
Tu
We
Th
Fr
Sa
Su
import dayjs from 'dayjs';
import { useState } from 'react';
import { Calendar } from '@mantine/dates';


function Demo() {
  const [value, setValue] = useState(null);


  return (
    <Calendar
      value={value}
      onChange={setValue}
      minDate={dayjs(new Date()).startOf('month').add(5, 'days').toDate()}
      maxDate={dayjs(new Date()).endOf('month').subtract(5, 'days').toDate()}
    />
  );
}

Exclude dates

To exclude dates set excludeDate prop with function that receives date as an argument and returns true if date should be disabled. For example, to disable weekends, check if date day is 0 or 6:

Mo
Tu
We
Th
Fr
Sa
Su
import { useState } from 'react';
import { Calendar } from '@mantine/dates';


function Demo() {
  const [value, setValue] = useState(null);
  return (
    <Calendar
      value={value}
      onChange={setValue}
      excludeDate={(date) => date.getDay() === 0 || date.getDay() === 6}
    />
  );
}

Render day as props

You can render a custom component with renderDay. The function receives one argument:

  • date – date object which is used to render day component

Add styles to days

You can apply styles to any day with dayStyle or dayClassName callbacks. Both functions receive two arguments:

  • date – date object which is used to render day component
  • modifiers – modifiers that are applied to the day component

Modifiers

interface DayModifiers {
  /** Is date selected and is first or last in range? */
  selectedInRange: boolean;


  /** Is date equal to value? */
  selected: boolean;


  /** Based on minDate, maxDate, excludeDate and disableOutsideEvents props */
  disabled: boolean;


  /** Is date is range? */
  inRange: boolean;


  /** Is date first or last in given range? */
  firstInRange: boolean;
  lastInRange: boolean;


  /** Is date Saturday or Sunday? */
  weekend: boolean;


  /** Is date outside of given month? */
  outside: boolean;
}

Styles based on date

dayStyle callback allows you to add inline styles to days. Function must return either styles object or null. In this example, we will add red background to each Friday 13th based on date (first argument):

Mo
Tu
We
Th
Fr
Sa
Su
import { useMantineTheme } from '@mantine/core';
import { Calendar } from '@mantine/dates';


function Demo() {
  const theme = useMantineTheme();


  return (
    <Calendar
      initialMonth={new Date(2021, 7)}
      dayStyle={(date) =>
        date.getDay() === 5 && date.getDate() === 13
          ? { backgroundColor: theme.colors.red[9], color: theme.white }
          : null
      }
    />
  );
}

Styles based on modifiers

dayClassName callback allows you to add className to days. Function must return either className string or null. In this example, we will hide all outside dates and change color of weekends based on modifiers (second argument):

Mo
Tu
We
Th
Fr
Sa
Su
import { createStyles } from '@mantine/core';
import { Calendar } from '@mantine/dates';


const useStyles = createStyles((theme) => ({
  outside: {
    opacity: 0,
  },


  weekend: {
    color: `${theme.colors.blue[6]} !important`,
  },
}));




function Demo() {
  const { classes, cx } = useStyles();


  return (
    <Calendar
      disableOutsideEvents
      initialMonth={new Date(2021, 7)}
      dayClassName={(date, modifiers) =>
        cx({ [classes.outside]: modifiers.outside, [classes.weekend]: modifiers.weekend })
      }
    />
  );
}

Customize with styles API

To customize any part of the calendar use Styles API:

Mo
Tu
We
Th
Fr
Sa
Su
import { useState } from 'react';
import { Calendar } from '@mantine/dates';


function Demo() {
  const [value, setValue] = useState(new Date());


  return (
    <Calendar
      value={value}
      onChange={setValue}
      month={value}
      fullWidth
      size="xl"
      styles={(theme) => ({
        cell: {
          border: `1px solid ${
            theme.colorScheme === 'dark' ? theme.colors.dark[4] : theme.colors.gray[2]
          }`,
        },
        day: { borderRadius: 0, height: 70, fontSize: theme.fontSizes.lg },
        weekday: { fontSize: theme.fontSizes.lg },
        weekdayCell: {
          fontSize: theme.fontSizes.xl,
          backgroundColor:
            theme.colorScheme === 'dark' ? theme.colors.dark[5] : theme.colors.gray[0],
          border: `1px solid ${
            theme.colorScheme === 'dark' ? theme.colors.dark[4] : theme.colors.gray[2]
          }`,
          height: 70,
        },
      })}
    />
  );
}
Go back
Getting started – @mantine/dates
Up next
DatePicker – @mantine/dates
Build fully functional accessible web applications faster than ever
About
ContributeMedia assetsChangelogReleases
Community
Chat on DiscordFollow on TwitterFollow on GithubGitHub discussions
Project
Mantine UIDocumentationGithub organizationnpm organization
Built by Vitaly Rtishchev and these awesome people
Join Discord community
Follow Mantine on Twitter