Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zackify/react-calendar

Simple and flexible events calendar written in React
https://github.com/zackify/react-calendar

calendar event-calendar events react

Last synced: 26 days ago
JSON representation

Simple and flexible events calendar written in React

Awesome Lists containing this project

README 

        
# React Calendar



100% test coverage, responsive, and flexible event calendar for React.



[See In Action](https://zackify.github.io/react-calendar/?path=/story/monthly-calendar--basic-monthly-calendar)



Backstory: After using react-big-calendar for years, I decided to create my own that is simpler to use, allows for easy customization, and uses modern React (no deprecated methods).



```

npm install @zach.codes/react-calendar date-fns

```



- [Basic Usage](#Basic-Usage)

- [Styling](#Styling)

- [Monthly Calendar](#MonthlyCalendar)

- [Weekly Calendar](#WeeklyCalendar)

- [Full Control](#Full-Control)



## Basic Usage



[See this code in action](https://zackify.github.io/react-calendar/?path=/story/monthly-calendar--basic-monthly-calendar)



```tsx

import { format, subHours, startOfMonth } from 'date-fns';

import {

  MonthlyBody,

  MonthlyDay,

  MonthlyCalendar,

  MonthlyNav,

  DefaultMonthlyEventItem,

} from '@zach.codes/react-calendar';



export const MyMonthlyCalendar = () => {

  let [currentMonth, setCurrentMonth] = useState(

    startOfMonth(new Date())

  );



  return (

     setCurrentMonth(date)}

    >

      

      

        

          renderDay={data =>

            data.map((item, index) => (

              

            ))

          }

        />

      

    

  );

};

```



This renders a monthly calendar view in its simplest form. Whenever a user presses `next` or `previous` on the `` the `onCurrentMonthChange` callback will be invoked, and it's up to you to control the state.



This approach gives you full flexibilty to do anything you want. In my applications, I will refetch a graphql query anytime the month changes, and load `events` for that month.



The events get passed into `MonthlyBody` and then `renderDay` is called for every day on the calendar that has events. You can render any React component you wish, giving you as much freedom as possible.



## Styling



This library uses [Tailwind](https://tailwindcss.com/). This gives you two options for including the necessary CSS for the components.



### I'm already using Tailwind



Awesome! You need to add `node_modules/@zach.codes/react-calendar/dist/**/*.js` to your `tailwind.config.js` to ensure the required classes aren't purged on your production build.



### I'm not using Tailwind



No problem! The library includes the minimal CSS required to render the components. Somewhere in your app, you need to import our CSS:



```js

import '@zach.codes/react-calendar/dist/calendar-tailwind.css';

```



If you already have a CSS reset in your app, you can import from:



```js

import '@zach.codes/react-calendar/dist/calendar-tailwind-no-reset.css';

```



But some styles may not look the same as storybook. You can take the resets you want from the main file and put them into your app to get the styling you prefer.



## MonthlyCalendar



This is a monthly view similar to react-big-calendar or a Calendar application. It makes it easy to load events 1 month at a time, and render custom elements on each day.



[See in action](https://zackify.github.io/react-calendar/?path=/story/monthly-calendar--basic-monthly-calendar)



### Props



`MonthlyCalendar`



- `currentMonth` this must be a Date instance representing the first of the month you wish to view

- `onCurrentMonthChange` is called any time the month is changing from the Navigation area



`MonthlyNav`



No props at this time



`MonthlyBody`



- `omitDays` lets you hide certain days from the calendar, for instance, hide Saturday and Sunday. Days are represented as 0-6, as seen in the [date-fns](https://date-fns.org/v2.19.0/docs/getDay#returns) documentation. Hiding Monday would be `omitDays={[1]}` Hiding the weekend would be `omitDays={[0, 6]}`

- `events` this is an array of events, the only thing required inside each object is a `date` field with a Date object representing the exact time of the event



`MonthlyDay`



- `renderDay` callback function that is passed an array of events for each day displayed, letting you render the events for the day



## WeeklyCalendar



View 1 week at a time, useful for scheduling appointments, or rendering events in a smaller area of the screen



[See in action](https://zackify.github.io/react-calendar/?path=/story/weekly-calendar--basic-weekly-calendar)



```js



  

    

     (

        

      )}

    />

  



```



This code renders an event for the current date. When you are in the week view, it displays the day and time. When you drill into a single day, it displays the time only.



### Props



`WeeklyCalendar`



- `week` a date object to initialize for the weekly view



`WeeklyContainer`



A view only component to flex the buttons and content area



`WeeklyDays`



Renders the buttons to view an individual day



- `omitDays`, same as the `MonthlyBody` prop



`WeeklyBody`



- `style` optional style info for setting the container height

- `events` array of events with a date field, and anything else you want.

- `renderItem` callback to render individual items on the side.



## Full Control



This library has very few props to understand. It takes a component-first approach instead of endless prop options.



Building a calendar is highly opinionated. This library lets you easily customize any piece of it. Let's take a look at the `MonthlyNav` component:



```tsx

import { useMonthlyCalendar } from '@zach.codes/react-calendar';



export const MonthlyNav = () => {

  let { currentMonth, onCurrentMonthChange } = useMonthlyCalendar();



  return (

    


       onCurrentMonthChange(subMonths(currentMonth, 1))}

        className="cursor-pointer"

      >

        Previous

      

      


        {format(

          currentMonth,

          getYear(currentMonth) === getYear(new Date()) ? 'LLLL' : 'LLLL yyyy'

        )}

      


       onCurrentMonthChange(addMonths(currentMonth, 1))}

        className="cursor-pointer"

      >

        Next

      

    


  );

};

```



It's rendering some button elements, and then the current month. If it's not the current year, it renders the year as well.



You can copy / paste this component into your own repo. The magic piece is `useMonthlyCalendar`. This hook will let you access anything from the calendar context.



With this in mind, you can fully replace any of the default components to have custom behavior for your own app.