Getting Started

If you are using any of the following frameworks, you can start by checking out their respective setup guides:

1. Install

We will start by downloading the calendar and its theme.

npm i @schedule-x/calendar @schedule-x/theme-default

2. Setup

After downloading and importing our dependencies, we can create an instance of the calendar using the createCalendar function. This function takes two arguments:

The configuration object
An array of plugins

Here we will start by only adding the config. The calendar is then rendered using the render method.

import { createCalendar, createViewMonthGrid } from '@schedule-x/calendar'
import '@schedule-x/theme-default/dist/index.css'
 
const calendar = createCalendar({
  views: [createViewMonthGrid()],
  events: [
    {
      id: 1,
      title: 'Coffee with John',
      start: '2023-12-04 10:05',
      end: '2023-12-04 10:35',
    },
  ],
})
 
calendar.render(document.getElementById('calendar'))

Configuration object

As a bare minimum, the configuration object needs two things:

A list of views. Currently available views are month grid, week, day and month agenda.
A list of events.

Style & theme

CSS of wrapping element

You will need to decide on the styles of the element wrapping the calendar. This will depend on your use case. For many use cases, something like this should suffice:

#calendar {
  width: 100%;
  height: 800px;
  max-height: 90vh;
}

Theme

The calendar renders to light mode by default. If you want, you can either override this default through configuration, or set the theme programmatically:

const calendar = createCalendar(/***/)
 
calendar.setTheme('dark')
// or
calendar.setTheme('light')

Usage over CDN

For testing purposes, or if you're in a setup that predates modern build tools, you can use the calendar over a CDN like this:

<!doctype html>
<html class="no-js" lang="">
 
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
 
  <!-- Do not change the order of these dependencies, since some of them depend on others -->
  <script src="https://cdn.jsdelivr.net/npm/preact@10.23.2/dist/preact.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/preact@10.23.2/hooks/dist/hooks.umd.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/@preact/signals-core@1.8.0/dist/signals-core.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/@preact/signals@1.3.0/dist/signals.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/preact@10.23.2/jsx-runtime/dist/jsxRuntime.umd.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/preact@10.23.2/compat/dist/compat.umd.js"></script>
 
  <script src="https://cdn.jsdelivr.net/npm/@schedule-x/calendar@2.2.0/dist/core.umd.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/@schedule-x/drag-and-drop@2.2.0/dist/core.umd.js"></script>
 
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@schedule-x/theme-default@2.2.0/dist/index.css">
</head>
 
<body>
  <div class="calendar"></div>
 
  <script type="module">
    const { createCalendar, viewWeek } = window.SXCalendar;
    const { createDragAndDropPlugin } = window.SXDragAndDrop;
 
    const plugins = [
      createDragAndDropPlugin(),
    ]
 
    const calendar = createCalendar({
      views: [viewWeek],
      events: [
        {
          id: '1',
          title: 'Event 1',
          start: '2024-08-23 09:00',
          end: '2024-08-23 10:00'
        },
      ],
    }, plugins)
 
    calendar.render(document.querySelector('.calendar'))
  </script>
</body>
 
</html>

Configuration