@fullcalendar/common

What is @fullcalendar/common?

@fullcalendar/common is a core package for the FullCalendar library, which provides a highly customizable and feature-rich calendar component for web applications. It includes utilities and base components that are used to build various calendar views and functionalities.

What are @fullcalendar/common's main functionalities?

Rendering a Basic Calendar

This code demonstrates how to render a basic calendar using the @fullcalendar/common package. It initializes a calendar with a month view and renders it in the specified HTML element.

import { Calendar } from '@fullcalendar/common';

const calendarEl = document.getElementById('calendar');
const calendar = new Calendar(calendarEl, {
  initialView: 'dayGridMonth'
});
calendar.render();

Adding Events

This code sample shows how to add events to the calendar. The events array contains objects with event details such as title, start date, and end date.

import { Calendar } from '@fullcalendar/common';

const calendarEl = document.getElementById('calendar');
const calendar = new Calendar(calendarEl, {
  initialView: 'dayGridMonth',
  events: [
    { title: 'Event 1', start: '2023-10-01' },
    { title: 'Event 2', start: '2023-10-05', end: '2023-10-07' }
  ]
});
calendar.render();

Customizing Event Appearance

This example demonstrates how to customize the appearance of events by setting properties like color. Each event object can have additional properties to control its look and feel.

import { Calendar } from '@fullcalendar/common';

const calendarEl = document.getElementById('calendar');
const calendar = new Calendar(calendarEl, {
  initialView: 'dayGridMonth',
  events: [
    { title: 'Event 1', start: '2023-10-01', color: 'red' },
    { title: 'Event 2', start: '2023-10-05', end: '2023-10-07', color: 'blue' }
  ]
});
calendar.render();

Other packages similar to @fullcalendar/common

react-big-calendar

react-big-calendar is a similar package that provides a calendar component for React applications. It offers a range of views (month, week, day) and supports event handling. Compared to @fullcalendar/common, react-big-calendar is more tightly integrated with React and may be easier to use in React projects.

tui-calendar

tui-calendar is a JavaScript calendar library that provides various views and features like drag-and-drop, recurring events, and customizable themes. It is similar to @fullcalendar/common in terms of functionality but offers a different API and styling options.

fullcalendar

fullcalendar is the main package that includes @fullcalendar/common along with other modules for different views and functionalities. It provides a comprehensive solution for calendar needs in web applications, with extensive customization options and a wide range of features.

README

FullCalendar Common

internal package

View the docs »

This package was created from the FullCalendar monorepo »

Changelog

5.0.0-beta.3 (2020-05-20)

Changes since beta.2:

• features:
  • the @fullcalendar/react plugin now uses React's real virtual DOM engine
  • typescript definitions for every part of the API. baked in, so won't fall out of date.
  • console warnings when given unknown options/props/listeners
• minor API changes:
  • windowResize and datesDidUpdate now receive an arg with a ViewApi object
  • eventSourceSuccess, eventSourceFailure, and moreLinkClick can't be attached using .on()
• distribution:
  • working sourcemaps in all packages (#4719)
  • the fullcalendar and fullcalendar-scheduler bundles
    • are published as browser-globals only. no longer published as UMDs
    • now include the Google Calendar connector in their main files
    • don't provide copies of the other non-bundled plugins anymore (like rrule, moment, moment-timezone)
    • both receive locale/locale-all entrypoints that will be automatically connected when loaded
• fixes:
  • Week numbers are not clickable as navLinks (#5427)
  • Events of different heights in the same resource can be positioned incorrectly (#5413)
  • Events displayed on wrong date when pushed down by previous events that span multiple days (#5408)
  • textColor setting in Event Object not working anymore (#5355)
  • resourceAreaWidth is not updated when changed with setOption (#5368)
  • JS error when printing timeline view with expandRows (#5399)
  • fixed Scheduler license keys not working with fullcalendar-scheduler bundle