General

Getting Started Quick Install Using with Cordova Using with Ionic Using with Meteor Using with ES Modules Mobiscroll CLI Working with the Source Instance Customizing the Look and Feel Upgrade From Trial Utility functions Unit Testing Update version Upgrade Guide v5

Date & Time pickers

Date & Time

Usage Options Events Methods Localization Theming

Event Calendar

Usage Options Events Methods Localization Theming

Form components

Alerts & Notifications

Alert Confirm Prompt Toast Snackbar

Buttons

Usage Options Theming

Checkbox

Usage Options Theming

Dropdown Radio Buttons

Usage Options Theming

Segmented

Usage Options Theming

Stepper

Usage Options Theming

Switch

Usage Options Theming

Textfields

Usage Options Theming

Pickers & dropdowns

Select

Usage Options Events Methods Localization Theming

Page layout Tools

Icons Language Modules

Accessibility

Section 508 WAI-ARIA Support Keyboard Support RTL Support

This version of the documentation is outdated. Check the latest version here!

Event Calendar

Basic usage

The following example will create an event calendar with the default options.

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  return <Eventcalendar />;
}

For many more examples - simple and complex use-cases - check out the event calendar demos for react.

Data binding

The event calendar accepts an array of event objects through the data option of the component. The event array can be either a local static array, or populated on demand with remote requests.

Local data

To bind local data to the event calendar, you can simply assign a JavaScript array of objects to the data option of the component.

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([{
    start: new Date(2020, 2, 18, 8, 0),
    end: new Date(2020, 2, 18, 17, 0),
    title: 'My First Event'
  }, {
    start: new Date(2020, 2, 18, 9, 0),
    end: new Date(2020, 2, 20, 13, 0),
    title: 'My Second Event'
  }]);
  return <Eventcalendar data={events} />;
}

Remote data

You can load the data through an external request and assign it to the data option of the component.

JSX

import { Eventcalendar, getJson } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([]);

  useEffect(() => {
    getJson('https://example.com/events/', (events) => {
      setEvents(events);
    });
  }, []);

  return <Eventcalendar data={events} />;
}

Load on demand

Use the onPageLoading event to load the data relevant to the currently active view. The event fires every time the date range of the view changes, for example when someone navigates the event calendar. Getting the events in real time as the user interacts with the UI improves load performance and always serves the most recent data.

You can pass the view variables - like month and year - in the URL and handle the filtering inside the API implmentation.

JSX

import { Eventcalendar, getJson } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([]);

  const onPageLoading = useCallback((event, inst) => {
    const fromDay = event.firstDay.toISOString();
    const toDay = event.lastDay.toISOString();

    getJson('https://example.com/events?from=' + fromDay + '&to=' + toDay), (events) => {
      setEvents(events);
    });
  }, []);

  return <Eventcalendar data={events} onPageLoading={onPageLoading} />;
}

Recurrence

For the data, colors, labels, marked, and invalid options it's possible to specify recurrence rules. The rule can be an object or a string in RRULE format.

Supported properties:

repeatString - The frequency of the recurrence. String equivalent: FREQ.
- 'daily' - Daily repeat
- 'weekly' - Weekly repeat
- 'monthly' - Monthly repeat
- 'yearly' - Yearly repeat
dayNumber - The day of the month in case of monthly and yearly repeat. String equivalent: BYMONTHDAY.
Negative numbers are calculated from the end of the month, -1 meaning the last day of the month.
Specifying multiple days for the rule is currently not supported.

Rules like every first/second/third/fourth week day of month are currently not supported.
monthNumber - Specify the month in case of yearly repeat. String equivalent: BYMONTH.
Specifying multiple months for the rule is currently not supported.
weekDaysString - Comma separated list of the week days ('SU', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA') for the occurrences. String equivalent: BYDAY.
weekStartString - Specifies the first day of the week ('SU', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA'). Default is 'MO'. String equivalent: WKST.
countNumber - The number of occurrences. String equivalent: COUNT.
fromDate, String, Object - The start date of the occurrences. String equivalent: DTSTART.
until:Date, String, Object - The end date of the occurrences. String equivalent: UNTIL.
intervalNumber - The time interval for the rule, e.g. every 3 days, or every 2 weeks. This depends on the repeat property. String equivalent: INTERVAL.

In string format the specified properties are separated by the ';' character.

As object

recurring: {
  repeat: 'daily',
  count: 5,
  interval: 2
}

As string

recurring: 'FREQ=DAILY;COUNT=5;INTERVAL=2'

Examples

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
    const [events, setEvents] = useState([{
        start: new Date(2020, 2, 18, 9, 0),
        end: new Date(2020, 2, 18, 17, 0),
        title: 'Repeat every 2 days 5 times',
        recurring: {
            repeat: 'daily',
            count: 5,
            interval: 2
        }
    }, {
        start: new Date(2020, 2, 17, 20, 0),
        end: new Date(2020, 2, 17, 22, 0),
        title: 'Football training every Monday and Wednesday',
        recurring: 'FREQ=WEEKLY;UNTIL=2020-06-17;BYDAY=MO,WE'
    }, {
        title: 'Pay the bills - on every first Friday of the months',
        recurring: {
            repeat: 'monthly',
            pos: 1,
            weekDays: 'FR',
        }   
    }]);
    return <Eventcalendar data={events} />;
}

Recurring exceptions

In case you would like to skip some dates from your rule, that's when the recurring exception come in handy. You can either set specific dates and/or a recurring rule as an exception, using the recurringException and the recurringExceptionRule properties.

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
    const [events, setEvents] = useState([{
        start: '2021-06-01',
        allDay: true,
        title: 'Repeat every day until the end of 2021, except every month\'s 15th',
        recurring: {
            repeat: 'daily',
            until: '2021-12-31'
        },
        // exact dates as exceptions
        recurringException: ['2021-07-10', '2021-07-11'],
        // recurring rule as an exception
        recurringExceptionRule: {
            repeat: 'monthly',
            day: 15
        }
    }, {
        start: '08:30',
        end: '10:00',
        title: 'Meeting every Monday and Friday, except every second month\'s 3rd',
        recurring: 'FREQ=WEEKLY;UNTIL=2021-06-01;BYDAY=MO,FR',
        recurringExceptionRule: 'FREQ=MONTHLY;BYMONTHDAY=3;INTERVAL=2'
    }]);
    return <Eventcalendar data={events} />;
}

In case you drag & drop an event on the calendar which is an occurrence of a recurring event, a new event will be created for the moved or resized event and the occurrence date will be added as a recurring exception to the original recurring event.

CRUD actions

The event calendar is bound to an array of events. Since the React component only compares the props by reference, when you are modifying the events (create, update, delete), you need to pass a new array which contains the updated data.

Here's an example for adding, removing, and updating an event.

JSX

import { Eventcalendar } from '@mobiscroll/react';

let guid = 0;

const App = () => {
  const [events, setEvents] = useState([{
    start: new Date(2020, 2, 18, 8, 0),
    end: new Date(2020, 2, 18, 17, 0),
    title: 'My First Event'
  }, {
    start: new Date(2020, 2, 18, 9, 0),
    end: new Date(2020, 2, 20, 13, 0),
    title: 'My Second Event'
  }]);

  const addEvent = useCallback(() => {
    const newEvent = {
      id: guid++,
      start: new Date(2020, 2, 18, 9, 0),
      end: new Date(2020, 2, 20, 13, 0),
      title: 'My New Event,
    };
    setEvents([...events, newEvent]);
  }, []);

  const deleteEvent = useCallback((eventId) => {
    // Create a copy of the event array
    const newEvents = [...events];
    // Find the index of the event to be deleted
    const index = events.indexOf(events.filter(event => event.id === eventId)[0]);
    // Remove the event from the array
    newEvents.splice(index, 1);
    // Pass the new array to the calendar
    setEvents(newEvents);
  }, []);

  const updateEvent = useCallback((updatedEvent) => {
    const index = events.indexOf(events.filter(event => event.id === updatedEvent.id)[0]);
    events[index] = updatedEvent;
    // Create a copy of the event array
    setEvents([...events]);
  }, []);

  return <Eventcalendar data={events} />;
}

In case you would like to edit a recurring event, you can use the updateRecurringEvent helper function.

Name	Description
updateRecurringEvent	Parameters `originalRecurringEvent`: Object - The original recurring event to update. `oldEventOccurrence`: Object, null - The old event occurrence, if there's any. `newEvent`: Object, null - The new event, if there's any. `updatedEvent`: Object, null - The updated event, if there's any. `updateMode`: String Specifies which part of the event to update. Possible values: `'current'` - This event occurrence only. `'following'` - This and following events. `'all'` - All event occurrences. The function returns the `updatedEvent` and the `newEvent`.

See the Recurring event editor as an example.

Views

The event calendar supports three different views for three different jobs: the calendar view, schedule view and agenda view. These three can be combined and configured in a couple of different ways.

Calendar view

Use the event calendar as a traditional month view or combine it with an agenda as a week view. The events can be rendered as labels or in a pop-over that is shown on day click.

Desktop calendar with labels and popover

Mobile month view with agenda

Schedule view

The scheduler displays a time grid with its related events. It can be configured as a daily or weekly schedule. Work hours and work days along with disabled time-spans, breaks can be added. Use it to for advanced scheduling tasks with built-in drag & drop.

The displayed week days can be modified with the startDay and endDay properties of the schedule view option.

The displayed hours can be modified with the startTime and endTime properties of the schedule view option. With these properties both hours and minutes can be specified.

Example to display a work-week

view: {
  schedule: {
    type: 'week',
    startDay: 1, // Monday
    endDay: 5, // Friday
    startTime: '07:30',
    endTime: '18:30',
  }
}

Desktop weekly schedule

Mobile daily schedule

There might be cases when you would like to change the height of the schedule cell. You can use the following CSS classes for this purpose:

.mbsc-schedule-time-wrapper,
.mbsc-schedule-item {
  height: 20px;
}

Timeline view

The timeline view displays a timeline with its related events. It can be configured as a daily or weekly timeline. Work hours and work days along with disabled time-spans, breaks can be added. Use it to for advanced scheduling tasks with built-in drag & drop.

The displayed week days can be modified with the startDay and endDay properties of the timeline view option.

The displayed hours can be modified with the startTime and endTime properties of the timeline view option. With these properties both hours and minutes can be specified.

Example to display a work-week

view: {
  timeline: {
    type: 'week',
    startDay: 1, // Monday
    endDay: 5, // Friday
    eventList: false,
    startTime: '07:30',
    endTime: '18:30'
  }
}

Desktop monthly timeline

Mobile daily timeline

By default timeline rows will have variable height and will expand to accommodate the displayed events. This can be controlled by the rowHeight property of the timeline view option. If it is set to 'equal', the rows will have equal heights, and overlapping events will be distributed evenly to fit in the row.

The eventList property transforms the event display into a daily listing mode. This view represents a daily summary rather than an hour-by-hour layout, similar to the event calendar where labels are printed under the appropriate day for the appropriate resource one after the other. The events have an exact height and the resource rows will expand automatically if more events are displayed than the minimum height.

Timeline event listing

Agenda view

The agenda calendar displays a list of events for a given period of time (year, month, week or day). It can be used as a stand-alon component or in combination with the calendar.

Desktop agenda

Mobile agenda

The three views can be used alone or combined with each-other. e.g. a week calendar combined with a daily agenda, listing the events for the selected day.

For the available configuration options see the view setting.

Weekly calendar view with daily agenda

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([/*...*/]);
  const view = useMemo(() => {
    return {
      calendar: { type: 'week' },
      agenda: { type: 'day' }
    };
  });

  return <Eventcalendar data={events} view={view} />;
}

Setting the initial view

By default the initial view of the calendar displays the current date. Depending on the view type, this might be the current day, week, month or year. For views, where time is also displayed, the view will be scrolled to the current time as well.

