StandaloneEvent API

API reference docs for the React StandaloneEvent component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Event Calendar - Drag Interactions

Import

import { StandaloneEvent } from '@mui/x-scheduler/standalone-event';
// or
import { StandaloneEvent } from '@mui/x-scheduler';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name Type Description

data*

Name	Type	Description
data*	{ allDay?: bool, className?: string, color?: 'amber' \| 'blue' \| 'green' \| 'grey' \| 'indigo' \| 'lime' \| 'orange' \| 'pink' \| 'purple' \| 'red' \| 'teal', description?: string, draggable?: bool, duration?: number, exDates?: Array<string>, extractedFromId?: number \| string, id: number \| string, readOnly?: bool, resizable?: 'end' \| 'start' \| bool, resource?: Array<string> \| string, rrule?: { byDay?: Array<'-1FR' \| '-1MO' \| '-1SA' \| '-1SU' \| '-1TH' \| '-1TU' \| '-1WE' \| '-2FR' \| '-2MO' \| '-2SA' \| '-2SU' \| '-2TH' \| '-2TU' \| '-2WE' \| '-3FR' \| '-3MO' \| '-3SA' \| '-3SU' \| '-3TH' \| '-3TU' \| '-3WE' \| '-4FR' \| '-4MO' \| '-4SA' \| '-4SU' \| '-4TH' \| '-4TU' \| '-4WE' \| '-5FR' \| '-5MO' \| '-5SA' \| '-5SU' \| '-5TH' \| '-5TU' \| '-5WE' \| '1FR' \| '1MO' \| '1SA' \| '1SU' \| '1TH' \| '1TU' \| '1WE' \| '2FR' \| '2MO' \| '2SA' \| '2SU' \| '2TH' \| '2TU' \| '2WE' \| '3FR' \| '3MO' \| '3SA' \| '3SU' \| '3TH' \| '3TU' \| '3WE' \| '4FR' \| '4MO' \| '4SA' \| '4SU' \| '4TH' \| '4TU' \| '4WE' \| '5FR' \| '5MO' \| '5SA' \| '5SU' \| '5TH' \| '5TU' \| '5WE' \| 'FR' \| 'MO' \| 'SA' \| 'SU' \| 'TH' \| 'TU' \| 'WE'>, byMonth?: Array<number>, byMonthDay?: Array<number>, count?: number, freq: 'DAILY' \| 'MONTHLY' \| 'WEEKLY' \| 'YEARLY', interval?: number, until?: string } \| string, timezone?: string, title: string }	The event created when this element is dropped into the Event Calendar.
onEventDrop	func	Callback fired when the event is dropped into the Event Calendar.
sx	Array<func \| object \| bool> \| func \| object	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

{ allDay?: bool, className?: string, color?: 'amber'
| 'blue'
| 'green'
| 'grey'
| 'indigo'
| 'lime'
| 'orange'
| 'pink'
| 'purple'
| 'red'
| 'teal', description?: string, draggable?: bool, duration?: number, exDates?: Array<string>, extractedFromId?: number
| string, id: number
| string, readOnly?: bool, resizable?: 'end'
| 'start'
| bool, resource?: Array<string>
| string, rrule?: { byDay?: Array<'-1FR'
| '-1MO'
| '-1SA'
| '-1SU'
| '-1TH'
| '-1TU'
| '-1WE'
| '-2FR'
| '-2MO'
| '-2SA'
| '-2SU'
| '-2TH'
| '-2TU'
| '-2WE'
| '-3FR'
| '-3MO'
| '-3SA'
| '-3SU'
| '-3TH'
| '-3TU'
| '-3WE'
| '-4FR'
| '-4MO'
| '-4SA'
| '-4SU'
| '-4TH'
| '-4TU'
| '-4WE'
| '-5FR'
| '-5MO'
| '-5SA'
| '-5SU'
| '-5TH'
| '-5TU'
| '-5WE'
| '1FR'
| '1MO'
| '1SA'
| '1SU'
| '1TH'
| '1TU'
| '1WE'
| '2FR'
| '2MO'
| '2SA'
| '2SU'
| '2TH'
| '2TU'
| '2WE'
| '3FR'
| '3MO'
| '3SA'
| '3SU'
| '3TH'
| '3TU'
| '3WE'
| '4FR'
| '4MO'
| '4SA'
| '4SU'
| '4TH'
| '4TU'
| '4WE'
| '5FR'
| '5MO'
| '5SA'
| '5SU'
| '5TH'
| '5TU'
| '5WE'
| 'FR'
| 'MO'
| 'SA'
| 'SU'
| 'TH'
| 'TU'
| 'WE'>, byMonth?: Array<number>, byMonthDay?: Array<number>, count?: number, freq: 'DAILY'
| 'MONTHLY'
| 'WEEKLY'
| 'YEARLY', interval?: number, until?: string }
| string, timezone?: string, title: string }

The event created when this element is dropped into the Event Calendar.

onEventDrop

func

Callback fired when the event is dropped into the Event Calendar.

Array<func
| object
| bool>
| func
| object

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

The ref is forwarded to the root element.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.