React component

This page offers documentation for using the Schedule-X calendar in React. For general documentation on configuring and interacting with the calendar, refer to the rest of the calendar documentation.

Installing

In this example we will set up a calendar with the default theme, and a plugin for retrieving and updating events.

npm


  npm install @schedule-x/react @schedule-x/calendar @schedule-x/theme-default @schedule-x/events-service

pnpm


  pnpm install @schedule-x/react @schedule-x/calendar @schedule-x/theme-default @schedule-x/events-service @preact/signals preact

yarn


  yarn add @schedule-x/react @schedule-x/calendar @schedule-x/theme-default @schedule-x/events-service @preact/signals preact

Basic usage

Example

React


import { useCalendarApp, ScheduleXCalendar } from '@schedule-x/react'
import {
  createViewDay,
  createViewMonthAgenda,
  createViewMonthGrid,
  createViewWeek,
} from '@schedule-x/calendar'
import { createEventsServicePlugin } from '@schedule-x/events-service'
 
import '@schedule-x/theme-default/dist/index.css'
 
function CalendarApp() {
  const eventsService = useState(() => createEventsServicePlugin())[0]
 
  const calendar = useCalendarApp({
    views: [createViewDay(), createViewWeek(), createViewMonthGrid(), createViewMonthAgenda()],
    events: [
      {
        id: '1',
        title: 'Event 1',
        start: '2023-12-16',
        end: '2023-12-16',
      },
    ],
    plugins: [eventsService]
  })
 
  useEffect(() => {
    // get all events
    eventsService.getAll()
  }, [])
 
  return (
    <div>
      <ScheduleXCalendar calendarApp={calendar} />
    </div>
  )
}
 
export default CalendarApp

Styles

The Schedule-X calendar is a responsive component. To achieve this, it cannot be delivered with a fixed height or width of its own. You need to define the height and width of the wrapping element .sx-react-calendar-wrapper according to your needs. For a regular desktop application, something like this might do the trick for you:


.sx-react-calendar-wrapper {
  width: 1200px;
  max-width: 100vw;
  height: 800px;
  max-height: 90vh;
}

Custom components

The Schedule-X calendar is built with customization in mind. Currently, you can use the following custom components to take control over certain parts of the calendar. This is done by writing your own React components:

Slot / Component name	Description	Props
`timeGridEvent`	The component for timed events used in the week- and day views	`calendarEvent`
`dateGridEvent`	The component for all-day events used in the week- and day views	`calendarEvent`
`weekGridDate`	Replaces the day name and date in the header of day- and week views	`date`
`weekGridHour`	Replaces the hour in the time axis of day- and week views	`hour`
`monthGridEvent`	The component for events used in the month grid view	`calendarEvent`, `hasStartDate`
`monthGridDayName`	Replaces day names like “Mon”, “Tue” in month grid	`day` (0-6, like in JS-dates)
`monthGridDate`	Replaces date of month in month grid	`date`, `jsDate`
`monthAgendaEvent`	The component for events used in the month agenda view	`calendarEvent`
`eventModal`	The component for the modal that opens when clicking an event	`calendarEvent`
`headerContentLeftPrepend`	Prepends content to the left part of the header	`$app`
`headerContentLeftAppend`	Appends content to the left part of the header	`$app`
`headerContentRightPrepend`	Prepends content to the right part of the header	`$app`
`headerContentRightAppend`	Appends content to the right part of the header	`$app`
`headerContent`	Replaces the whole header content	`$app`
`sidebarAddEventButton`	”Add event” button in the sidebar plugin	`onClick`
`resourceEvent`	Event element in resource scheduler	`calendarEvent`, `resource`

An example of how to use these components can be found here: https://github.com/schedule-x/react-example/blob/main/src/App.tsx

Visual overview of all components

More examples

A repo with more examples can be found here:

https://github.com/schedule-x/react-examples