Changing the initial view to another date can be done either in a controlled or uncontrolled way.

Controlled component

To set the initial date of the event calendar in a controlled way (meaning that your component, which renders the calendar controls its selected date), use the selectedDate option to pass the date and the onSelectedDateChange handler to update the state when the date is changed from the calendar, e.g. using the navigation arrows.

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([/*...*/]);
  const [selectedDate, setSelectedDate] = useState(new Date(2020, 2, 18));

  const onSelectedDateChange = useCallback((args) => {
    setSelectedDate(args.date);
  }, []);

  return <>
    <Eventcalendar data={events} selectedDate={selectedDate} onSelectedDateChange={onSelectedDateChange} />
  </>;
}

Uncontrolled component

To only set the inital selected date, without the need of tracking later changes to the selected date, you can use it in an uncontrolled way (meaning that the calendar tracks the selected date in its own internal state) with the help of the defaultSelectedDate option.

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([/*...*/]);

  const myDate = useMemo(() => new Date(2020, 2, 18), []);

  return <Eventcalendar data={events} defaultSelectedDate={myDate} />;
}

For views, where time is also displayed, the view will be scrolled to the specified time. If the time part is not explicitly specified, it defaults to the start of the day.

When multiple days, weeks, months or years are displayed, the position of the specified date on the view (first, second, third, etc. day/week/month/year) is determined by the refDate option.

Navigating to a date and time

You can navigate to another view programatically any time, by changing the selectedDate option.

This will navigate the calendar to the view containing the specified date. For views, where time is also displayed, the view will be scrolled to the specified time. If the time part is not explicitly specified, it defaults to the start of the day.

When multiple days, weeks, months or years are displayed, the position of the specified date on the view (first, second, third, etc. day/week/month/year) is determined by the refDate option.

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([/*...*/]);
  const [selectedDate, setSelectedDate] = useState(new Date(2020, 2, 18));

  const onSelectedDateChange = useCallback((args) => {
    setSelectedDate(args.date);
  }, []);

  const setDate = useCallback(() => {
    // Set a specific date
    setSelectedDate(new Date(2020, 3, 19));
  }, []);

  return <>
    <Eventcalendar data={events} selectedDate={selectedDate} onSelectedDateChange={onSelectedDateChange} />
    <button onClick={setDate}>Set date</button>
  </>;
}

Events drag/resize/create

The calendar and schedule view events can be moved and resized with mouse/touch interactions. The dragToMove and dragToResize options enable the events drag and drop and resize functionality. With the dragTimeStep option the minimum amount of drag/resize step can be specified in minutes.

With the dragToCreate option enabled events can be created by dragging on the empty areas of the calendar and schedule view. On a desktop environment a new event can also be created with the clickToCreate option.

To customize the newly created event use the extendDefaultEvent option.

Event calendar move, resize and create

External drag & drop

Drag & drop events onto the calendar

There is a possibility to drag & drop any external element into your calendar.
In order to achieve this, first you need to grant permission to your calendar to accept this behavior. You can do that easily by setting the externalDrop option to true.
As a second step, you'll have to create your external draggable element and pass a skeleton event definition through the dragData option which will be added to the event calendar on drop. If omitted, a default event will be created.

You can initialize the draggable containers by using the <Draggable/> component and reference the draggable container in the element option.

Draggable initialization

const [draggable, setDraggable] = React.useState();

const setDrag = React.useCallback((event) => {
    setDraggable(event);
}, []);   
                
const myNewEvent = {
    title: 'My new event',
    // the event will be 3 hours long
    start: new Date(2021, 03, 10, 12),
    end: new Date(2021, 03, 10, 15),
    color: 'green'
};

<div ref={setDrag}>Drag me to the calendar></div>
<Draggable dragData={myNewEvent} element={draggable} />

Please note that when dragging the external element, we create a clone of it for a better illustration of the movement.

Event calendar external drag and drop

Resources

Resources grouped by date

Resources grouped by resource

Resources grouped by day view

The scheduler view can display multiple resources inside a single instance. By default the displayed resources will be grouped by the given resources and the grouping can be changed with the groupBy option, which also supports date grouping.

Example to a resource and groupBy settings

  resources: [{
    id: 1,
    name: 'Ryan',
    color: '#f7c4b4'
  }, {
    id: 2,
    name: 'Kate',
    color: '#c6f1c9'
  }, {
    id: 3,
    name: 'John',
    color: '#e8d0ef'
  }],
  groupBy: 'date'

The color property controls the default event color of the resource. If an event doesn't have a specified color it will inherit from the resource. The agenda and calendar view events and labels will also inherit the resource color.

Events, colors, invalids can be tied to a single or multiple resources. This can be done with the resource property of the objects, where the id of the resource should be passed. It can be a single value and the element would be linked to a single resource or in case of an array the element will show up at the specified resources. If no resource property is specified to the color/event/invalid object then the element will show up in every resource group.

Example to color/invalid/event objects with resource property

  invalid: [{ 
    start: '13:00',
    end: '12:00',
    resource: 1, // this invalid will be displayed only in resource group where id is 1
    recurring: { repeat: 'weekly', weekDays: 'MO,TU,WE,TH,FR' },
    title: 'Lunch break'
  }],
  data: [{
    start: new Date(2021, 5, 23),
    end: new Date(2021, 5, 30),
    title: 'Conference',
    allDay: true,
    resource: [2, 3] // this event will be displayed in resource groups where id is 2 and 3
  }],
  colors: [{
    // this color will display at every resource group
    start: new Date(2021, 5, 12, 16),
    end: new Date(2021, 5, 12, 17),
    color: 'green'
  }]

Resource grouping & hierarchy

The timeline view supports resource hierarchy. Hierarchy groups can be defined with the children property of the resource object and child objects have the same properties as the main level resources. By default every resource group will be displayed and this can be modified with the collapsed attribute of the parent objects.
It supports multiple levels of hierarchy, child resources can have their own children. Both parent and child rows can contain events and those can be moved between any rows.
Child or parent rows can be disabled by creating an invalid rule which repeats daily and it is tied to the specific resources. Example: { recurring: { repeat: 'daily' }, resource: [/* resource id(s) */] }

In case of the schedule view child resources will display only on one level, each parent will be followed by their children.

Example to resource hierarchy and disabling resources

resources: [{
  color: '#f7c4b4',
  id: 1,
  name: 'Carl',
}, {
  color: '#c6f1c9',
  id: 2,
  collapsed: false,
  name: 'Sharon',
  children: [
    {
      color: 'red',
      id: 21,
      name: 'Child 1 of Sharon',
    },
    {
      color: 'blue',
      id: 22,
      name: 'Child 2 of Sharon',
      collapsed: true,
      children: [
        {
          color: 'ef0011',
          id: 210,
          name: 'Grandchild 1 of Sharon',
        },
        {
          color: 'ef0011',
          id: 220,
          name: 'Grandchild 2 of Sharon',
        },
      ]
    }
  ]
}]

Timeline view resource grouping & hierarchy

Resource templating

To customize the display of the resources, the renderResource and, in case of the timeline, renderResourceHeader options can be used.

In case of the timeline view the width of the resource column is fixed, but it can be overwritten from CSS if needed:

.mbsc-timeline-resource-col {
  width: 200px;
}

/* For sticky event labels */
@supports (overflow:clip) {
    .mbsc-timeline.mbsc-ltr .mbsc-schedule-event-inner {
        left: 200px;
    }
    
    .mbsc-timeline.mbsc-rtl .mbsc-schedule-event-inner {
        right: 200px;
    }
}

Scheduler resource templating

Slots

Besides the resources which are grouping data for the whole date range, slots introduce a horizontal level daily grouping in case of the timeline view. Slots can be used alongside resources.

When slots are used the timeline view will display in daily listing mode and only the dragToMove event iteraction will be available. The dragToCreate and dragToResize interactions will be truned off.

The renderSlot option can be used to customize the slot template of the timeline view.

Example to slots

  slots: [{
    id: 1,
    name: 'Morning shift',
  }, {
    id: 2,
    name: 'Afternoon shift',
  }]

Timeline slots

Blocked out dates

You can show blocked out time ranges with the invalid option. By default the events and the blocked out dates will be displayed on the view even if there is collision.

The invalid option supports the following formats: JavaScript Date objects, 8601 strings , or moment object. These formats can be passed directly to the array in this case the whole day will be disabled or as an object where the blocked out ranges can be customized with the following properties: allDay/start/end/title/recurring.
Custom properties can also be passed to the invalid object which will also be passed to the life-cycle events and this can help with the identification/validation of the invalids.

If an event interacts with an invalid range the event will be reverted to it's original position and the onEventUpdateFailed event will be fired. (If the dragToMove or the dragToResize options were used.)

If a newly created event collide with a blocked out date the event won't be created and the onEventCreateFailed event will be fired. (If the dragToCreate option was used)

Example to an invalid array and it's properties

invalid: [
    /* Passing exact dates will block out the entire day */
     new Date(2021, 1, 7), // Date object
    '2021-10-15T12:00', // string
     moment("2020-12-25"), // moment object

    /* Block out date range passed as an object */
    { 
      // multi day range with date string
      start: '2021-10-15T12:00',
      end: '2021-10-18T13:00', 
      title: 'Company 10th anniversary',
      type: 'day-off' // custom property
    },
    { 
     // multi day range with date object
      allDay: true,
      start: new Date(2021, 2, 7, 10, 10),
      end: new Date(2021, 2, 9, 20, 20),
      title: 'Conference for the whole team',
      type: 'conference' // custom property
    },
    { 
      // multi day time range with recurring and time string
      start: '13:00',
      end: '12:00',
      recurring: { repeat: 'weekly', weekDays: 'MO,TU,WE,TH,FR' },
      title: 'Lunch break',
      type: 'lunch' // custom property
    }
];

Event calendar blocked out dates

Customizing the events

You can customize the events by writing custom rendering functions. Depending on what your goal is, you have two options:

Customize the full event - Mobiscroll takes care of rendering the events in the correct order, but everything else comes form the rendering function you write.
Customize the event content - Mobiscroll takes care of rendering the events in the correct order and also prints basic fields, like start/end, whether it is an allDay event or not and also takes care of coloring the event appropriately. Everything else comes from the custom rendering function.

Customize the full event

Whenever there is an event (in the agenda, scheduler, timeline, labels or popover) your custom rendering function will be used for instead the default render. Mobiscroll will position your component to the right place, but anything else you want to show is up to you... like a title, description, color the background or show any content.

For the agenda and popover - use the renderEvent option for the custom function
For event labels in the calendar and all-day events in the scheduler - use the renderLabel option for the custom function
For the scheduler and timeline - use the renderScheduleEvent option for the custom function

Event calendar event customization

Customize the event content

In most cases you only want to customize the content section of the event. In this case your render function will be used for rendering the content of the event. Mobiscroll will position the event to the right place and will render essential information like the color of the event, the time and if it's an all day event or not. The title, description and any other fields you want to show (like participants, an avatar...) will be coming from your custom function.

For the agenda and popover - use the renderEventContent option for the custom function
For event labels in the calendar and all-day events in the scheduler - use the renderLabelContent option for the custom function
For the scheduler and timeline - use the renderScheduleEventContent option for the custom function

Agenda content customization

Examples

Render Event

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([/*...*/]);

  const renderEvent = useCallback((data) => {
    return <>
      <div className="my-start">{data.start}</div>
      <div className="my-end">{data.end}</div>
      <div className="my-title">{data.title}</div>
      <div className="my-custom-field">{data.original.description}</div>
      <div className="my-custom-field">{data.original.location}</div>
    </>
  });

  return <Eventcalendar data={events} renderEvent={renderEvent} />;
}

Render Event Content

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([/*...*/]);

  const renderEventContent = useCallback((data) => {
    return <>
      <div className="my-title">{data.title}</div>
      <div className="my-custom-field">{data.original.description}</div>
      <div className="my-custom-field">{data.original.location}</div>
    </>
  });

  return <Eventcalendar data={events} renderEventContent={renderEventContent} />;
}

