Big Calendar

gcal/outlook like calendar component

Date & timeReact
jquense/react-big-calendarjquense.github.io/react-big-calendar/examples/index.htmlreact-big-calendar

README

react-big-calendar


An events calendar component built for React and made for modern browsers (read: not IE) and uses flexbox over the classic tables-caption approach.

Big Calendar Demo Image


[DEMO and Docs](https://jquense.github.io/react-big-calendar/examples/index.html)

Inspired by Full Calendar.

Use and Setup


yarn add react-big-calendar or npm install --save react-big-calendar

Include react-big-calendar/lib/css/react-big-calendar.css for styles, and make sure your calendar's container
element has a height, or the calendar won't be visible. To provide your own custom styling, see the Custom Styling topic.

Starters


- react-big-calendar
- react-big-calendar with drag and drop
- react-big-calendar with TypeScript and React hooks bundled with Vite

Run examples locally


  1. ```sh
  2. $ git clone git@github.com:jquense/react-big-calendar.git
  3. $ cd react-big-calendar
  4. $ yarn
  5. $ yarn examples
  6. ```

- Open localhost:3000/examples/index.html.

Localization and Date Formatting


react-big-calendar includes three options for handling the date formatting and culture localization, depending
on your preference of DateTime libraries. You can use either the Moment.js, Globalize.js or date-fns localizers.

Regardless of your choice, you must choose a localizer to use this library:

Moment.js


  1. ``` js
  2. import { Calendar, momentLocalizer } from 'react-big-calendar'
  3. import moment from 'moment'

  5. const localizer = momentLocalizer(moment)

  7. const MyCalendar = (props) => (
  8.   <div>
  9.     <Calendar
  10.       localizer={localizer}
  11.       events={myEventsList}
  12.       startAccessor="start"
  13.       endAccessor="end"
  14.       style={{ height: 500 }}
  15.     />
  16.   </div>
  17. )
  18. ```

Globalize.js v0.1.1


  1. ``` js
  2. import { Calendar, globalizeLocalizer } from 'react-big-calendar'
  3. import globalize from 'globalize'

  5. const localizer = globalizeLocalizer(globalize)

  7. const MyCalendar = (props) => (
  8.   <div>
  9.     <Calendar
  10.       localizer={localizer}
  11.       events={myEventsList}
  12.       startAccessor="start"
  13.       endAccessor="end"
  14.       style={{ height: 500 }}
  15.     />
  16.   </div>
  17. )
  18. ```

date-fns v2


  1. ``` js
  2. import { Calendar, dateFnsLocalizer } from 'react-big-calendar'
  3. import format from 'date-fns/format'
  4. import parse from 'date-fns/parse'
  5. import startOfWeek from 'date-fns/startOfWeek'
  6. import getDay from 'date-fns/getDay'
  7. import enUS from 'date-fns/locale/en-US'

  9. const locales = {
  10.   'en-US': enUS,
  11. }

  13. const localizer = dateFnsLocalizer({
  14.   format,
  15.   parse,
  16.   startOfWeek,
  17.   getDay,
  18.   locales,
  19. })

  21. const MyCalendar = (props) => (
  22.   <div>
  23.     <Calendar
  24.       localizer={localizer}
  25.       events={myEventsList}
  26.       startAccessor="start"
  27.       endAccessor="end"
  28.       style={{ height: 500 }}
  29.     />
  30.   </div>
  31. )
  32. ```

Custom Styling


Out of the box, you can include the compiled CSS files and be up and running. But, sometimes, you may want to style
Big Calendar to match your application styling. For this reason, SASS files are included with Big Calendar.

  1. ```
  2.   @import 'react-big-calendar/lib/sass/styles';
  3.   @import 'react-big-calendar/lib/addons/dragAndDrop/styles'; // if using DnD
  4. ```

SASS implementation provides a variables file containing color and sizing variables that you can
update to fit your application. _Note:_ Changing and/or overriding styles can cause rendering issues with your
Big Calendar. Carefully test each change accordingly.

Join us on Reactiflux Discord


Join us on Reactiflux Discord community under the channel #libraries if you have any questions.