Full-sized drag & drop JavaScript event calendar with resource & timeline views:
- Lightweight (36kb br compressed)
- Zero-dependency (pre-built bundle)
- Used on over 70,000 websites with Bookly
Inspired by FullCalendar, implements similar options.
The first step is to install the Event Calendar core
package:
npm install --save-dev @event-calendar/core
Then install any additional plugins you plan to use:
npm install --save-dev @event-calendar/time-grid
You must use at least one plugin that provides a view. The following plugins are currently available:
@event-calendar/day-grid
@event-calendar/list
@event-calendar/resource-timeline
@event-calendar/resource-time-grid
@event-calendar/time-grid
@event-calendar/interaction
(doesn't provide a view)
Then, in your JavaScript module:
import Calendar from '@event-calendar/core';
import TimeGrid from '@event-calendar/time-grid';
// Import CSS if your build tool supports it
import '@event-calendar/core/index.css';
let ec = new Calendar({
target: document.getElementById('ec'),
props: {
plugins: [TimeGrid],
options: {
view: 'timeGridWeek',
events: [
// your list of events
]
}
}
});
Or in your Svelte component, use the calendar like this:
<script>
import Calendar from '@event-calendar/core';
import TimeGrid from '@event-calendar/time-grid';
let plugins = [TimeGrid];
let options = {
view: 'timeGridWeek',
events: [
// your list of events
]
};
</script>
<Calendar {plugins} {options} />
Include the following lines of code in the <head>
section of your page:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@event-calendar/build@3.6.2/event-calendar.min.css">
<script src="https://cdn.jsdelivr.net/npm/@event-calendar/build@3.6.2/event-calendar.min.js"></script>
Note
Please note that the file paths contain an indication of a specific version of the library. You can remove this indication, then the latest version will be loaded:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@event-calendar/build/event-calendar.min.css"> <script src="https://cdn.jsdelivr.net/npm/@event-calendar/build/event-calendar.min.js"></script>But it is recommended to always specify the version and explicitly update it if necessary, in order to avoid unpredictable problems when a new version of the library is released.
Then initialize the calendar like this:
let ec = new EventCalendar(document.getElementById('ec'), {
view: 'timeGridWeek',
events: [
// your list of events
]
});
You can modify the calendar options after initialization using the setOption method.
ec.setOption('slotDuration', '01:00');
In Svelte, you can simply update the original options
object.
<script>
import Calendar from '@event-calendar/core';
import TimeGrid from '@event-calendar/time-grid';
let plugins = [TimeGrid];
let options = {
view: 'timeGridWeek'
};
function updateOptions() {
options.slotDuration = '01:00';
}
</script>
<button on:click={updateOptions}>Change slot duration</button>
<Calendar {plugins} {options} />
- Type
Content
orfunction
- Default
'all-day'
Defines the content that is displayed as a title of the all-day
slot.
This value can be either a Content or a function that returns content:
function (arg) {
// return Content
}
arg
is an object with the following properties:
|
The default text |
- Type
boolean
- Default
true
Determines whether the all-day
slot is displayed at the top of the calendar.
When hidden with false
, all-day events will not be displayed in timeGrid
/resourceTimeGrid
views.
- Type
object
orfunction
- Default
{close: 'Close', dayGridMonth: 'month', listDay: 'list', listMonth: 'list', listWeek: 'list', listYear: 'list', resourceTimeGridDay: 'resources', resourceTimeGridWeek: 'resources', resourceTimelineDay: 'timeline', resourceTimelineMonth: 'timeline', resourceTimelineWeek: 'timeline', timeGridDay: 'day', timeGridWeek: 'week', today: 'today'}
Views override the default value as follows:
- dayGridMonth
text => ({...text, next: 'Next month', prev: 'Previous month'})
- listDay
text => ({...text, next: 'Next day', prev: 'Previous day'})
- listMonth
text => ({...text, next: 'Next month', prev: 'Previous month'})
- listWeek
text => ({...text, next: 'Next week', prev: 'Previous week'})
- listYear
text => ({...text, next: 'Next year', prev: 'Previous year'})
- resourceTimeGridDay
text => ({...text, next: 'Next day', prev: 'Previous day'})
- resourceTimeGridWeek
text => ({...text, next: 'Next week', prev: 'Previous week'})
- resourceTimelineDay
text => ({...text, next: 'Next day', prev: 'Previous day'})
- resourceTimelineMonth
text => ({...text, next: 'Next month', prev: 'Previous month'})
- resourceTimelineWeek
text => ({...text, next: 'Next week', prev: 'Previous week'})
- timeGridDay
text => ({...text, next: 'Next day', prev: 'Previous day'})
- timeGridWeek
text => ({...text, next: 'Next week', prev: 'Previous week'})
Text that is displayed in buttons of the header toolbar.
This value can be either a plain object with all necessary properties, or a callback function that receives default button text object and should return a new one:
function (text) {
// return new button text object
}
|
An object with default button text |
- Type
object
- Default
{}
Defines custom buttons that can be used in the headerToolbar.
First, specify the custom buttons as key-value pairs. Then reference them from the headerToolbar
option.
Example
let options = {
customButtons: {
myCustomButton: {
text: 'custom!',
click: function() {
alert('clicked the custom button!');
}
}
},
headerToolbar: {
start: 'title myCustomButton',
center: '',
end: 'today prev,next'
}
};
Each customButton
entry accepts the following properties:
|
The text to be display on the button itself. See Content |
|
A callback function that is called when the button is clicked. Accepts one argument mouseEvent |
|
If |
- Type
Date
orstring
- Default
new Date()
Date that is currently displayed on the calendar.
This value can be either a JavaScript Date object, or an ISO8601 date string like '2022-12-31'
.
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when the user clicks on a date or a time.
function (info) {}
info
is an object with the following properties:
|
JavaScript Date object for the clicked date and time |
|
ISO8601 string representation of the date |
|
|
|
HTML element that represents the whole-day that was clicked on |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
|
If the current view is a resource view, the Resource object that owns this date |
- Type
boolean
- Default
false
Determines whether the resource view should render the date headings above the resource headings.
- Type
function
- Default
undefined
Callback function that is triggered when the date range of the calendar was originally set or changed by clicking the previous/next buttons, changing the view, manipulating the current date via the API, etc.
function (info) {}
info
is an object with the following properties:
|
JavaScript Date object for the beginning of the range the calendar needs events for |
|
JavaScript Date object for the end of the range the calendar needs events for. Note: This value is exclusive |
|
ISO8601 string representation of the start date |
|
ISO8601 string representation of the end date |
|
The current View object |
- Type
object
orfunction
- Default
{day: 'numeric'}
Defines the text that is displayed inside the day cell in the dayGrid
view.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns a Content with the formatted string:
function (date) {
// return Content with the formatted date string
}
|
JavaScript Date object that needs to be formatted |
- Type
object
orfunction
- Default
{dateStyle: 'long'}
Views override the default value as follows:
- dayGridMonth
{weekday: 'long'}
Defines the text that is used inside the aria-label
attribute in calendar column headings.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns formatted string:
function (date) {
// return formatted date string
}
|
JavaScript Date object that needs to be formatted |
- Type
object
orfunction
- Default
{weekday: 'short', month: 'numeric', day: 'numeric'}
Views override the default value as follows:
- dayGridMonth
{weekday: 'short'}
- resourceTimelineMonth
{weekday: 'short', day: 'numeric'}
- timeGridDay
{weekday: 'long'}
Defines the text that is displayed on the calendar’s column headings.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns a Content with the formatted string:
function (date) {
// return Content with the formatted date string
}
|
JavaScript Date object that needs to be formatted |
- Type
boolean
- Default
false
Determines the maximum number of stacked event levels for a given day in the dayGrid
view.
If there are too many events, a link like +2 more
is displayed.
Currently, only the value true
is supported, which limits the number of events to the height of the day cell.
- Type
object
orfunction
- Default
{month: 'long', day: 'numeric', year: 'numeric'}
Defines the date format of title of the popover created by the dayMaxEvents option.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns a Content with the formatted string:
function (date) {
// return Content with the formatted date string
}
- Type
boolean
- Default
true
Views override the default value as follows:
- dayGridMonth
false
- resourceTimelineDay
false
- resourceTimelineMonth
false
- resourceTimelineWeek
false
Determines whether to display an event’s end time.
- Type
boolean
- Default
true
- Requires
Interaction
plugin
Determines whether the calendar should automatically scroll during the event drag-and-drop when the mouse crosses the edge.
- Type
string
,integer
orobject
- Default
{weeks: 1}
Views override the default value as follows:
- dayGridMonth
{months: 1}
- listDay
{days: 1}
- listMonth
{months: 1}
- listYear
{years: 1}
- resourceTimeGridDay
{days: 1}
- resourceTimelineDay
{days: 1}
- resourceTimelineMonth
{months: 1}
- timeGridDay
{days: 1}
Sets the duration of a view.
This should be a value that can be parsed into a Duration object.
- Type
boolean
- Default
false
- Requires
Interaction
plugin
Determines whether the events on the calendar can be dragged and resized (both at the same time).
If you don't need both, use the more specific eventStartEditable and eventDurationEditable instead.
- Type
array
- Default
[]
Array of plain objects that will be parsed into Event objects and displayed on the calendar.
This option is not used if the eventSources
option is provided.
- Type
function
- Default
undefined
Callback function that is triggered when all events have finished updating.
This is an experimental feature and its behavior may change in the future. The function is called at the end of the cycle of rendering all events. The rendering occurs when new events are added, already displayed events are modified, or events are deleted.
function (info) { }
info
is an object with the following properties:
|
The current View object |
- Type
string
- Default
undefined
Sets the default background color for events on the calendar.
You can use any of the CSS color formats such '#f00'
, '#ff0000'
, 'rgb(255,0,0)'
, or 'red'
.
- Type
string
,array
orfunction
- Default
undefined
Sets additional CSS classes for events.
This value can be either a string containing class names 'class-1 class-2 ...'
, an array of strings ['class-1', 'class-2', ...]
or a function that returns any of the above formats:
function (info) {
// return string or array
}
info
is an object with the following properties:
|
The associated Event object |
|
The current View object |
- Type
function
- Default
undefined
Callback function that is triggered when the user clicks an event.
function (info) { }
info
is an object with the following properties:
|
The HTML element for the event |
|
The associated Event object |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
string
- Default
undefined
This is currently an alias for the eventBackgroundColor
.
- Type
Content
orfunction
- Default
undefined
Defines the content that is rendered inside an event’s element.
This value can be either a Content or a function that returns content or undefined
:
function (info) {
// return Content or undefined
}
info
is an object with the following properties:
|
The associated Event object |
|
Formatted time of the event |
|
The current View object |
In case the function returns undefined
, the event will be rendered in the default way.
- Type
function
- Default
undefined
Callback function that is triggered right after the element has been added to the DOM. If the event data changes, this is not called again.
function (info) { }
info
is an object with the following properties:
|
The HTML element for the event |
|
The associated Event object |
|
Formatted time of the event |
|
The current View object |
- Type
integer
- Default
5
- Requires
Interaction
plugin
Defines how many pixels the user’s mouse must move before the event dragging begins.
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when the event dragging begins.
function (info) { }
info
is an object with the following properties:
|
The associated Event object |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when the event dragging stops.
It is triggered before the event’s information has been modified (if moved to a new date/time) and before the eventDrop callback is triggered.
function (info) { }
info
is an object with the following properties:
|
The associated Event object |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when dragging stops, and the event has moved to a different day/time.
It is triggered after the event’s information has been modified and after the eventDragStop callback has been triggered.
function (info) { }
info
is an object with the following properties:
|
The associated Event object |
|
An Event object that holds information about the event before the drop |
|
If the resource has changed, this is the Resource object the event came from. If the resource has not changed, this will be undefined |
|
If the resource has changed, this is the Resource object the event went to. If the resource has not changed, this will be undefined |
|
A Duration object that represents the amount of time the event was moved by |
|
A function that, if called, reverts the event’s start/end date to the values before the drag |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
boolean
- Default
true
- Requires
Interaction
plugin
Determines whether calendar events can be resized.
- Type
integer
- Default
undefined
- Requires
Interaction
plugin
For touch devices, the amount of time (in milliseconds) the user must hold down a tap before the event becomes draggable/resizable.
If not specified, it falls back to longPressDelay.
- Type
function
- Default
undefined
Callback function that is triggered when the user hovers over an event with the cursor (mouse pointer).
function (info) { }
info
is an object with the following properties:
|
The HTML element for the event |
|
The associated Event object |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
function
- Default
undefined
Callback function that is triggered when the cursor (mouse pointer) is moved out of an event.
function (info) { }
info
is an object with the following properties:
|
The HTML element for the event |
|
The associated Event object |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when resizing stops, and the duration of the event has changed.
It is triggered after the event’s information has been modified and after the eventResizeStop callback has been triggered.
function (info) { }
info
is an object with the following properties:
|
The associated Event object |
|
An Event object that holds information about the event before the resize |
|
A Duration object that represents the amount of time the event’s end date was moved by |
|
A function that, if called, reverts the event’s end date to the values before the resize |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when the event resizing begins.
function (info) { }
info
is an object with the following properties:
|
The associated Event object |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when the event resizing stops.
It is triggered before the event’s information has been modified (if duration is changed) and before the eventResize callback is triggered.
function (info) { }
info
is an object with the following properties:
|
The associated Event object |
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
EventSource[]
- Default
[]
Array of EventSource objects that will provide the Event Calendar with data about events.
This option is used instead of the events
option.
EventSource
should be an object with one of the following sets of properties:
|
A URL that the calendar will fetch Event objects from. HTTP requests with the following parameters will be sent to this URL whenever the calendar needs new event data:
|
||||
|
HTTP request method. Default |
||||
|
Other GET/POST data you want to send to the server. Can be a plain object or a function that returns an object. Default |
|
A custom function that is executed whenever the Event Calendar needs new event data. function(fetchInfo, successCallback, failureCallback) { }
The If there is any failure (e.g., if an AJAX request fails), then call the Instead of calling |
- Type
boolean
- Default
true
- Requires
Interaction
plugin
Determines whether the events on the calendar can be dragged.
- Type
object
orfunction
- Default
{hour: 'numeric', minute: '2-digit'}
Defines the time-text that is displayed on each event.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns a Content with the formatted string:
function (start, end) {
// return Content with the formatted time string
}
|
JavaScript Date object containing the beginning of the time span to be formatted |
|
JavaScript Date object containing the end of the time span to be formatted |
- Type
string
- Default
undefined
Sets the default text color for events on the calendar.
You can use any of the CSS color formats such '#f00'
, '#ff0000'
, 'rgb(255,0,0)'
, or 'red'
.
- Type
boolean
- Default
false
Determines whether events that do not belong to the current array of resources should be hidden in dayGrid
/timeGrid
/list
views.
- Type
boolean
- Default
false
Determines whether resources with no events for the current range should be hidden in the resource view.
- Type
integer
- Default
0
The day that each week begins at, where Sunday is 0
, Monday is 1
, etc. Saturday is 6
.
- Type
boolean
orobject
- Default
false
Determines whether slotMinTime and slotMaxTime should automatically expand when an event goes out of bounds.
If set to true
, then the decision on whether to expand the limits will be made based on the analysis of currently displayed events, but excluding background events.
If you want background events not to be ignored, then instead of true
you can pass an object with the following properties:
|
A function to determine whether a given event should be taken into account or not. function(event) {
// return true or false
}
|
- Type
object
- Default
{start: 'title', center: '', end: 'today prev,next'}
Defines the buttons and title at the top of the calendar.
An object can be supplied with properties start
,center
,end
. These properties contain strings with comma/space separated values. Values separated by a comma will be displayed adjacently. Values separated by a space will be displayed with a small gap in between. Strings can contain any of the following values:
|
A text containing the current month/week/day |
|
A button for moving the calendar back one month/week/day |
|
A button for moving the calendar forward one month/week/day |
|
A button for moving the calendar to the current month/week/day |
a view name like |
A button that will switch the calendar to a specific view |
- Type
string
- Default
undefined
Defines the height of the entire calendar.
This should be a valid CSS value like '100%'
or '600px'
.
hiddenDays
- Type
array
- Default
[]
Exclude certain days-of-the-week from being displayed, where Sunday is 0
, Monday is 1
, etc. Saturday is 6
.
- Type
array
- Default
[]
Array of dates that need to be highlighted in the calendar.
Each date can be either an ISO8601 date string like '2022-12-31'
, or a JavaScript Date object.
- Type
boolean
- Default
true
Determines when event fetching should occur.
When set to true
(the default), the calendar will only fetch events when it absolutely needs to, minimizing HTTP requests. For example, say your calendar starts out in month view, in February. The Event Calendar will fetch events for the entire month of February and store them in its internal storage. Then, say the user switches to week view and begins browsing the weeks in February. The calendar will avoid fetching events because it already has this information stored.
When set to false
, the calendar will fetch events any time the view is switched, or any time the current date changes (for example, as a result of the user clicking prev/next).
- Type
object
orfunction
- Default
{weekday: 'long'}
Defines the text on the left side of the day headings in list view.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns a Content with the formatted string:
function (date) {
// return Content with the formatted date string
}
|
JavaScript Date object that needs to be formatted |
- Type
object
orfunction
- Default
{year: 'numeric', month: 'long', day: 'numeric'}
Defines the text on the right side of the day headings in list view.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns a Content with the formatted string:
function (date) {
// return Content with the formatted date string
}
|
JavaScript Date object that needs to be formatted |
- Type
function
- Default
undefined
Callback function that is triggered when event fetching starts/stops.
function (isLoading) { }
|
|
- Type
string
- Default
undefined
Defines the locales
parameter for the native JavaScript Intl.DateTimeFormat object that the Event Calendar uses to format date and time strings in options such as dayHeaderFormat, eventTimeFormat, etc.
- Type
integer
- Default
1000
For touch devices, the amount of time (in milliseconds) the user must hold down a tap before the event becomes draggable/resizable or the date becomes selectable.
For a more granular configuration, see eventLongPressDelay and selectLongPressDelay.
- Type
Content
orfunction
- Default
undefined
Defines the text that is displayed instead of the default +2 more
created by the dayMaxEvents option.
This value can be either a Content or a function that returns content:
function (arg) {
// return Content
}
arg
is an object with the following properties:
|
The number of hidden events |
|
The default text like |
- Type
function
- Default
undefined
Callback function that is triggered when the user clicks No events area in list view.
function (info) { }
info
is an object with the following properties:
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
- Type
Content
orfunction
- Default
'No events'
Defines the text that is displayed in list view when there are no events to display.
This value can be either a Content or a function that returns content:
function () {
// return Content
}
- Type
boolean
- Default
false
Enables a marker indicating the current time in timeGrid
/resourceTimeGrid
views.
- Type
boolean
- Default
false
- Requires
Interaction
plugin
Enables mouse cursor pointer in timeGrid
/resourceTimeGrid
and other views.
- Type
array
- Default
[]
Array of plain objects that will be parsed into Resource objects for displaying in the resource view.
- Type
string
,object
orfunction
- Default
undefined
Defines the content that is rendered inside an element with a resource title.
This value can be either a Content or a function that returns content:
function (info) {
// return Content
}
info
is an object with the following properties:
|
The associated Resource object |
|
If it is a column that is within a specific date, this will be a Date object |
- Type
function
- Default
undefined
Callback function that is triggered right after the element has been added to the DOM. If the resource data changes, this is not called again.
function (info) { }
info
is an object with the following properties:
|
The HTML element for the label |
|
The associated Resource object |
|
If it is a column that is within a specific date, this will be a Date object |
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when a date/time selection is made.
function (info) { }
info
is an object with the following properties:
|
JavaScript Date object indicating the start of the selection |
|
JavaScript Date object indicating the end of the selection |
|
ISO8601 string representation of the start date |
|
ISO8601 string representation of the end date |
|
|
|
JavaScript native event object with low-level information such as click coordinates |
|
The current View object |
|
If the current view is a resource view, the Resource object that was selected |
- Type
boolean
- Default
false
- Requires
Interaction
plugin
Determines whether the user is allowed to highlight multiple days or time slots by clicking and moving the pointer.
- Type
string
- Default
undefined
- Requires
Interaction
plugin
Sets the background color for the event indicating the current selection. See selectable.
You can use any of the CSS color formats such '#f00'
, '#ff0000'
, 'rgb(255,0,0)'
, or 'red'
.
- Type
integer
- Default
undefined
- Requires
Interaction
plugin
For touch devices, the amount of time (in milliseconds) the user must hold down a tap before the date becomes selectable.
If not specified, it falls back to longPressDelay.
- Type
integer
- Default
5
- Requires
Interaction
plugin
Defines how many pixels the user’s mouse must move before the selection begins.
- Type
string
,integer
orobject
- Default
'06:00:00'
Determines how far forward the scroll pane is initially scrolled.
This should be a value that can be parsed into a Duration object.
- Type
string
,integer
orobject
- Default
'00:30:00'
Views override the default value as follows:
- resourceTimelineMonth
{days: 1}
Defines the frequency for displaying time slots.
This should be a value that can be parsed into a Duration object.
- Type
boolean
- Default
true
Determines whether events in the timeGrid
/resourceTimeGrid
views should visually overlap when they intersect in time.
If set to false
, then intersecting events will be placed next to each other.
- Type
integer
- Default
24
Defines the time slot height in pixels in the timeGrid
/resourceTimeGrid
views. When changing the setting, you must additionally override the following CSS styles:
.ec-time-grid .ec-time, .ec-time-grid .ec-line {
height: 24px; /* override this value */
}
- Type
object
orfunction
- Default
{hour: 'numeric', minute: '2-digit'}
Defines the text that will be displayed within a time slot.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns a Content with the formatted string:
function (time) {
// return Content with the formatted time string
}
|
JavaScript Date object that needs to be formatted |
- Type
string
,integer
orobject
- Default
'24:00:00'
Defines the last time slot that will be displayed for each day.
This should be a value that can be parsed into a Duration object.
- Type
string
,integer
orobject
- Default
'00:00:00'
Defines the first time slot that will be displayed for each day.
This should be a value that can be parsed into a Duration object.
- Type
integer
- Default
72
Defines the time slot width in pixels in ResourceTimeline
views. When changing the setting, you must additionally override the following CSS styles:
.ec-timeline .ec-time, .ec-timeline .ec-line {
width: 72px; /* override this value */
}
- Type
object
orfunction
- Default
{allDay: 'ec-all-day', active: 'ec-active', bgEvent: 'ec-bg-event', bgEvents: 'ec-bg-events', body: 'ec-body', button: 'ec-button', buttonGroup: 'ec-button-group', calendar: 'ec', compact: 'ec-compact', container: 'ec-container', content: 'ec-content', day: 'ec-day', dayHead: 'ec-day-head', dayFoot: 'ec-day-foot', days: 'ec-days', daySide: 'ec-day-side', draggable: 'ec-draggable', dragging: 'ec-dragging', event: 'ec-event', eventBody: 'ec-event-body', eventTag: 'ec-event-tag', eventTime: 'ec-event-time', eventTitle: 'ec-event-title', events: 'ec-events', extra: 'ec-extra', ghost: 'ec-ghost', handle: 'ec-handle', header: 'ec-header', hiddenScroll: 'ec-hidden-scroll', highlight: 'ec-highlight', icon: 'ec-icon', line: 'ec-line', lines: 'ec-lines', main: 'ec-main', noEvents: 'ec-no-events', nowIndicator: 'ec-now-indicator', otherMonth: 'ec-other-month', pointer: 'ec-pointer', popup: 'ec-popup', preview: 'ec-preview', resizer: 'ec-resizer', resizingX: 'ec-resizing-x', resizingY: 'ec-resizing-y', resource: 'ec-resource', selecting: 'ec-selecting', sidebar: 'ec-sidebar', sidebarTitle: 'ec-sidebar-title', today: 'ec-today', time: 'ec-time', times: 'ec-times', title: 'ec-title', toolbar: 'ec-toolbar', view: 'ec-timeline ec-resource-week-view', weekdays: ['ec-sun', 'ec-mon', 'ec-tue', 'ec-wed', 'ec-thu', 'ec-fri', 'ec-sat'], withScroll: 'ec-with-scroll', uniform: 'ec-uniform'}
Views override the default value as follows:
- dayGridMonth
theme => ({...theme, view: 'ec-day-grid ec-month-view'})
- listDay
theme => ({...theme, view: 'ec-list ec-day-view'})
- listMonth
theme => ({...theme, view: 'ec-list ec-month-view'})
- listWeek
theme => ({...theme, view: 'ec-list ec-week-view'})
- listYear
theme => ({...theme, view: 'ec-list ec-year-view'})
- resourceTimeGridDay
theme => ({...theme, view: 'ec-time-grid ec-resource-day-view'})
- resourceTimeGridWeek
theme => ({...theme, view: 'ec-time-grid ec-resource-week-view'})
- resourceTimelineDay
theme => ({...theme, view: 'ec-timeline ec-resource-day-view'})
- resourceTimelineMonth
theme => ({...theme, view: 'ec-timeline ec-resource-month-view'})
- resourceTimelineWeek
theme => ({...theme, view: 'ec-timeline ec-resource-week-view'})
- timeGridDay
theme => ({...theme, view: 'ec-time-grid ec-day-view'})
- timeGridWeek
theme => ({...theme, view: 'ec-time-grid ec-week-view'})
Defines the CSS classes that the Event Calendar uses to generate HTML markup.
This value can be either a plain object with all necessary properties, or a callback function that receives default theme object and should return a new one:
function (theme) {
// return actual theme object
}
|
An object with default CSS classes |
- Type
object
orfunction
- Default
{year: 'numeric', month: 'short', day: 'numeric'}
Views override the default value as follows:
- dayGridMonth
{year: 'numeric', month: 'long'}
- timeGridDay
{year: 'numeric', month: 'long', day: 'numeric'}
Defines the text that is displayed in the header toolbar’s title.
This value can be either an object with options for the native JavaScript Intl.DateTimeFormat object, or a callback function that returns a Content with the formatted string:
function (start, end) {
// return Content with the formatted date string
}
|
JavaScript Date object containing the beginning of the time span to be formatted |
|
JavaScript Date object containing the end of the time span to be formatted |
- Type
function
- Default
undefined
- Requires
Interaction
plugin
Callback function that is triggered when the current selection is cleared.
A selection can be cleared for a number of reasons:
- The user clicks away from the current selection (this does not happen when unselectAuto is
false
). - The user makes a new selection. The unselect callback will be fired before the new selection occurs.
- The user navigates forward or backward in the current view, or switches to a new view.
- The unselect method is called via the API.
function (info) { }
info
is an object with the following properties:
|
JavaScript native event object with low-level information such as click coordinates. If unselect has been triggered via the unselect method, jsEvent will be |
|
The current View object |
- Type
boolean
- Default
true
- Requires
Interaction
plugin
Determines whether clicking elsewhere on the page will clear the current selection. See selectable.
- Type
string
- Default
''
- Requires
Interaction
plugin
A CSS selector that specifies elements that will ignore the unselectAuto option.
Clicking on elements that match this CSS selector will prevent the current selection from being cleared (because of the unselectAuto option).
- Type
string
- Default
'resourceTimeGridWeek'
The view that is displayed in the calendar. Can be 'dayGridMonth'
, 'listDay'
, 'listWeek'
, 'listMonth'
, 'listYear'
, 'resourceTimeGridDay'
, 'resourceTimeGridWeek'
, 'resourceTimelineDay'
, 'resourceTimelineWeek'
, 'resourceTimelineMonth'
, 'timeGridDay'
or 'timeGridWeek'
.
- Type
function
- Default
undefined
Callback function that is triggered right after the view has been added to the DOM.
function (info) { }
info
is an object with the following properties:
|
The mounted View object |
- Type
object
- Default
{}
You can specify options that apply only to specific views. To do so provide separate options objects within the views
option, keyed by the name of the view.
Methods allow you to manipulate the Event Calendar after initialization. They are accessible from the calendar instance.
In Svelte, methods are available from a component instance:
<script>
import Calendar from '@event-calendar/core';
import TimeGrid from '@event-calendar/time-grid';
let ec;
let plugins = [TimeGrid];
let options = {
view: 'timeGridWeek',
eventSources: [{events: function() {
console.log('fetching...');
return [];
}}]
};
function invokeMethod() {
ec.refetchEvents();
}
</script>
<button on:click={invokeMethod}>Refetch events</button>
<Calendar bind:this={ec} {plugins} {options} />
- Parameters
name
string
The option name
- Return value
mixed
orundefined
This method allows you to get the current value of any calendar option.
// E.g. Get current date
let date = ec.getOption('date');
- Parameters
name
string
The option namevalue
mixed
The new option value
- Return value
EventCalendar
The calendar instance for chaining
This method allows you to set new value to any calendar option.
// E.g. Change the current date
ec.setOption('date', new Date());
- Parameters
event
object
A plain object that will be parsed into an Event object
- Return value Event object or
null
Adds a new event to the calendar.
- Parameters
id
string|integer
The ID of the event
- Return value Event object or
null
Returns a single event with the matching id
.
- Return value
Event[]
Array of Event objects
Returns an array of events that the calendar has in memory.
- Parameters
id
string|integer
The ID of the event
- Return value
EventCalendar
The calendar instance for chaining
Removes a single event with the matching id
.
- Parameters
event
object
A plain object or Event object
- Return value
EventCalendar
The calendar instance for chaining
Updates a single event with the matching event
.id
.
- Return value
EventCalendar
The calendar instance for chaining
Refetches events from all sources.
- Return value
object
ornull
Returns an info
object with data as if the dateClick event had fired for that point.
info
object contains the following properties:
|
JavaScript Date object for the date and time |
|
|
|
HTML element that represents the whole-day that contains the point |
|
If the current view is a resource view, the Resource object that owns this date |
Using this method, you can, for example, find out on which day a click occurred inside a multi-day event. To do this, inside eventClick, pass the jsEvent.clientX
and jsEvent.clientY
coordinates to dateFromPoint
and get the desired date.
- Return value
undefined
- Not available in Svelte
Destroys the calendar, removing all DOM elements, event handlers, and internal data.
Please note that this method is not available in Svelte. Instead, the calendar is destroyed gracefully when the component containing it is destroyed.
- Return value
View
Returns the View object for the current view.
- Return value
EventCalendar
The calendar instance for chaining
Moves the current calendar date forward by 1 day/week/month (depending on the current view).
- Return value
EventCalendar
The calendar instance for chaining
Moves the current calendar date backward by 1 day/week/month (depending on the current view).
- Return value
EventCalendar
The calendar instance for chaining
Clears the current selection. See selectable.
The content value can be presented in the following forms:
- a string containing text
'some text'
- an object containing the HTML string
{html: '<p>some HTML</p>'}
- an object containing an array of DOM nodes
{domNodes: [node1, node2, ...]}
This is a JavaScript object that the Event Calendar uses to store information about a calendar event.
Here are all properties that exist in Event object:
|
A unique string identifier of the event |
|
An array of resource IDs that the event is associated with |
|
|
|
JavaScript Date object holding the event’s start time |
|
JavaScript Date object holding the event’s end time |
|
|
|
|
|
|
|
|
|
The rendering type of the event. Can be In addition, in your callback functions, you may get the |
|
The eventBackgroundColor override for this specific event |
|
The eventTextColor override for this specific event |
|
An array of additional CSS classes for this specific event |
|
An array of additional inline styling declarations for this specific event |
|
A plain object holding miscellaneous properties specified during parsing in the explicitly given |
When Event Calendar receives an array of plain event’s objects either from the events
option or as a result of an HTTP request to a URL of an event source, it parses the input objects into proper Event objects.
Here are all admissible fields for the event’s input object:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This is a JavaScript object that the Event Calendar uses to store information about a period of time, like 30 minutes or 1 day and 6 hours.
Here are all properties that exist in Duration object:
|
The number of years in duration |
|
The number of months in duration |
|
The number of days in duration |
|
The number of seconds in duration. If you want hours and minutes, you need to do division on this property |
|
Determines whether the duration represents a time period in weeks. This value is set during parsing the input data |
When Event Calendar receives a value for options like duration
, scrollTime
, slotDuration
and others, it parses it into a proper Duration object.
The admissible input value can be specified in one of three formats:
- an object with any of the following keys:
year
,years
,month
,months
,day
,days
,minute
,minutes
,second
,seconds
- a string in the format
hh:mm:ss
orhh:mm
. For example,'05:00'
specifies 5 hours - an integer specifying the total number of seconds
This is a JavaScript object that the Event Calendar uses to store information about a resource. Calendar events can be associated with resources and displayed separately using the resource view.
Here are all properties that exist in Resource object:
|
The unique string identifier for the resource |
|
The title of the resource. See Content |
|
Default background color for this resource's events |
|
Default text color for this resource's events |
|
A plain object holding miscellaneous properties specified during parsing in the explicitly given |
When Event Calendar receives an array of plain resource’s objects for the resources
option, it parses the input objects into proper Resource objects.
Here are all admissible fields for the resource’s input object:
|
|
|
|
|
|
|
|
|
|
A View object contains information about a calendar view, such as title and date range.
Here are all properties that exist in View object:
|
Name of the view |
|
Title text that is displayed at the top of the header toolbar |
|
JavaScript Date that is the start of the interval the view is trying to represent. For example, in month view, this will be the first day of the month. This value disregards hidden days |
|
JavaScript Date that is the end of the interval the view is trying to represent. Note: This value is exclusive. For example, in month view, this will be the day after the last day of the month. This value disregards hidden days |
|
JavaScript Date that is the first visible day. In month view, this value is often before the 1st day of the month, because most months do not begin on the first day-of-week |
|
JavaScript Date that is the last visible day. Note: This value is exclusive |
The library provides a built-in dark theme. You can activate it by adding the ec-dark
CSS class to any parent element of the calendar, e.g. <body class="ec-dark">
.
If you want the dark theme to be activated automatically based on the preferred color scheme, then use the ec-auto-dark
CSS class instead.
Please note that the dark theme does not change the background and font color in the calendar. These are assumed to be set by the page styles, and the calendar inherits these styles.
If you do need to set the background or font color of the calendar, use local CSS variables for this:
.ec {
--ec-bg-color: #22272e;
--ec-text-color: #adbac7;
}
A list of all available CSS variables can be found here.
The latest versions of Chrome, Firefox, Safari, and Edge are supported.
The library is compiled to support browsers that match the following browserslist configuration:
defaults and supports fetch
. You can see the resulting list here.