Taking over the listing

When the agenda view is displayed, you can take full control of the rendering, using the renderAgenda option. The renderer function will receive the event data as parameter, grouped by days.

If you'd like to keep the scroll to day functionality, when clicking a day on the calendar, make sure to add the rendered days to the dayRefs object, which is also passed to the renderer function, with the timestamp of the day as key, and the DOM element as value.

JSX

import { Eventcalendar } from '@mobiscroll/react';

const App = () => {
  const [events, setEvents] = useState([/*...*/]);

  const myView = useMemo(() => {
    return {
      calendar: { type: 'week' },
      agenda: { type: 'day' }
    };
  });

  const renderAgenda = useCallback((data, options, dayRefs) => {
    return <div className="custom-event-list">
      {data.map((day) =>
        <ul className="custom-event-group" ref={(el) => {dayRefs[day.timestamp] = el;}} key={day.timestamp}>
          <li className="custom-event-day">{day.date}</li>
          {day.events.map((event) =>
            <li key={event.id} className="custom-event">{event.title}</li>,
          )}
        </ul>,
      )}
    </div>;
  });

  return <Eventcalendar data={events} renderAgenda={renderAgenda} view={myView} />;
}

Agenda full event customization

Customizing the header

The header of the calendar can be fully customized to one's needs. This can be achieved by passing a function that returns the custom header to the renderHeader option.

Fully custom header

const customTemplate = () => {
    return <>
        <p>Any <strong>Title</strong> you want here or</p>
        <YourCustomComponent yourProp="yourPropValue" />
    </>
}
<Eventcalendar renderHeader={customTemplate} />

While fully customizing the header is very usefull, sometimes it's desireable to customize only parts of it. In this case you can take advantage of the default header's building blocks. These components let you put toghether the header you want, while you don't have to worry about the functionality behind them.
For example you can leave out parts from the default header, change the order the default buttons appearance or add custom components between them.

Here's the list of the built in components of the default header:

<CalendarPrev /> - Previous button component, that navigates to the previous month.
<CalendarNext /> - Next button component, that navigates to the next month.
<CalendarToday /> - Today button component, that navigates to the current date.
<CalendarNav /> - The title navigation button component, that opens the year/month navigation.

The above components can be used inside of the custom header. The following example will render the prev and next buttons and then a custom title that is set from a custom variable (myTitle variable).

Custom header with default buttons

const myTitle = 'My Awesome title';
const customWithNavButtons = () => {
    return <>
        <CalendarPrev />
        <CalendarNext />
        <div className="my-custom-title">{myTitle}</div>
    </>;
}

<Eventcalendar renderHeader={customWithNavButtons} />

Event calendar header customization

Timezones

By default the Eventcalendar uses the local timezone of the browser to show event data. If you want to show the data or interpret it in a different timezone, you will need an external library to handle the timezone conversions. There are two libraries that Mobiscroll supports: moment-timezone and luxon.

When using a timezone plugin with the Eventcalendar, the exclusiveEndDates options defaults to true. Learn more about exclusive end dates here!

Library Install

To setup the library, first you have to install it on your page. In this guide we'll assume you are using npm to install packages, but you can consult the installation guide on the libraries official pages (moment-timezone install page, luxon install page) for more options on how to install them.

The Moment-Timezone library

To install the moment-timezone library with npm you will need to run the following commands:

$ npm install moment-timezone

After the library is installed, you will have to import it with the momentTimezone object from mobiscroll:

import moment from 'moment-timezone';
import { momentTimezone } from '@mobiscroll/react';

Then set the mobiscroll's reference to the imported library:

momentTimezone.moment = moment;

After that, you can pass the momentTimezone object to the Eventcalendar's timezonePlugin option.

The Luxon library

To install the luxon library with npm you will need to run the following commands:

$ npm install luxon

In case you are using typescript you can also consider installing the types, because they come separately:

$ npm install --save-dev @types/luxon

After the library is installed, you will have to import it with the luxonTimezone object from mobiscroll:

import * as luxon from 'luxon';
import { luxonTimezone } from '@mobiscroll/react';

Then set the mobiscroll's reference to the imported library:

luxonTimezone.luxon = luxon;

After that, you can pass the luxonTimezone object to the Eventcalendar's timezonePlugin option.

Using timezones

When working with timezones, you usually have your data stored in one timezone, and display it in a different timezone. A common scenario is storing the data in UTC, and displaying it in the user's local timezone. You can set this using the dataTimezone and displayTimezone options.

Example

import moment from 'moment-timezone';
import { momentTimezone, Eventcalendar } from '@mobiscroll/react';

// setup the reference to moment
momentTimezone.moment = moment;
        
function App() {
    return <Eventcalendar timezonePlugin={momentTimezone} dataTimezone="utc" displayTimezone="Europe/Berlin" />;
}

Event calendar changing the timezones

Exclusive end dates

In version 5.7.0 we introduced support for exclusive end dates. This means that the last moment of a given range is not actually part of the range.

Many of existing calendaring solutions (e.g. Google Calendar) and standards (e.g. iCalendar) are working with exclusive end dates, so this makes interoperabiliy with our Eventcalendar UI simpler.

With the introduction of timezone support, this also became a necessity, e.g. if you have an event with start: '2021-07-09T20:00Z' and end: '2021-07-09T21:00Z', defined in UTC, when displayed in Europe/Bucharest timezone, the end becomes '2021-07-10T00:00+03:00'. With inclusive end dates the event will show up on 10th of July as well, which is unexpected.

The exclusive end dates mode can be enabled using the exclusiveEndDates option. When timezones are used (displayTimezone and/or dataTimezone is set), exclusive end dates are automatically enabled.

Enabling exclusive end dates can cause breaking changes, especially with all-day events with no time specified. With inclusive end dates an event with start: '2021-07-09' and end: '2021-07-10' will show as a two day event on the calendar view, expanded over 9th and 10th of July. With exclusive end dates the event will be a single day event, showing up only on 9th of July.

Print Module

The Print Module is an optional module, that includes styles and functions for printing. It can be installed and used with other Mobiscroll Components as described below.

Installing the Print Module

When your Mobiscroll package is created with the Download Builder and you have access to the Print Module, you can choose to include it in the built package. In this case you will need make sure you checked the print module before downloading the package from the download page. After installing your downloaded package, the Print Module will be available for import. In case it was downloaded with the download builder, the Print Module needs to be imported from the generated package.

When you're using the full Mobiscroll package from NPM, then you have the possibility to install the Print Module as an additional package (also from NPM). In this case, after successfully using the Mobiscroll CLI to configure the project, you will have to install the @mobiscroll/print package from npm. Use the following command:

$ npm install @mobiscroll/print

Importing the Print Module

The Print Module consists of print specific styles, that need to be loaded into the document. Also, there's a javascript part, that needs to be imported and passed to the component via the modules option.

Stylesheets

In the case of the package built by the download builder, there's no additional stylesheet. It is already bundled into the same file all the other component files are.

For the NPM package, styles can be found at the dist/css/ folder inside the package.

Import path for the styles from the npm print package

// importing the css
import '@mobiscroll/print/dist/css/mobiscroll.min.css';

// importing the SASS - if you are using SASS
import '@mobiscroll/print/dist/css/mobiscroll.scss';

JavaScript

The print module can be imported from the installed package and passed to the component using the modules option. Here's an example:

Pass the print module to the Eventcalendar

import { print } from '@mobiscroll/print';

const MY_MODULES = [print];

function App(props) {
    return <Eventcalendar modules={MY_MODULES} />;
}

Printing

Printing only the eventcalendar contents can be done, using the print method of the eventcalendar instance. Calling this method will create a new window containing only the eventcalendar and will invoke the print function of the browser. After the printing is done, the window should close automatically.

The new window created by the print method will include all the styles and links to stylesheets from the original page. These styles will be copied over automatically, but in case you are using relative urls, the base url of the new window might not match yours. In this case, the print method can be passed a config object, with your custom baseUrl, to make the relative paths work. By default, the baseUrl will be the original page's origin.

Please note that popup blockers might block the created window, so you need to disable the blocker for this method to work.

Printing the Eventcalendar

import { print } from '@mobiscroll/print';

const MY_MODULES = [print];

