@types/react-big-calendar

What is @types/react-big-calendar?

@types/react-big-calendar provides TypeScript definitions for the react-big-calendar package, which is a powerful and flexible calendar component for React applications. It allows developers to create and manage events in a calendar view, supporting various views like month, week, day, and agenda.

What are @types/react-big-calendar's main functionalities?

Basic Calendar Setup

This code sets up a basic calendar using react-big-calendar with moment.js as the date localizer. It initializes the calendar with no events and sets the height to 500 pixels.

import { Calendar, momentLocalizer } from 'react-big-calendar';
import moment from 'moment';
import 'react-big-calendar/lib/css/react-big-calendar.css';

const localizer = momentLocalizer(moment);

const MyCalendar = () => (
  <Calendar
    localizer={localizer}
    events={[]}
    startAccessor="start"
    endAccessor="end"
    style={{ height: 500 }}
  />
);

Adding Events

This code demonstrates how to add events to the calendar. The events array contains objects with title, start, and end properties, which are then passed to the Calendar component.

const events = [
  {
    title: 'Meeting',
    start: new Date(2023, 9, 20, 10, 0),
    end: new Date(2023, 9, 20, 12, 0)
  },
  {
    title: 'Lunch',
    start: new Date(2023, 9, 21, 12, 0),
    end: new Date(2023, 9, 21, 13, 0)
  }
];

const MyCalendar = () => (
  <Calendar
    localizer={localizer}
    events={events}
    startAccessor="start"
    endAccessor="end"
    style={{ height: 500 }}
  />
);

Customizing Event Appearance

This code shows how to customize the appearance of events in the calendar. The eventStyleGetter function returns a style object based on the event's title, which is then applied to the events in the calendar.

const eventStyleGetter = (event, start, end, isSelected) => {
  let backgroundColor = event.title === 'Meeting' ? 'blue' : 'green';
  let style = {
    backgroundColor: backgroundColor,
    borderRadius: '0px',
    opacity: 0.8,
    color: 'white',
    border: '0px',
    display: 'block'
  };
  return {
    style: style
  };
};

const MyCalendar = () => (
  <Calendar
    localizer={localizer}
    events={events}
    startAccessor="start"
    endAccessor="end"
    style={{ height: 500 }}
    eventPropGetter={eventStyleGetter}
  />
);

Other packages similar to @types/react-big-calendar

fullcalendar

FullCalendar is a popular JavaScript calendar library that provides a full-sized, drag-and-drop calendar. It is highly customizable and supports a wide range of features, including different view types, recurring events, and time zone support. Compared to react-big-calendar, FullCalendar offers more built-in features and a more polished UI but may require more configuration.

react-calendar

React-Calendar is a lightweight calendar component for React that focuses on simplicity and ease of use. It provides basic calendar functionalities like selecting dates and navigating between months. While it is not as feature-rich as react-big-calendar, it is easier to integrate and use for simple calendar needs.

react-datepicker

React-Datepicker is a simple and customizable date picker component for React. It allows users to select dates and times and provides various customization options. While it is not a full-fledged calendar component like react-big-calendar, it is useful for applications that require date selection without the complexity of a full calendar view.

README

Installation

npm install --save @types/react-big-calendar

Summary

This package contains type definitions for react-big-calendar (https://github.com/jquense/react-big-calendar).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-big-calendar.

Additional Details

• Last updated: Fri, 22 Nov 2024 23:34:01 GMT
• Dependencies: @types/date-arithmetic, @types/prop-types, @types/react

Credits

These definitions were written by Piotr Witek, Austin Turner, Krzysztof Bezrąk, Sebastian Silbermann, Paul Potsides, janb87, Panagiotis Rikarnto Siavelis, Lucas Silva Souza, Siarhey Belofost, Mark Nelissen, Paito Anderson, Jan Michalak, Tom Price, Daniele Carrucciu, Chris Frewin, and decimoseptimo.