function App(props) {
    const [inst, setInst] = React.useState(null);

    const myPrint = () => {
        inst.print();
    }

    return <>
        <Eventcalendar modules={MY_MODULES} ref={setInst} />
        <Button onClick={myPrint}>Print Eventcalendar</Button>
    </>

When you want to include more than just the eventcalendar in your print, you can invoke the print screen of your browser. You don't have to worry about the printing styles for the eventcalendar, they will be applied in this case as well.

For many more examples - simple and complex use-cases - check out the event calendar demos for react.

Options

Name	Type	Default value	Description
actionableEvents	Boolean	`true`	Defines if the events on the agenda and inside the calendar popover are actionable or not. If actionable, the event items will have hover and active states, and pointer cursor. Set to `false` when custom event rendering is used and the event list items contain other actionable elements, e.g. buttons.
calendarSystem	Object	`undefined`	Specify the calendar system to be used. Supported calendar systems: Gregorian - This is the default calendar system, no setting needs to be passed. Jalali - Default system of the Persian calendar. The `Farsi` language needs to be included to the package. `import { Eventcalendar, jalaliCalendar } from '@mobiscroll/react'; export function MyComponent() { return <Eventcalendar calendarSystem={jalaliCalendar} />; }` Hijri - `Arabic` language needs to be included to the package. `import { Eventcalendar, hijriCalendar } from '@mobiscroll/react'; export function MyComponent() { return <Eventcalendar calendarSystem={hijriCalendar} />; }`
clickToCreate	Boolean, String	`undefined`	Enable new event creation on click. If `true` or `'double'` a new event will be created only with a double click and with the `'single'` value the event will be created instantly with a single click. This option will only work on desktop environment where mouse events are fired. It will also allow deleting of the focused events using the Delete or Backspace key. In touch environment a long tap should be used to create a new event and it is controlled with the dragToCreate option. Using the extendDefaultEvent option extra properties can be set for the created event.
colors	Array	`undefined`	Change the color of certain dates on the calendar. Must be an array of objects with the following properties: `allDay` Boolean - Specifies whether the date you want to color is all day or not. `date` Date, String, Object - Date of the calendar day which should be colored. `start` Date, String, Object - Start date/time of the calendar days/cells which should be colored. `end` Date, String, Object - End date/time of the calendar days/cells which should be colored. `background`: String - Background color of the cell, can be any valid CSS color (`'red'`, `'#ff0000'`, `'rgb(255,0,0)'`, etc.). `highlight`: String - Highlight color of the day, can be any valid CSS color (`'red'`, `'#ff0000'`, `'rgb(255,0,0)'`, etc.). `recurring` String, Object - Recurrence rule for coloring recurring days. `recurringException`: String, Object, Array - Represents the exceptions of a recurring color. Useful when specific dates need to be skipped from the rule. `recurringExceptionRule`: String, Object - Represents the exception rule of a recurring color. Useful when recurring dates need to be skipped from the rule. `cellCssClass`: String - CSS class for the day cell. This property is only applicable in the case of the calendar view. `resource`: String, Number, Array of String \| Number - specify resource ids for the color. The color will display only in the specified resource group. If there is no resource id defined the color will be displayed at every resource group. `slot`: String, Number - specify slot ids for the color. The color will display only in the specified slot group. If there is no slot id defined the color will be displayed at every slot group. `textColor`: String - Specifies the color of the colored range title. `title`: String - Text which will be displayed on the schedule/timeline view for the colored range. The colored range will be considered all-day if: `allDay` is explicitly set. `start/end` is not specified, only the `date`. The dates can be specified as Javascript Date objects, ISO 8601 strings, or moment objects. The colors can be combined with the labels or marked options. Example `colors: [ { date: new Date(2020,2,23), background: 'pink' }, { date: new Date(2020,2,24), background: 'green' }, { background: '#ff0000', recurring: { repeat: 'weekly', weekDays: 'SU' } }, { background: 'yellow', recurring: { repeat: 'weekly', weekDays: 'SA' } } ]`
context	String, HTMLElement	`'body'`	The DOM element in which the popups (event popover, year and month picker) are rendered. Can be a selector string or a DOM element.
data	Array	`undefined`	Events for the calendar, as an array of event objects. The event object supports the following properties: `id`String, Number - A unique id for the event. If not specifed, the event will get a generated id. `start`Date, String, Object - Specifies the start of the event. `end`Date, String, Object - Specifies the end of the event. `title`String - The title of the event. `color`String - The color of the event. `allDay`Boolean - Specifies if the event is all day or not. `editable`: Boolean - specify if an event is editable or not. Setting it to `false` disables drag & drop, resize and delete, and the event will have mbsc-readonly-event css class. With this class, the fixed events will be easily customizable, for example: add opacity or disable the cursor on the fixed events. `resource`: String, Number, Array - specify resource ids for the events. The event will display only in the specified resource group. If there is no resource id defined the event will be displayed at every resource group. `slot`: String, Number - specify slot ids for the events. The event will display only in the specified slot group. If there is no slot id defined the event will be displayed at every slot group. `recurring`: String, Object - Recurrence rule for the event. `recurringException`: String, Object, Array - Represents the exceptions of a recurring event. Useful when specific dates need to be skipped from the rule. `recurringExceptionRule`: String, Object - Represents the exception rule of a recurring event. Useful when recurring dates need to be skipped from the rule. `tooltip`: String - Specifies the tooltip text of the event. The dates can be specified as Javascript Date objects, ISO 8601 strings, or moment objects. The event objects may have additional custom properties as well. The custom properties are not used by the eventcalendar, but they are kept and will be available anywhere the event objects are used. E.g. the onEventClick event will receive the event object as argument, containing the custom properties as well. Use the getEvents method to get the events between two dates. Example `data: [{ start: new Date(2021, 5, 23), end: new Date(2021, 5, 30), title: 'Conference', allDay: true, color: 'red' }, { title: 'Work project', recurring: { repeat: 'daily', until: '2021-04-01' }, recurringException: ['2021-03-15', '2021-03-25'], recurringExceptionRule: { repeat: 'weekly', weekDays: 'SA,SU' } }]`
dataTimezone	String	defaults to displayTimezone	The timezone in which the data is interpreted. If the data contain timezone information (when the ISO string has a timezone offset ex. "2021-03-28T01:00:00Z" or "2021-03-28T03:00:00+03:00") then the data's timezone is used instead of the dataTimezone option. When using timezones, the exclusiveEndDates option is also turned on by default. When using anything other than the default, a timezone plugin must be also passed to the component. Possible values are: 'local' - Uses the systems local timezone 'utc' - Displays data in UTC (Universal Coordinated Time) Timezone name - The timezone name from the IANA time zone database ex. "America/New_York"
defaultSelectedDate	Date, String, Object	`undefined`	Specifies the initial selected date on the calendar, when used as an uncontrolled component. For controlled usage use the selectedDate option instead. For views, where time is also displayed, the view will be scrolled to the specified time. If the time part is not explicitly specified, it defaults to the start of the day.
displayTimezone	String	`'local'`	The timezone in which the data is displayed. When using anything other than the default ('local'), a timezone plugin must be also passed to the component. Possible values are: 'local' - Default. Uses the systems local timezone 'utc' - Displays data in UTC (Universal Coordinated Time) Timezone name - The timezone name from the IANA time zone database ex. "America/New_York"
dragTimeStep	Number	`15`	Specify the steps in minutes for the schedule events during drag.
dragToCreate	Boolean	`undefined`	If `true`, dragging on an empty cell will create a new event. It will also allow deleting of the focused events using the Delete or Backspace key. The title of the new event can be specified with the newEventText option. Using the extendDefaultEvent option extra properties can be set for the created event.
dragToMove	Boolean	`undefined`	If `true`, the events will be move-able.
dragToResize	Boolean	`undefined`	If `true`, the events will be resize-able.
eventOrder	Function	`undefined`	Determines the ordering of the events within the same day. Can be a function that accepts two event objects as arguments and should return -1 or 1. If not specified, the default order is: all day events rest of events, sorted by start time; events with identical start times, will be ordered alphabetically based on their title
exclusiveEndDates	Boolean	`undefined`	If `true`, the Eventcalendar will work in exclusive end dates mode, meaning that the last moment of the range (event, invalid, colors, etc.) is not part of the range. E.g. `end: '2021-07-03T00:00'` means that the event ends on 2nd of July and will not be shown on 3rd of July.
extendDefaultEvent	Function	`undefined`	Use this option to set properties to the new event created with click or drag. This event creation is handled by the clickToCreate and dragToCreate options. It takes a function that should return the properties for the new event. The object passed to this function has the following properties: `start`: Date - The date when the newly created event will start. `resource`: String, Number, Array - The id of the resource where the event creation started. Example `public newEventData() { return { color: 'green', title: 'My event', }; }` `<Eventcalendar extendDefaultEvent={this.newEventData} />`
externalDrop	Boolean	`undefined`	If `true`, external drag & drop is allowed.
groupBy	String	`'resource'`	Groups the given schedule resources based on the specified `'date'` or `'resource'`.
height	Number, String	`undefined`	Sets the height of the component. The height of the calendar view impacts the number of labels that fit into a table cell. A show more label will be displayed for events that don't fit.
invalid	Array	`undefined`	An array containing the invalid values. Can contain dates (Javascript Date objects, ISO 8601 strings, or moment objects), or objects with the following properties: `allDay`: Boolean - If `true` the specified date will cover the whole day. `start`: Date, String, Object - Start of the invalid range. `end`: Date, String, Object - End of the invalid range. `recurring`: String, Object - Recurrence rule for recurring invalid ranges. `recurringException`: String, Object, Array - Represents the exceptions of a recurring invalid. Useful when specific dates need to be skipped from the rule. `recurringExceptionRule`: String, Object - Represents the exception rule of a recurring invalid. Useful when recurring dates need to be skipped from the rule. `title`: String - Text which will be displayed on the schedule view for the invalid range. `resource`: String, Number, Array - specify resource ids for the invalid range. The invalid range will be displayed only for the specified resources. If there is no resource defined, the invalid range will be displayed for every resource. `slot`: String, Number - specify slot ids for the invalid range. The invalid range will be displayed only for the specified slot. If there is no slot defined, the invalid range will be displayed for every slot. Use the getInvalids method to get the invalids between two dates. Example invalid: [ // Passing exact dates and times new Date(2021, 1, 7), // Date object '2021-10-15T12:00', // ISO 8601 string moment("2020-12-25"), // moment object // Passing invalid ranges { // ISO 8601 strings start: '2021-10-15T12:00', end: '2021-10-18T13:00', title: 'Company 10th anniversary', }, { // Date objects allDay: true, start: new Date(2021, 2, 7), end: new Date(2021, 2, 9), title: 'Conference for the whole team', }, { // Time range with recurrence start: '13:00', end: '12:00', recurring: { repeat: 'weekly', weekDays: 'MO,TU,WE,TH,FR' }, title: 'Lunch break', }, { // Disable weekends recurring: { repeat: 'weekly', weekDays: 'SA,SU' } } ];
invalidateEvent	String	`'strict'`	Configures how to validate events against invalid ranges on create/move/resize: When set to `'strict'`, event cannot intersect with an invalid range at all. When set to `'start-end'`, event start and end cannot be inside an invalid range.
labels	Array	`undefined`	Specify labels for calendar days. A label object can have the following properties: `date` Date, String, Object - Date of the calendar label. `start` Date, String, Object - Start date of the calendar label. `end` Date, String, Object - End date of the calendar label. `color` String - The color of the label, can be any valid CSS color (`'red'`, `'#ff0000'`, `'rgb(255,0,0)'`, etc.). `text` String - The text of the label. `recurring`: String, Object - Recurrence rule for recurring labels. `recurringException`: String, Object, Array - Represents the exceptions of a recurring label. Useful when specific dates need to be skipped from the rule. `recurringExceptionRule`: String, Object - Represents the exception rule of a recurring label. Useful when recurring dates need to be skipped from the rule. `cellCssClass`: String - CSS class for the day cell. This property is only applicable in the case of the calendar view. The dates can be specified as Javascript Date objects, ISO 8601 strings, or moment objects. The labels can be combined with the colors option. Example `labels: [{ start: new Date(2020, 2, 23), end: new Date(2020, 2, 24), text: 'Conference', color: 'red' }, { text: 'Christmas', recurring: { repeat: 'yearly', month: 12, day: 24 } }]`
marked	Array	`undefined`	Mark certain dates on the calendar. Must be an array containing dates (Javascript Date objects, ISO 8601 strings, or moment objects), or objects with the following properties: `date` Date, String, Object - Date of the day to be marked. `start` Date, String, Object - Start date of the days to be marked. `end` Date, String, Object - End date of the days to be marked. `color` String - The color of the mark, can be any valid CSS color (`'red'`, `'#ff0000'`, `'rgb(255,0,0)'`, etc.). `recurring`: String, Object - Recurrence rule for recurring marked days. `recurringException`: String, Object, Array - Represents the exceptions of a recurring marked rule. Useful when specific dates need to be skipped from the rule. `recurringExceptionRule`: String, Object - Represents the exception rule of a recurring marked rule. Useful when recurring dates need to be skipped from the rule. `cellCssClass`: String - CSS class for the day cell. This property is only applicable in the case of the calendar view. `markCssClass`: String - CSS class for the mark. The dates can be specified as Javascript Date objects, ISO 8601 strings, or moment objects. The marked option can be combined with the colors option. Example `marked: [ new Date(2020, 2, 15), new Date(2020, 2, 22), { start: new Date(2020, 2, 23), end: new Date(2020, 2, 24), color: 'red' }, { color: 'green', recurring: { repeat: 'yearly', month: 12, day: 24 } } ]`
max	Date, String, Object	`undefined`	Maximum date and time. The calendar cannot be navigated beyond the specified maximum date. If navigation is needed, but event creation should not be allowed after a specific date, use the invalid option with daily recurrence starting from the specific date. `<Eventcalendar max={new Date(2021, 11, 12)} />`
min	Date, String, Object	`undefined`	Minimum date and time. The calendar cannot be navigated beyond the specified minimum date. If navigation is needed, but event creation should not be allowed before a specific date, use the invalid option with daily recurrence until the specific date. `<Eventcalendar min={new Date(2021, 11, 12)} />`
refDate	Date, String, Object	`undefined`	Specifies the reference date for the view calculation, when multiple days, weeks, months or years are displayed. If not specified, for the scheduler and timeline views will be today's date, for the calendar and agenda views will be 1970/01/01. It denotes the reference point when calculating the pages going in the future and in the past. For example if the view type is day, the view size is 3, and the current date is `01/16/2024`, the pages are calculated from this date, so the initial page will contain `[01/16/2024, 01/16/2024, 01/17/2024]`, the next page `[01/18/2024, 01/19/2024, 01/20/2024]` and so on. In case of day view, the reference point will be exactly the specified date. For week, month and year views the reference point will be the start of the week, month or year of the specified day. Changing the reference date will not navigate the calendar to the specified date, it only recalculates the pages from the new reference date. To navigate the view to a specified date and time, use the selectedDate option.
renderAgenda	Function	`undefined`	A render function to customize the agenda template. Should return the markup of an event list, to be used in the agenda listing. It receives the the following parameters: `events`: Array - The events of the current view, grouped by day. A day object has the following properties: `date`: String - The formatted date of the day. `events`: Array - The list of events for the day. An event object has the following properties: `allDay`: String - The localized all-day text in case of all day events. `end`: String - The formatted end time, if the event is not all day. `id`: String - The id of the event. `isMultiDay`: Boolean - True if the event spans across multiple days. `lastDay`: Boolean - True if it's rendered on the last day of a multiple event. `original`: Object - The original event object. `start`: String - The formatted start time, if the event is not all day. `title`: String - The title of the event. `timestamp`: Number - The timestamp of the day `options`: Object - The current settings of the component. `dayRefs`: Object - An object holding the references to the DOM elements of the days containing the event listings. Needed for the scroll functionality: clicking on a calendar date scrolls to the date on the list as well, and scrolling the list updates the selected date on the calendar.
renderDay	Function	`undefined`	You can use the renderDay option to customize the day cells of the calendar view and the header date container in case of schedule view. It takes a function that should return the desired markup. The Eventcalendar will take care of the positioning, but everything else (like background color, hover effect, etc.) is left to you. If you are looking to customize only the content and don't want to bother with the styling of the event, in case of calendar and schedule view you can use the renderDayContent option. The render function will receive an object as parameter. This data can be used to show day specific things on the Eventcalendar. The object passed to the function has the following properties: `date`: Date object - The specific date as a Date object. `selected`: Boolean - True if the date is selected. (In case of calendar view) `events`: Array - The list of events of the day. `resource`: String, Number - The id of the resource in case of scheduler(week and month views) when the events are grouped by resources. Example `const myCustomDay = (day: any) => { const date = day.date; return <> <div>{formatDate('DDDD', date)}</div> <p>{formatDate('MMMM DD', date)}</p> </>; }`
renderDayContent	Function	`undefined`	You can use the renderDayContent option to customize the day content of the Eventcalendar. It takes a function that should return the desired markup. The Eventcalendar will take care of styling and you can focus on what you show beside the day number a.k.a the content. If you are looking to fully customize the day (ex. add custom hover effects) you will need to use the renderDay option. In that case you will only get the positioning done by the Eventcalendar and everything else is up to you. The render function will receive an object as parameter. This data can be used to show day specific things on the Eventcalendar. The object passed to the template has the following properties: `date`: Date object - The specific date as a Date object. `selected`: Boolean - True if the date is selected. `events`: Array - The list of events of the day. `resource`: String, Number - The id of the resource in case of week view scheduler when the events are grouped by resources. Example `const myCustomDay = (day: any) => { const date = day.date; return <> <div>{formatDate('DDDD', date)}</div> <p>{formatDate('MMMM DD', date)}</p> </>; }`
renderEvent	Function	`undefined`	You can use the renderEvent option to customize the events that appear on the agenda and the popover. It should return the markup of the event. The Eventcalendar will take care of the positioning, but everything else (like background color, hover effect, etc.) is left to you. If you are looking to customize only the content (ex. add custom elements) and don't want to bother with the styling of the event, you can use the renderEventContent option. For customizing the events on other part of the Eventcalendar check out the customizing the events section The render function will receive an event object as parameter. This data can be used to show event specific things on the agenda and popover. The object passed to the function has computed properties, as well as a reference to the original event it comes from: `allDay`: String - The localized all-day text in case of all day events. `end`: String - The formatted end time, if the event is not all day. `id`: String - The id of the event. `isMultiDay`: Boolean - True if the event spans across multiple days. `lastDay`: Boolean - True if it's rendered on the last day of a multiple event. `original`: Object - The original event object. `start`: String - The formatted start time, if the event is not all day. `title`: String - The title of the event.
renderEventContent	Function	`undefined`	You can use the renderEventContent option to customize the event content that appears on the agenda and the popover. It should return the markup that is added to the event. The Eventcalendar will take care of styling and you can focus on what you show inside of the event a.k.a the content. If you are looking to fully customize the event (ex. add custom hover effects) you will need to use the renderEvent option. In that case you will only get the positioning done by the Eventcalendar and everything else is up to you. For customizing the events on other part of the Eventcalendar check out the customizing the events section. The render function will receive an event object as parameter. This data can be used to show event specific things on the agenda and popover. The object passed to the function has computed properties, as well as a reference to the original event it comes from: `allDay`: String - The localized all-day text in case of all day events. `end`: String - The formatted end time, if the event is not all day. `id`: String - The id of the event. `isMultiDay`: Boolean - True if the event spans across multiple days. `lastDay`: Boolean - True if it's rendered on the last day of a multiple event. `original`: Object - The original event object. `start`: String - The formatted start time, if the event is not all day. `title`: String - The title of the event.
renderHeader	Function	`undefined`	Use this option to customize the header of the Eventcalendar. It takes a function that should return the desired markup. In the returned markup, you can use custom html as well as the built in header components of the calendar. Check out the customizing the header section for a more detailed description on built in components. Example with built in components `const myCustomHeader = () => { return <> <CalendarPrev /> <CalendarNext /> </> }`
renderLabel	Function	`undefined`	You can use the renderLabel option to fully customize the labels that appear on the calendar. It should return the markup of the event. The Eventcalendar will take care of the positioning, but everything else (like background color, hover effect, etc.) is left to you. If you are looking to customize only the content (ex. add custom elements) and don't want to bother with the styling of the label, you can use the renderLabelContent option. For customizing the events on other part of the Eventcalendar check out the customizing the events section The render function will receive an event object as parameter. This data can be used to show event specific things on the calendar. The object passed to the function has computed properties, as well as a reference to the original event it comes from: `end`: String - Computed property. It holds the formatted end time, if the event is not all day. `id`: String - It holds the id of the event. If there's no id on the event object, this property is generated. `isMultiDay`: Boolean - Computed property. It's true if the event spans across multiple days. `original`: Object - Reference to the original event object. Any custom property on the event can be access through this property. `start`: String - Computed property. It holds the formatted start time, if the event is not all day.
renderLabelContent	Function	`undefined`	You can use the renderLabelContent option to customize the label contents, that appears on the calendar. It should return the markup that is added to the label. The Eventcalendar will take care of styling and you can focus on what you show inside of the label a.k.a the content. If you are looking to fully customize the label (ex. add custom hover effects) you will need to use the renderLabel option. In that case you will only get the positioning done by the Eventcalendar and everything else is up to you. For customizing the events on other part of the Eventcalendar check out the customizing the events section The render function will receive an event object as parameter. This data can be used to show event specific things on the calendar. The object passed to the function has computed properties, as well as a reference to the original event it comes from: `end`: String - Computed property. It holds the formatted end time, if the event is not all day. `id`: String - It holds the id of the event. If there's no id on the event object, this property is generated. `isMultiDay`: Boolean - Computed property. It's true if the event spans across multiple days. `original`: Object - Reference to the original event object. Any custom property on the event can be access through this property. `start`: String - Computed property. It holds the formatted start time, if the event is not all day.
renderResource	Function	`undefined`	Use this option to customize the resource template of the Scheduler. It takes a function that should return the desired markup. In the returned markup, you can use custom html as well. Example `const myCustomResourceTemplate = (resource: MbscResource) => { return <> <div>{resource.name}</div> <p>{resource.description}</p> <img src={resource.img} /> </> }`
renderResourceHeader	Function	`undefined`	Use this option to customize the empty cell content above the resource column. It takes a function that should return the desired markup. In the returned markup, you can use custom html as well. Example `const myCustomResourceHeaderTemplate = () => { return <> <div>Resources</div> </> }`
renderScheduleEvent	Function	`undefined`	You can use the renderScheduleEvent option to customize the events that appear on the scheduler and timeline. It should return the markup of the event. The Eventcalendar will take care of the positioning, but everything else (like background color, hover effect, etc.) is left to you. If you are looking to customize only the content (ex. add custom elements) and don't want to bother with the styling of the event, you can use the renderScheduleEventContent option. For customizing the events on other part of the Eventcalendar check out the customizing the events section The render function will receive an event object as parameter. This data can be used to show event specific things on the scheduler. The object passed to the function has computed properties, as well as a reference to the original event it comes from: `allDay`: String - The localized all-day text in case of all day events. `end`: String - The formatted end time, if the event is not all day. `id`: String - The id of the event. `isMultiDay`: Boolean - True if the event spans across multiple days. `lastDay`: Boolean - True if it's rendered on the last day of a multiple event. `original`: Object - The original event object. `start`: String - The formatted start time, if the event is not all day. `title`: String - The title of the event. `currentResource`: String, Number - Represents the resource of the row or column where the event is being rendered.
renderScheduleEventContent	Function	`undefined`	You can use the renderScheduleEventContent option to customize the event content that appears on the scheduler and timeline. It should return the markup that is added to the event. The Eventcalendar will take care of styling and you can focus on what you show inside of the event a.k.a the content. If you are looking to fully customize the event (ex. add custom hover effects) you will need to use the renderScheduleEvent option. In that case you will only get the positioning done by the Eventcalendar and everything else is up to you. For customizing the events on other part of the Eventcalendar check out the customizing the events section The render function will receive an event object as parameter. This data can be used to show event specific things on the scheduler. The object passed to the function has computed properties, as well as a reference to the original event it comes from: `allDay`: String - The localized all-day text in case of all day events. `end`: String - The formatted end time, if the event is not all day. `id`: String - The id of the event. `isMultiDay`: Boolean - True if the event spans across multiple days. `lastDay`: Boolean - True if it's rendered on the last day of a multiple event. `original`: Object - The original event object. `start`: String - The formatted start time, if the event is not all day. `title`: String - The title of the event. `currentResource`: String, Number - Represents the resource of the row or column where the event is being rendered.
renderSlot	Function	`undefined`	Use this option to customize the slot template of the Timeline view. It takes a function that should return the desired markup. In the returned markup, you can use custom html as well. It will recieve an object as parameter and has the following properties: `date`: Date object - The specific date where the slot is rendered. `slot`: Object - Data of the rendered slot. Example `const myCustomSlotTemplate = (slotData: MbscSlotData) => { return <> <div>{slotData.slot.name}</div> <p>{slotData.slot.description}</p> <img src={slotData.slot.img} /> </> }`
resources	Array	`undefined`	The scheduler can handle multiple resources inside a single instance. Resource grouping can be modified with the help of the groupBy option. If set `null` or `undefined`, all events will be displayed, regardless of their `resource` property. If set to an empty array, only those events will be displayed which are not tied to any resource. The timeline view can render multiple levels of hierachy groups. Levels can be added wiht the help of the `children` property. The resource object has the following properties: `children`: Array of object - Array of resoruce objects which will render as a child of the specified resource. `collapsed`: Boolean - Defines the displayed state of the child resoruce group. `id`: Number, String - This is an id that can be referenced in the events/invalids/colors data. `name`: String - The name of the resource that will be displayed at the top of the resource column. `color`: String - The color controls the default event color of the resource. Event colors can be specific above this. If the color is omitted the events of the resource will inherit the default calendar color. Example of a resource array `resources: [{ id: 1, name: 'Flatiron Room', color: '#f7c4b4' }, { id: 2, name: 'The Capital City', color: '#c6f1c9' }, { id: 3, name: 'Heroes Square', color: '#e8d0ef' }]`
responsive	Object	`undefined`	Specify different settings for different container widths, in a form of an object, where the keys are the name of the breakpoints, and the values are objects containing the settings for the given breakpoint. The available width is queried from the container element of the component and not the browsers viewport like in css media queries There are five predefined breakpoints: `xsmall` - min-width: 0px `small` - min-width: 576px `medium` - min-width: 768px `large` - min-width: 992px `xlarge` - min-width: 1200px Custom breakpoints can be defined by passing an object containing the `breakpoint` property specifying the min-width in pixels. Example: `responsive: { xsmall: { view: { calendar: { type: 'week' }, agenda: { type: 'day' } } }, custom: { // Custom breakpoint breakpoint: 600, view: { calendar: { labels: true } } } }`
selectedDate	Date, String, Object	`undefined`	Specifies the selected date on the calendar. This can be changed programmatically and when changed the calendar will automatically navigate to the specified date. For views, where time is also displayed, the view will be scrolled to the specified time. If the time part is not explicitly specified, it defaults to the start of the day. You also need to pass a handler for the onSelectedDateChange event for a controlled usage, otherwise use the defaultSelectedDate option instead. This does not change the reference date that defines the reference point of the navigation pages. To change the reference point for the navigation (e.g. start the paging from the newly selected date) use the refDate option.
showControls	Boolean	`true`	Shows or hides the calendar header controls: the previous and next buttons, and the current view button together with the year and month picker.
showEventTooltip	Boolean	`true`	If `false`, it will hide the native tooltip that shows up when hovering over the event.
slots	Array	`undefined`	The slots besides the resources introduce a horizontal(daily) level of data grouping to the Timeline view. If set `null` or `undefined`, all events will be displayed, regardless of their `slot` property. If set to an empty array, only those events will be displayed which are not tied to any slot. The slot object has the following properties: `id`: Number, String - This is an id that can be referenced in the events/invalids/colors data. `name`: String - The name of the slot that will be displayed at the top of the slot column. Example of a resource array `slots: [{ id: 1, name: 'Morning shift, }, { id: 2, name: 'Afternoon shift', }]`
theme	String	`undefined`	Sets the visual appearance of the component. If it is `'auto'` or `undefined`, the theme will automatically be chosen based on the platform. If custom themes are also present, they will take precedence over the built in themes, e.g. if there's an iOS based custom theme, it will be chosen on the iOS platform instead of the default iOS theme. Supplied themes: `'ios'` - iOS theme `'material'` - Material theme `'windows'` - Windows theme It's possible to modify theme colors or create custom themes. Make sure that the theme you set is included in the downloaded package.
themeVariant	String	`undefined`	Controls which variant of the theme will be used (light or dark). Possible values: `'light'` - Use the light variant of the theme. `'dark'` - Use the dark variant of the theme. `'auto'` or `undefined` - Detect the preferred system theme on devices where this is supported. To use the option with custom themes, make sure to create two custom themes, where the dark version has the same name as the light one, suffixed with `'-dark'`, e.g.: `'my-theme'` and `'my-theme-dark'`.
timezonePlugin	Object	undefined	Specifies the timezone plugin, which can handle the timezone conversions. By default the Eventcalendar uses the local timezone of the browser to show event data. If you want to show the data or interpret it in a different timezone, you will need an external library to handle the timezone conversions. There are two supported libraries: moment-timezone and luxon. Read our guide on how to set up timezones in your app. You can specify either the dataTimezone or the displayTimezone or both. Depending on which externa library you use you can pass either the momentTimezone luxonTimezone objects to the timezonePlugin option. These objects can be imported from the mobiscroll bundle: `import { momentTimezone, luxonTimezone } from '@mobiscroll/react';` Example `<Eventcalendar timezonePlugin={momentTimezone} dataTimezone="utc" displayTimezone="America/New_York"/>`
view	Object	`{ calendar: { type: 'month', popover: true } }`	Configures the event calendar view elements. Properties `calendar`: Object - Configures the calendar view. If omitted, no calendar will be displayed. Properties: `type`: String (default `'month'`) - Sets the calendar type. Possible values: `'year'`, `'month'`, `'week'`. `size`: Number - Specifies the number of displayed weeks/months. `count`: Boolean (default `false`) - If true, it will display the number of events on days with events. `outerDays`: Boolean (default `false`) - Show or hide days from previous and next months. Hiding only works for `type: 'month'`. `labels`: Boolean, String, Number (default `false`) - Enable displaying events as labels on calendar days. Supported values: boolean - If is set to `true` events will be displayed in the available space. If there are more events for a day, than the available space, a label with "x more" text will be displayed, which opens the popover showing all the events for the given day. In this mode to display multiple events on a day, set the calendar height to an appropriate value, using the height setting. 'all' - In this mode all the event labels will be displayed in the calendar cell and the row height will auto-expand based on the diplayed events. The row conatiner will became scrollable if the rows overflow the available height. number - Specify how many events will be displayed before the "more" button in a calendar cell. The row height will auto expand until the labels count reaches the given number and after that the "x more" button will be displayed. In the case when only one event should go in the "more" popup, that event will be displayed in the place of the "x more" button. `popover`: Boolean (default `undefined`) - Enable popover for event listing on days containing events. If not explicitly defined, the popover will not show up if event listing is used. If event labels are used, popover will only show up for days where all labels do not fit on the calendar, and a "more" label is present. `popoverClass`: String (default `undefined`) - A CSS class that's added to the popover element. Can be used to customize the styling of the popover on a calendar basis. `scroll`: String (default `'horizontal'`) - Specifies the direction of the calendar scroll. Can be `'horizontal'` or `'vertical'`. `weekNumbers`: Boolean (default `false`) - Show or hide week numbers. `agenda`: Object - Configures the event list. If omitted, no event list will be displayed. Properties: `type`: String (default `undefined`) - Sets the list type. Possible values: `'year'`, `'month'`, `'week'`, `'day'`. If calendar is also displayed, only month, week and day values are supported. In case of month and week, the type and size should match the calendar type and size. In case of day type events on the selected calendar day will be displayed, so size will always be 1. `size`: Number (default `1`) - Specifies the number of years, months, weeks or days included in the list (depending on the specified type). `scrollable`: Boolean (default `false`) - Setting this to `true` makes the event listing independently scrollable. There are two prerequisites for making this work: 1 - The calendar needs to be to placed inside a container which has a height. This can be either a fixed height, a height in percentage, or a flex height. When the calendar is placed directly in a container with a fixed height, it will work out of the box. If the height of the container is specified in percentage, e.g. you'd like to fill the full page height, you need to make sure that all parent elements also have `height: 100%` specified, up until the `body` and `html` elements, or until the closest parent which has a fixed height. If the container is inside a parent with flex layout, it will also work out of the box. 2 - The event list has a minimum calculated height of 200px - the result of the container height minus the height of the calendar header minus the height of the displayed calendar rows. If the calculated height is less then 200px, the event list will not be scrollable. `schedule`: Object - Configures the schedule view. If omitted, no schedule will be displayed. Properties: `type`: String (default `'week'`) - Sets the schedule type. Possible values: `'day'`, `'week'` ,`'month'` . `size`: Number - Specifies the number of displayed days/weeks. `allDay`: Boolean (default `true`) - Show or hide the all day events. `days`: Boolean (default `true`) - Show or hide week days above the schedule grid. `startDay`: Number (default `0`) - Set the first visible weekday of the view. Sunday is 0, Monday is 1, etc. Days outside of the `startDay` and `endDay` range will not be visible. Should not be mistaken for the firstDay option, which sets the first day of the week, and, if not set, is defined by the localization. `endDay`: Number (default `6`) - Set the last visible weekday of the view. Sunday is 0, Monday is 1, etc. `startTime`: String (default `00:00`) - Set the start time of schedule column. Hours and minutes can be specified in the string, example: `'09:30'`. `endTime`: String (default `24:00`) - Set the end time of schedule column. Hours and minutes can be specified in the same string, example: `'18:30'`. `timeCellStep`: Number (default `60`) - Set the step of the grid cells in minutes. Supported values: 1, 5, 10, 15, 20, 30, 60, 120, 180, 240, 360, 480, 720, 1440. `timeLabelStep`: Number (default `60`) - Set the step of the time labels in minutes. Supported values: 1, 5, 10, 15, 20, 30, 60, 120, 180, 240, 360, 480, 720, 1440. `timeline`: Object - Configures the timeline view. If omitted, no timeline will be displayed. Properties: `type`: String (default `'week'`) - Sets the timeline type. Possible values: `'day'`, `'week'` , `'month'`. `size`: Number - Specifies the number of displayed days/weeks/months. `eventList`: Boolean (default `false`) - If true, transforms the hour-by-hour layout into a daily summary view. The events are listed under the appropriate day one after the other. `startDay`: Number (default `0`) - Set the first visible weekday of the view. Sunday is 0, Monday is 1, etc. Days outside of the `startDay` and `endDay` range will not be visible. Should not be mistaken for the firstDay option, which sets the first day of the week, and, if not set, is defined by the localization. `endDay`: Number (default `6`) - Set the last visible weekday of the view. Sunday is 0, Monday is 1, etc. `rowHeight`: String (default `'variable'`) - Controls the height of the timeline view rows. By default timeline rows will have `'variable'` height and will expand to accommodate the displayed events. If it is set to `'equal'`, the rows will have equal heights. `startTime`: String (default `00:00`) - Set the start time of timeline days. Hours and minutes can be specified in the string, example: `'09:30'`. `endTime`: String (default `24:00`) - Set the end time of timeline days. Hours and minutes can be specified in the same string, example: `'18:30'`. `timeCellStep`: Number (default `60`) - Set the step of the grid cells in minutes. Supported values: 1, 5, 10, 15, 20, 30, 60, 120, 180, 240, 360, 480, 720, 1440. `timeLabelStep`: Number (default `60`) - Set the step of the time labels in minutes. Supported values: 1, 5, 10, 15, 20, 30, 60, 120, 180, 240, 360, 480, 720, 1440. `weekNumbers`: Boolean (default `false`) - Show or hide week numbers. Example `view: { calendar: { type: 'week', size: 2 }, agenda: { type: 'week', size: 2 } }`
width	Number, String	`undefined`	Sets the width of the popup container. This will take no effect in inline display mode.

Setting options dynamically

To make an option dynamic, you can pass a variable as option value. Whenever the value of the variable changes, the component will be re-rendered.

const App = () => {
        
  const [myTheme, setMyTheme] = useState('ios');

  const changeTheme = useCallback(() => {
    // Changes the theme to Material
    setMyTheme('material');
  }, []);

  return <div>
    <Eventcalendar theme={myTheme} />
    <button onClick={changeTheme}>Change theme</button>
  </div>;
};

For performance reasons on re-render we compare prop values by reference. This means, that in case of options, which accept complex data structures, like arrays or objects, changes made inside the array or object won't be detected. To ensure the change is detected, always pass a new array or object reference.

Events

Name	Description
onCellClick(event, inst)	Triggered when a cell is clicked on the calendar scheduler, or timeline grid . Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the clicked cell. `domEvent`: Event The DOM event of the click. `events`: Array - The events for the clicked date. `resource`: String, Number - The id of the resource where the cell was clicked, if resources are set. `selected`: Boolean - Specifies if the day is currently selected or not (before it was clicked). `source`: String - The view where the cell was clicked, `'calendar'`, `'schedule'` or `'timeline'`. `target`: HTMLElement - The DOM element of the clicked cell. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onCellClick={function (event, inst) { }} />`
onCellDoubleClick(event, inst)	Triggered when a cell is double-clicked on the calendar scheduler, or timeline grid . This event will only trigger on desktop environment where mouse events are fired. Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the clicked cell. `domEvent`: Event The DOM event of the click. `events`: Array - The events for the clicked date. `resource`: String, Number - The id of the resource where the cell was clicked, if resources are set. `selected`: Boolean - Specifies if the day is currently selected or not (before it was clicked). `source`: String - The view where the cell was clicked, `'calendar'`, `'schedule'` or `'timeline'`. `target`: HTMLElement - The DOM element of the clicked cell. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onCellDoubleClick={function (event, inst) { }} />`
onCellHoverIn(event, inst)	Triggered when the mouse pointer hovers a day on the calendar. (does not apply for agenda, schedule and timeline views). Parameters `event`: Object - The event object has the following properties: date: The selected date as a Date object. events: The events for the hovered day. labels: If the day has labels, contains the label objects for the hovered day. marked: If the day is marked, contains the marked objects for the hovered day. selected: Specifies if the day is currently selected or not. target: The table cell HTML DOM element. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onCellHoverIn={function (event, inst) { }} />`
onCellHoverOut(event, inst)	Triggered when the mouse pointer leaves a day on the calendar. (does not apply for agenda, schedule and timeline views). Parameters `event`: Object - The event object has the following properties: date: The selected date as a Date object. events: The events for the hovered day. labels: If the day has labels, contains the label objects for the hovered day. marked: If the day is marked, contains the marked objects for the hovered day. selected: Specifies if the day is currently selected or not. target: The table cell HTML DOM element. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onCellHoverOut={function (event, inst) { }} />`
onCellRightClick(event, inst)	Triggered when a cell is right-clicked on the calendar scheduler, or timeline grid . Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the clicked cell. `domEvent`: Event The DOM event of the click. `events`: Array - The events for the clicked date. `resource`: String, Number - The id of the resource where the cell was clicked, if resources are set. `selected`: Boolean - Specifies if the day is currently selected or not (before it was clicked). `source`: String - The view where the cell was clicked, `'calendar'`, `'schedule'` or `'timeline'`. `target`: HTMLElement - The DOM element of the clicked cell. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onCellRightClick={function (event, inst) { }} />`
onDestroy(event, inst)	Triggered when the component is destroyed. Parameters `event`: Object - The event object. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onDestroy={function (event, inst) { }} />`
onEventClick(event, inst)	Triggered when an event is clicked. Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the day on which the event was clicked. `domEvent`: Event - The DOM event of the click. `event`: Object - The clicked calendar event. `resource`: String, Number - The id of the resource where the event was clicked, if resources are set. `source`: String - The view where the event was clicked, `'agenda'`, `'calendar'`, `'schedule'`, `'timeline'` or `'popover'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventClick={function (event, inst) { }} />`
onEventCreate(event, inst)	Triggered when an event is about to create. Event creation can be prevented by returning false from the handler function. Parameters `event`: Object - The event object has the following properties: `action`: String - The action which created the event (`'click'`, `'drag'` or `'externalDrop'`). `domEvent`: Event - The DOM event from the end of the gesture (`mouseup` or `touchend`). `event`: Object - The newly created event object. `originEvent`: Object - The occurrence of the event which was dragged. Will be set only if the event was created by dragging a recurring event occurrence. `source`: String - The view where the event is being created, `'calendar'`, `'timeline'` or `'schedule'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventCreate={function (event, inst) { }} />`
onEventCreated(event, inst)	Triggered when an event is created is rendered in its position. Parameters `event`: Object - The event object has the following properties: `action`: String - The action which created the event (`'click'`, `'drag'` or `'externalDrop'`). `event`: Object - The newly created event object. `source`: String - The view where the event was created, `'calendar'`, `'timeline'` or `'schedule'`. `target`: HTMLElement - The DOM element of the created event. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventCreated={function (event, inst) { }} />`
onEventCreateFailed(event, inst)	Triggered when an event is interacted with a blocked out date during the creation. Parameters `event`: Object - The event object has the following properties: `action`: String - The action which created the event (`'click'`, `'drag'` or `'externalDrop'`). `event`: Object - The newly created event object. `invalid`: Object - The invalid object which the event interacted with. `originEvent`: Object - The occurrence of the event which was dragged. Will be set only if the event was created by dragging a recurring event occurrence. `source`: String - The view where the event was created, `'calendar'`, `'timeline'` or `'schedule'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventCreateFailed={function (event, inst) { }} />`
onEventDelete(event, inst)	Triggered when an event is about to be deleted. Event deletion can be performed with delete and backspace button on an active event. Deletion can be prevented by returning false from the handler function. Parameters `event`: Object - The event object has the following properties: `domEvent`: Event - The DOM event from the `onKeyDown` action. `event`: Object - The deleted event's data object. `source`: String - The view where the event is being deleted, `'calendar'`, `'timeline'` or `'schedule'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventDelete={function (event, inst) { }} />`
onEventDeleted(event, inst)	Triggered when an event is deleted and it is removed from it's position. Parameters `event`: Object - The event object has the following properties: `event`: Object - The deleted event's data object. `source`: String - The view where the event was deleted, `'calendar'`, `'timeline'` or `'schedule'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventDeleted={function (event, inst) { }} />`
onEventDoubleClick(event, inst)	Triggered when an event is double-clicked. This event will only trigger on desktop environment where mouse events are fired. Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the day on which the event was clicked. `domEvent`: Event - The DOM event of the click. `event`: Object - The clicked calendar event. `resource`: String, Number - The id of the resource where the event was clicked, if resources are set. `source`: String - The view where the event was clicked, `'agenda'`, `'calendar'`, `'schedule'`, `'timeline'` or `'popover'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventDoubleClick={function (event, inst) { }} />`
onEventHoverIn(event, inst)	Triggered when the mouse pointer hovers an event on the calendar. Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the day on which the event was hovered. `domEvent`: Event - The DOM event of the hover. `event`: Object - The hovered calendar event. `resource`: String, Number - The id of the resource where the event was hovered, if resources are set. `source`: String - The view where the event was hovered, `'agenda'`, `'calendar'`, `'schedule'`, `'timeline'` or `'popover'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventHoverIn={function (event, inst) { }} />`
onEventHoverOut(event, inst)	Triggered when the mouse pointer leaves an event on the calendar. Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the day on which the event was hovered. `domEvent`: Event - The DOM event of the hover. `event`: Object - The hovered calendar event. `resource`: String, Number - The id of the resource where the event was hovered, if resources are set. `source`: String - The view where the event was hovered, `'agenda'`, `'calendar'`, `'schedule'`, `'timeline'` or `'popover'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventHoverOut={function (event, inst) { }} />`
onEventRightClick(event, inst)	Triggered when an event is right-clicked. Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the day on which the event was clicked. `domEvent`: Event - The DOM event of the right click. `event`: Object - The clicked calendar event. `resource`: String, Number - The id of the resource where the event was clicked, if resources are set. `source`: String - The view where the event was clicked, `'agenda'`, `'calendar'`, `'schedule'`, `'timeline'` or `'popover'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventRightClick={function (event, inst) { }} />`
onEventUpdate(event, inst)	Triggered when an event is about to update. Update can be prevented by returning false from the handler function. Parameters `event`: Object - The event object has the following properties: `domEvent`: Event - The DOM event from the end of the gesture (`mouseup` or `touchend`). `newEvent`: Object - The newly created event object. Will be set only if the dragged event was a recurring event occurrence. `event`: Object - The updated event object. `oldEvent`: Object - The original event object before the update. `oldEventOccurrence`: Object - The occurrence of the event which was dragged. Will be set only if the dragged event was a recurring event occurrence. `source`: String - The view where the event is being updated, `'calendar'`, `'timeline'` or `'schedule'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventUpdate={function (event, inst) { }} />`
onEventUpdated(event, inst)	Triggered when an event is updated and is rendered in its new position. This is where you update the event in your database or persistent storage. Parameters `event`: Object - The event object has the following properties: `event`: Object - The updated event object. `oldEvent`: Object - The original event object before the update. `source`: String - The view where the event was updated, `'calendar'`, `'timeline'` or `'schedule'`. `target`: HTMLElement - The DOM element of the created event. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventUpdated={function (event, inst) { }} />`
onEventUpdateFailed(event, inst)	Triggered when an event is interacted with a blocked out date at drop or resize. Parameters `event`: Object - The event object has the following properties: `event`: Object - The updated event object. `newEvent`: Object - The newly created event object. Will be set only if the dragged event was a recurring event occurrence. `oldEvent`: Object - The original event object before the update. `oldEventOccurrence`: Object - The occurrence of the event which was dragged. Will be set only if the dragged event was a recurring event occurrence. `invalid`: Object - The invalid object which the event interacted with. `source`: String - The view where the event was updated, `'calendar'`, `'timeline'` or `'schedule'`. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onEventUpdateFailed={function (event, inst) { }} />`
onInit(event, inst)	Triggered when the component is initialized. Parameters `event`: Object - The event object. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onInit={function (event, inst) { }} />`
onLabelClick(event, inst)	Triggered when a label on the calendar is clicked. Parameters `event`: Object - The event object has the following properties: `date`: Date - The date of the day on which the label was clicked. `domEvent`: Event - The DOM event of the click. `label`: Object - The original object of the label which was clicked, `undefined` in case of the "more" label. `labels`: Array - An array containing each label object for the given day. `target`: HTMLElement - The DOM element of the label. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onLabelClick={function (event, inst) { }} />`
onPageChange(event, inst)	Triggered when the calendar page is changed (month or week, with buttons or swipe). Parameters `event`: Object - The event object has the following property: `firstDay`: Date - The first day of the displayed page. `lastDay`: Date - The last day of the displayed page. `month`: Date - The first day of the visible month in case of month view. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onPageChange={function (event, inst) { }} />`
onPageLoaded(event, inst)	Triggered when the calendar page is changed (month or week, with buttons or swipe) and the animation has finished. Parameters `event`: Object - The event object has the following property: `firstDay`: Date - The first day of the displayed page. `lastDay`: Date - The last day of the displayed page. `month`: Date - The first day of the visible month in case of month view. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onPageLoaded={function (event, inst) { }} />`
onPageLoading(event, inst)	Triggered before the markup of a calendar page (month or week) is starting to render. Parameters `event`: Object - The event object has the following property: `firstDay`: Date - The first day of the displayed page. `lastDay`: Date - The last day of the displayed page. `month`: Date - The first day of the visible month in case of month view. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onPageLoading={function (event, inst) { }} />`
onSelectedDateChange(event, inst)	Triggered when the selected date is changed, e.g. by clicking on a day on a calendar view, or by using the navigation arrows. You can use this in conjunction with the selectedDate option when used as a controlled component. Parameters `event`: Object - The event object has the following properties: date: Date - The selected date. `inst`: Object - The instance object of the eventcalendar. Example `<mobiscroll.Eventcalendar onSelectedDateChange={function (event, inst) { }} />`

Methods

Name	Description
getEvents([startDate, endDate])	Returns the event data between two dates. If startDate and endDate are not specified, it defaults to the start and end days of the current view. If endDate is not specified, it defaults to startDate + 1 day. Parameters `startDate` (Optional): Date - Start date of the specified interval. `endDate` (Optional): Date - End date of the specified interval. Returns: Array An array containing the event objects. Example Methods can be called on an instance. For more details see calling methods `mobiscrollInstance.getEvents();`
getInvalids([startDate, endDate])	Returns the invalids between two dates. If startDate and endDate are not specified, it defaults to the start and end days/times of the current view. If endDate is not specified, it defaults to startDate + 1 day. Parameters `startDate` (Optional): Date - Start date of the specified interval. `endDate` (Optional): Date - End date of the specified interval. Returns: Array An array containing the invalid objects. Example `mobiscrollInstance.getInvalids();`
print(config)	Prints the Eventcalendar, when the print module is properly set up. `eventCalendarInstance.print();` The Print Module is an optional module, that includes styles and functions for printing. It can be installed and used with the Eventcalendar as described in the Print Module section. Parameters The print method can be passed a config object as parameter, that supports the following properties: `config.baseUrl`: String - The base url for the styles and links if you are using relative paths.

Localization

Name	Type	Default value	Description
allDayText	String	`'All-day'`	Text for all day events.
amText	String	`'am'`	Text for AM.
dateFormat	String	`'MM/DD/YYYY'`	The format for parsed and displayed dates. `M` - month of year (no leading zero) `MM` - month of year (two digit) `MMM` - month name short `MMMM` - month name long `D` - day of month (no leading zero) `DD` - day of month (two digit) `DDD` - day of week (short) `DDDD` - day of week (long) `YY` - year (two digit) `YYYY` - year (four digit) `'...'` - literal text `''` - single quote anything else - literal text
dateFormatFull	String	`'DDDD, MMMM D, YYYY'`	Human readable date format, used by screen readers to read out full dates. Characters have the same meaning as in the dateFormat option.
dateFormatLong	String	`'D DDD MMM YYYY'`	Long date format, used by the agenda view day headers. Characters have the same meaning as in the dateFormat option.
dayNames	Array	`['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']`	The list of long day names, starting from Sunday, for use as requested via the dateFormat setting.
dayNamesMin	Array	`['S', 'M', 'T', 'W', 'T', 'F', 'S']`	The list of minimal day names, starting from Sunday, for use as requested via the dateFormat setting.
dayNamesShort	Array	`['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']`	The list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat setting.
eventsText	String	`'events'`	Text for the events word (plural).
eventText	String	`'event'`	Text for the event word.
firstDay	Number	`0`	Set the first day of the week: Sunday is 0, Monday is 1, etc.
locale	Object	`undefined`	Sets the language of the component. The locale option is an object containing all the translations for a given language. Mobiscroll supports a number of languages listed below. If a language is missing from the list, it can also be provided by the user. Here's a guide on how to write language modules. Supported languages: Arabic: `localeAr`, `'ar'` Bulgarian: `localeBg`, `'bg'` Catalan: `localeCa`, `'ca'` Czech: `localeCs`, `'cs'` Chinese: `localeZh`, `'zh'` Croatian: `localeHr`, `'hr'` Danish: `localeDa`, `'da'` Dutch: `localeNl`, `'nl'` English: `localeEn` or `undefined`, `'en'` English (UK): `localeEnGB`, `'en-GB'` Farsi: `localeFa`, `'fa'` German: `localeDe`, `'de'` Greek: `localeEl`, `'el'` Spanish: `localeEs`, `'es'` Finnish: `localeFi`, `'fi'` French: `localeFr`, `'fr'` Hebrew: `localeHe`, `'he'` Hindi: `localeHi`, `'hi'` Hungarian: `localeHu`, `'hu'` Italian: `localeIt`, `'it'` Japanese: `localeJa`, `'ja'` Korean: `localeKo`, `'ko'` Lithuanian: `localeLt`, `'lt'` Norwegian: `localeNo`, `'no'` Polish: `localePl`, `'pl'` Portuguese (Brazilian): `localePtBR`, `'pt-BR'` Portuguese (European): `localePtPT`, `'pt-PT'` Romanian: `localeRo`, `'ro'` Russian: `localeRu`, `'ru'` Russian (UA): `localeRuUA`, `'ru-UA'` Slovak: `localeSk`, `'sk'` Serbian: `localeSr`, `'sr'` Swedish:`localeSv`, `'sv'` Thai: `localeTh`, `'th'` Turkish: `localeTr`, `'tr'` Ukrainian: `localeUa`, `'ua'` Vietnamese: `localeVi`, `'vi'` `import { Eventcalendar, localeDe } from '@mobiscroll/react'; export function MyComponent() { return <Eventcalendar locale={localeDe} />; }` In some cases it's more convenient to set the locale using the language code string. You can do that by using the `locale` object, which contains all translations by language codes as keys. The `locale` object is not tree-shakeable, meaning that all translations present in the object will end up in the application bundle, whether it's being used or not. `import { Eventcalendar, locale } from '@mobiscroll/react'; export function MyComponent() { return <Eventcalendar locale={locale['de']} />; }`
monthNames	Array	`['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']`	The list of full month names, for use as requested via the dateFormat setting.
monthNamesShort	Array	`['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']`	The list of abbreviated month names, for use as requested via the dateFormat setting.
moreEventsPluralText	String	`undefined`	Text for the "more" label on the calendar, when there's not enough space to display all the labels for the day, and there are more than one extra labels. The `{count}` inside the string will be replaced with the number of extra labels. When not specified, the moreEventsText setting is used for both plural and singular form.
moreEventsText	String	`'{count} more'`	Text for the "more" label on the calendar, when there's not enough space to display all the labels for the day. The `{count}` inside the string will be replaced with the number of extra labels. Use the moreEventsPluralText as well, if the plural form is different.
newEventText	String	`New Event`	Title text for the newly created event with the dragToCreate action.
noEventsText	String	`'No events'`	Text for empty event list.
pmText	String	`'pm'`	Text for PM.
rtl	Boolean	`false`	Right to left display.
timeFormat	String	`'hh:mm A'`	The format for parsed and displayed dates `h` - 12 hour format (no leading zero) `hh` - 12 hour format (leading zero) `H` - 24 hour format (no leading zero) `HH` - 24 hour format (leading zero) `m` - minutes (no leading zero) `mm` - minutes (leading zero) `s` - seconds (no leading zero) `ss` - seconds (leading zero) `a` - lowercase am/pm `A` - uppercase AM/PM `'...'` - literal text `''` - single quote anything else - literal text
todayText	String	`'Today'`	Label for the "Today" button.
weekText	String	`'Week {count}'`	Text for week numbers in the timeline header. The `{count}` inside the string will be replaced with the number of the current week.

Customizing the appearance

While the provided pre-built themes are enough in many use cases, most of the times on top of adapting to a specific platform, you'd also like to match a brand or color scheme. Mobiscroll provides various ways to achieve this:

Create custom themes using the theme builder - the custom themes can be also built using out theme builder, on a graphical user interface, without any coding, or the need for Sass support in your project.
Create custom themes using Sass - use this, if you need multiple themes with different color variatons, in case you have pages with different colors, or you'd like to users to customize the colors of your app.
Override the Sass color variables - the straightforward way to change the colors in one place throughout the application.

Override the Sass Color Variables

A convenient way to customize the colors of the Mobiscroll components is to override the Sass color variables.

Let's say your branding uses a nice red accent color, and you'd like that color to appear on the Mobiscroll components as well, while still using platform specific themes (e.g. ios on iOS devices, material on Android devices, and mobiscroll on desktop). You can override the accent color for every theme:

$mbsc-ios-accent: #e61d2a;
$mbsc-material-accent: #e61d2a;
$mbsc-mobiscroll-accent: #e61d2a;

@import "~@mobiscroll/React/dist/css/mobiscroll.react.scss"

It's important that you override the variables BEFORE the scss file import, otherwise it won't make any difference.

Here's a complete guide on how to set up Mobiscroll with SASS support

You can also customize the colors on many levels:

Theme specific variables (ex. $mbsc-material-background, $mbsc-ios-dark-text) are applied to all components in a theme. Complete list of variables here.
Component specific global variables (ex. $mbsc-card-background-light, $mbsc-listview-text-dark) are applied to all themes for a specific component.
Component and theme specific variables (ex. $mbsc-ios-dark-form-background, $mbsc-material-input-text) are applied to a specific theme and a specific component.

Global variables

These variables are applied to all base themes: iOS, material, windows and mobiscroll.
They all come in pairs. One for the light and one for the dark variant in each theme.

Variable name	Description
$mbsc-calendar-background-light	Sets the background color of the Eventcalendar
$mbsc-calendar-background-dark	Sets the background color of the Eventcalendar
$mbsc-calendar-text-light	Sets the text color of the Eventcalendar
$mbsc-calendar-text-dark	Sets the text color of the Eventcalendar
$mbsc-calendar-accent-light	Sets the accent color of the Eventcalendar
$mbsc-calendar-accent-dark	Sets the accent color of the Eventcalendar
$mbsc-calendar-border-light	Sets the color of the border
$mbsc-calendar-border-dark	Sets the color of the border
$mbsc-calendar-mark-light	Sets the default color of the mark on marked days
$mbsc-calendar-mark-dark	Sets the default color of the mark on marked days

If you really want to get sophisticated or if a color doesn't look good on a specific theme and you want to overwrite it, you can fine tune all of the above variables individually for each theme. Below are the complete list of variables broken down to themes:

iOS theme

Variable name	Default value	Description
$mbsc-ios-calendar-background	#f7f7f7	The Eventcalendar background color
$mbsc-ios-calendar-text	#000000	The Eventcalendar text color
$mbsc-ios-calendar-accent	#007bff	The Eventcalendar accent color
$mbsc-ios-calendar-border	#cccccc	Sets the color of the border
$mbsc-ios-calendar-mark	#cccccc	Sets the default color of the mark on marked days

iOS Dark theme

$mbsc-ios-dark-calendar-background	##000000	The Eventcalendar background color
$mbsc-ios-dark-calendar-text	#ffffff	The Eventcalendar text color
$mbsc-ios-dark-calendar-accent	#ff8400	The Eventcalendar accent color
$mbsc-ios-dark-calendar-border	#333333	Sets the color of the border
$mbsc-ios-dark-calendar-mark	#333333	Sets the default color of the mark on marked days

Calendar view

Indication on what the color variables affect

Agenda view

Schedule view

Windows theme

Variable name	Default value	Description
$mbsc-windows-calendar-background	#ffffff	The Eventcalendar background color
$mbsc-windows-calendar-text	#333333	The Eventcalendar text color
$mbsc-windows-calendar-accent	#0078d7	The Eventcalendar accent color
$mbsc-windows-calendar-border	#e6e6e6	Sets the color of the border
$mbsc-windows-calendar-mark	rgba(51, 51, 51, 0.5);	Sets the default color of the mark on marked days

Windows Dark theme

Variable name	Default value	Description
$mbsc-windows-dark-calendar-background	#1a1a1a	The Eventcalendar background color
$mbsc-windows-dark-calendar-text	#ffffff	The Eventcalendar text color
$mbsc-windows-dark-calendar-accent	#0078d7	The Eventcalendar accent color
$mbsc-windows-dark-calendar-border	#343434	Sets the color of the border
$mbsc-windows-dark-calendar-mark	rgba(255, 255, 255, 0.5);	Sets the default color of the mark on marked days

Calendar view

Agenda view

Schedule view

Material theme

Variable name	Default value	Description
$mbsc-material-calendar-background	#ffffff	The Eventcalendar background color
$mbsc-material-calendar-text	#303030	The Eventcalendar text color
$mbsc-material-calendar-accent	#1a73e8	The Eventcalendar accent color
$mbsc-material-calendar-border	#cfcfcf	Sets the color of the border
$mbsc-material-calendar-mark	##1a73e8	Sets the default color of the mark on marked days

Material Dark theme

Variable name	Default value	Description
$mbsc-material-dark-calendar-background	#000000	The Eventcalendar background color
$mbsc-material-dark-calendar-text	#ffffff	The Eventcalendar text color
$mbsc-material-dark-calendar-accent	#87b0f3	The Eventcalendar accent color
$mbsc-material-dark-calendar-border	#2b2b2b	Sets the color of the border
$mbsc-material-dark-calendar-mark	#87b0f3	Sets the default color of the mark on marked days

Event calendar

Scheduler

Timeline

Agenda

Mobile UI Patterns

Docs

Community Forum

Knowledge base

Customers

Blog

Event calendar

Scheduler

Timeline

Agenda

Mobile UI Patterns

Docs

Community Forum

Knowledge base

Customers

Blog

Event Calendar

Basic usage

Data binding

Local data

Remote data

Load on demand

Recurrence

Examples

Recurring exceptions

CRUD actions

Parameters

Views

Calendar view

Schedule view

Timeline view

Agenda view

Setting the initial view

Controlled component

Uncontrolled component

Navigating to a date and time

Events drag/resize/create

External drag & drop

Drag & drop events onto the calendar

Resources

Resource grouping & hierarchy

Resource templating

Slots

Blocked out dates

Customizing the events

Customize the full event

Customize the event content

Examples

Taking over the listing

Customizing the header

Timezones

Library Install

The Moment-Timezone library

The Luxon library

Using timezones

Exclusive end dates

Print Module

Installing the Print Module

Importing the Print Module

Stylesheets

JavaScript

Printing

Options

Properties

Example

Setting options dynamically

Events

Parameters

Example

Parameters

Example

Parameters

Example

Parameters

Example

Parameters

Example

Parameters

Example

Parameters

Example

Parameters

Example

Parameters

Example

Parameters