FullCalendar Component

FullCalendar is a UI component designed to display date ranges and calendar events. It offers a wide range of features for managing calendar events and provides various display modes (day, week, month, etc.).

XML namespace

calendar

Java Class

FullCalendar

Attributes

id - allDayMaintainDurationEnabled - allDayText - closeHint - alignSelf - classNames - colspan - css - dateAlignment - dayHeadersVisible - dayMaxEventRows - dayMaxEvents - dayOfYear - defaultAllDay - defaultAllDayEventDuration - defaultBusinessHoursEnabled - defaultDayHeaderFormat - defaultDayMaxEventRowsEnabled - defaultDayMaxEventsEnabled - defaultDayPopoverFormat - defaultEventTimeFormat - defaultSlotLabelFormat - defaultTimedEventDuration - defaultWeekNumberFormat - direction - displayEventTime - dragRevertDuration - dragScroll - eventBackgroundColor - eventBorderColor - eventConstraintBusinessHoursEnabled - eventConstraintGroupId - eventDisplay - eventDragMinDistance - eventDurationEditable - eventHint - eventInteractive - eventLongPressDelay - eventMaxStack - eventOrder - eventOrderStrict - eventOverlap - eventResizableFromStart - eventStartEditable - eventTextColor - expandRows - firstDayOfWeek - forceEventDuration - height - initialDate - initialDisplayMode - maxHeight - maxWidth - minHeight - minWidth - moreLinkClassNames - moreLinkDisplayMode - moreLinkHint - moreLinkText - navLinkHint - navigationLinksEnabled - nextDayThreshold - noEventsText - nowIndicatorVisible - progressiveEventRendering - scrollTime - scrollTimeReset - selectConstraintBusinessHoursEnabled - selectConstraintGroupId - selectLongPressDelay - selectMinDistance - selectMirror - selectOverlap - selectionEnabled - slotDuration - slotLabelInterval - slotMaxTime - slotMinTime - snapDuration - timeHint - unselectAuto - unselectCancelSelector - visible - weekNumbersVisible - weekTextLong - weekendsVisible - width - windowResizeDelay

Elements

businessHours - customDisplayModes - dataProviders - displayModeProperties - hiddenDays

Basic

The FullCalendar component is available in the Add Component palette of the Studio View Designer as soon as you install add-on in your project.

add calendar via studio

The new calendar:calendar element will be added in both the Jmix UI structure panel and in the XML. You can configure attributes like id, height, width, etc., in the same way as it is done for other UI components.

<calendar:calendar id="calendar"
                   height="100%"
                   width="100%"/>

If you don’t use the view designer, declare the calendar namespace in your view’s XML descriptor manually:

<view xmlns="http://jmix.io/schema/flowui/view"
      xmlns:calendar="http://jmix.io/schema/fullcalendar/ui"
      title="Calendar view">

If you need to show events, bind containerEventProvider to data container.

The following example demonstrates how a basic calendar is created:

<data>
    <collection id="eventsDc" class="com.company.fullcalendarsample.entity.Event">
        <loader id="eventsDl" readOnly="true">
            <query>
                <![CDATA[select e from Event e]]>
            </query>
        </loader>
        <fetchPlan extends="_base"/>
    </collection>
</data>
<facets>
    <dataLoadCoordinator auto="true"/>
</facets>
<layout>
    <calendar:calendar id="calendar"
                       height="100%"
                       width="100%">
        <calendar:dataProviders>
            <calendar:containerDataProvider dataContainer="eventsDc"
                                            title="title"
                                            startDateTime="startDate"
                                            endDateTime="endDate"/>
        </calendar:dataProviders>
    </calendar:calendar>
</layout>

Data Model

CalendarEvent

The base interface for events within the FullCalendar component is CalendarEvent. It provides a common set of properties for representing events. These properties are used for displaying and managing events within the calendar.

id

A unique identifier for the calendar event. It is used for identification on the client side.

groupId

The group object that is shared among other events. Events with the same group ID will be dragged and resized together automatically.

allDay

Determines whether event is shown in the 'all-day' section of the relevant display mode. By default, the component considers all events as non-all-day.

A null value means that the event is not an all-day event.

startDateTime

Defines the start date-time position of the event. It is of type LocalDateTime and should correspond to the system’s default time zone. For EntityCalendarEvent, the value will be automatically converted from the supported date-time data type.

endDateTime

Defines the end date-time position of the event. It is of type LocalDateTime and should correspond to the system’s default time zone. For EntityCalendarEvent, the value will be automatically converted from the supported date-time data type.

This value is exclusive. For instance, an event with an end date-time property of 2024-09-03 will appear to span through 2024-09-02 but will not extend into the start of 2024-09-03.

title

The text that will appear on the event.

description

The text of the event description.

interactive

Specifies whether events can be navigated using the TAB key.

If this value is null, the calendar will manage event interactivity based on the eventInteractive property.

classNames

Specifies the class names, separated by spaces, that should be attached to the rendered event.

startEditable

Determines whether an event can be dragged within the calendar component.

If this value is null, the calendar will manage the event’s draggable feature based on the eventStartEditable property.

durationEditable

Determines whether an event can be resized within the calendar component.

If this value is null, the calendar will manage the event’s resizable feature based on the eventDurationEditable property.

display

Defines the type of event rendering. If not specified, the AUTO value will be used.

overlap

Defines whether the event can be dragged or resized over other events. It also prevents other events from being dragged or resized over this event.

If this value is null, the calendar will manage this feature based on the eventOverlap property or a specific JavaScript function.

constraint

Defines a shared group identifier. This property limits dragging and resizing to specific cells within the component.

If this value is null, the calendar will manage the event’s constraint based on the eventConstraintGroupId or eventConstraintBusinessHoursEnabled properties.

backgroundColor

Specifies the background color for the event. Supported values include:

  • Hexadecimal color codes (for example, #f00, #ff0000)

  • RGB color values (for example, rgb(255,0,0))

  • Color names (for example, red)

If this value is null, the calendar will manage the event’s background color based on the eventBackgroundColor property.

borderColor

Specifies the border color for the event. Supported values include:

  • Hexadecimal color codes (for example, #f00, #ff0000)

  • RGB color values (for example, rgb(255,0,0))

  • Color names (for example, red)

If this value is null, the calendar will manage the event’s border color based on the eventBorderColor property.

textColor

Specifies the text color for the event. Supported values include:

  • Hexadecimal color codes (for example, #f00, #ff0000)

  • RGB color values (for example, rgb(255,0,0))

  • Color names (for example, red)

If this value is null, the calendar will manage the event’s text color based on the eventTextColor property.

additionalProperties

Defines additional properties and their values that will be available in various JavaScript functions that take an event as a parameter.

recurringDaysOfWeek

Specifies the days of the week on which this event repeats. If omitted, the event is assumed to repeat every day.

recurringStartDate

Specifies the date when the recurrences of this event start. If not specified, the recurrences will extend infinitely into the past.

recurringEndDate

Specifies the date when the recurrences of this event end. If not specified, the recurrences will extend infinitely into the future.

Note that this value is exclusive. For all-day recurring events, set the end date to the day after your desired last recurrence.

recurringStartTime

Specifies the start time of a recurring event. If this is not defined, the event is considered an all-day event.

Note that the calendar does not apply time zone conversion for this property. If the OffsetTime datatype is used in the entity, it will be transformed to the system’s default time zone.

recurringEndTime

Specifies the end time of a recurring event. If this is not defined, the event will to have the default duration as configured by the defaultTimedEventDuration property.

EntityCalendarEvent

The implementation of CalendarEvent that works with JPA entities or DTOs. When ContainerDataProvider is linked to a collection container, it automatically wraps loaded entities in EntityCalendarEvent objects and pass them to the component. For example, all calendar events in this scenario would be instances of EntityCalendarEvent:

<data>
    <collection id="eventsDc" class="com.company.fullcalendarsample.entity.Event">
        <loader id="eventsDl" readOnly="true">
            <query>
                <![CDATA[select e from Event e]]>
            </query>
        </loader>
        <fetchPlan extends="_base"/>
    </collection>
</data>
<facets>
    <dataLoadCoordinator auto="true"/>
</facets>
<layout>
    <calendar:calendar id="calendar"
                       height="100%"
                       width="100%">
        <calendar:dataProviders>
            <calendar:containerDataProvider dataContainer="eventsDc"
                                            title="title"
                                            startDateTime="startDate"
                                            endDateTime="endDate"/>
        </calendar:dataProviders>
    </calendar:calendar>
</layout>

And you can safely cast to EntityCalendarEvent:

@Autowired
private Notifications notifications;

@Subscribe("calendar")
public void onCalendarEventClick(final EventClickEvent event) {
    EntityCalendarEvent<Event> entityEvent = event.getCalendarEvent();
    Event entity = entityEvent.getEntity();

    notifications.show(entity.getTitle() + " event is clicked");
}

SimpleCalendarEvent

The simple POJO class that implements the CalendarEvent interface. You can use this event class as an alternative to creating DTOs or for prototyping purposes. It also includes a builder class to simplify the creation of event instances.

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    SimpleCalendarEvent calendarEvent = SimpleCalendarEvent.create()
            .withTitle("Car service")
            .withStartDateTime(LocalDateTime.now())
            .build();

    calendar.addDataProvider(new ListCalendarDataProvider(List.of(calendarEvent)));
}

Recurring Events

Recurring events are events that occur multiple times at regular intervals, following a predefined schedule.

In FullCalendar, you can configure this schedule using the following properties within CalendarEvent:

If any of these recurrence properties are specified, FullCalendar assumes the event is recurring and ignores the startDateTime and endDateTime properties.

When the data provider specifies recurrence properties, the single repeating event in the container will be expanded into individual events instances with their own dates in FullCalendar. However, the container will still contain the single recurring event.

You can specify recurrence properties in the data provider as shown below:

<calendar:calendar id="calendar"
                   height="100%"
                   width="100%">
    <calendar:dataProviders>
        <calendar:containerDataProvider dataContainer="eventsDc"
                                        title="title"
                                        recurringStartDate="recurringStartDate"
                                        recurringEndDate="recurringEndDate"
                                        recurringStartTime="recurringStartTime"
                                        recurringEndTime="recurringEndTime"
                                        recurringDaysOfWeek="recurringDaysOfWeek"/>
    </calendar:dataProviders>
</calendar:calendar>

Managing Recurring Events in FullCalendar

FullCalendar expands single recurring events into individual events instances. These instances are treated as independent events, meaning changes to one instance won’t affect others by default.

Example: Moving Recurring Events

Let’s say you have a recurring meeting that happens every Tuesday. If you enable the eventStartEditable property, a user can drag and move a specific instance of that meeting (for example, the meeting on November 7th) to a different time slot. However, this change will only affect the November 7th instance. The meetings on other Tuesdays will remain at their original times.

Grouping Recurring Events

To move all instances of a recurring event together, you need to group them using the groupId property of CalendarEvent.

Here’s how it works:

  1. Assign a Group ID: Set the same groupId value to all instances of the recurring event you want to move together.

  2. Enable Dragging: Ensure the eventStartEditable property is set to true to allow dragging.

Now, when a user drags an instance of the recurring event, all instances within that group will move simultaneously, maintaining the defined recurrence pattern.

DaysOfWeek Datatype

The recurringDaysOfWeek property defines the list of days of the week. In order to store this data in JPA entities or DTOs, Jmix provides a dedicated data type called DaysOfWeek.

The Studio automatically provides this data type when you add an attribute to a JPA entity or DTO. You can then select the desired days of the week for your recurring event.

add recurring days of week attribute

The DaysOfWeek data type is supported by both the valuePicker 值选择器 component and the DaysOfWeekEditAction. This allows you to easily edit the list of days of the week in your user interface.

<valuePicker id="recurringDaysOfWeekField" property="recurringDaysOfWeek">
    <actions>
        <action id="select" type="fcalen_daysOfWeekEdit"/>
        <action id="clear" type="value_clear"/>
    </actions>
</valuePicker>

Data Binding

The calendar component uses data providers to connect loaded data and display it visually. To be visible in the component, a data item must implement the CalendarEvent interface. For JPA or DTO entities, a ContainerDataProvider wraps the entity to create an EntityCalendarEvent.

The FullCalendar component allows you to add multiple data providers. This allows you to display data from different data sources and services within a single calendar.

CalendarDataProvider

CalendarDataProvider is a base interface for all data providers used by the calendar. There are two main types of calendar data providers:

  • Data providers that load all data at once. These providers retrieve all relevant data in a single operation.

  • CallbackCalendarDataProvider. These providers load data on demand, using a callback mechanism to retrieve partial data as needed.

ContainerDataProvider

The ContainerDataProvider works with 数据容器. It reflects any changes made to the container (adding, removing, or modifying entities) and updates the FullCalendar UI accordingly.

To use the container data provider in FullCalendar, you should specify:

  • dataContainer property: a reference to an ID of an existing container in your view.

  • Entity properties mapping. The container data provider wraps JPA or DTO entities into EntityCalendarEvent to make them compatible with the FullCalendar component. However, it doesn’t automatically know which properties from the JPA or DTO entity should be used for the CalendarEvent. Therefore, you must define property mappings to specify which entity properties correspond to specific CalendarEvent properties.

Here is an example of using the ContainerDataProvider:

<calendar:dataProviders>
    <calendar:containerDataProvider dataContainer="eventsDc"
                                    title="title"
                                    startDateTime="startDate"
                                    endDateTime="endDate"/>
</calendar:dataProviders>

To work with the container data provider programmatically, you can use the ContainerCalendarDataProvider class.

ListCalendarDataProvider

The ListCalendarDataProvider retrieves data from a provided list of items. It doesn’t require an XML definition and can be added programmatically.

Here’s a basic example of using a ListCalendarDataProvider:

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    SimpleCalendarEvent calendarEvent = SimpleCalendarEvent.create()
            .withTitle("Morning jog")
            .withStartDateTime(LocalDate.now(), LocalTime.of(8, 0))
            .build();

    ListCalendarDataProvider listDataProvider =
            new ListCalendarDataProvider(List.of(calendarEvent));

    calendar.addDataProvider(listDataProvider);
}

The list data provider automatically updates the FullCalendar UI when its data is modified through its API methods:

  • addItem(): adds an item to the UI.

  • removeItem(): removes an item from the UI.

  • updateItem(): updates an item in the UI.

ListDataProvider also provides other methods for managing the list of items.

CallbackCalendarDataProvider

The CallbackCalendarDataProvider is a base interface for data providers that load data on demand. This interface defines a method called onItemsFetch() that is invoked whenever the component needs new data.

Data is loaded in the following situations:

  • When the user switches to a calendar display mode with a wider date range than the previous one. For example, if the user changes from a daily view to a weekly view, the component will need to fetch data for the entire week.

  • When the navigation methods of the FullCalendar component are invoked. This includes methods like navigateToNext(), navigateToPrevious(), and other methods that move the calendar view forward or backward in time.

  • When the time zone of the FullCalendar component is changed. The component will need to fetch new data to reflect the updated time zone.

CallbackDataProvider

The data provider that loads data using a JPQL query and a DataManager. Similar to ContainerDataProvider, it requires you to define property mappings to specify how entity properties map to CalendarEvent properties. Additionally, you must provide a JPQL query that defines the data to be loaded.

Here’s an example of property mappings within the callbackDataProvider element:

<calendar:dataProviders>
    <calendar:callbackDataProvider title="title"
                                   startDateTime="startDate"
                                   endDateTime="endDate"/>
</calendar:dataProviders>

To load data using a JPQL query, you should specify an itemsQuery element within the data provider. This element requires the fully qualified name of the entity class used in the JPQL query.

The items query allows you to define a FetchPlan in the fetchPlan attribute or within a separate fetchPlan element.

<calendar:callbackDataProvider title="title"
                               startDateTime="startDate"
                               endDateTime="endDate">
    <calendar:itemsQuery class="com.company.fullcalendarsample.entity.Event"/>
</calendar:callbackDataProvider>

In the JPQL query you can use two parameters:

  • fetchStartDate - the left border of visible date range in the FullCalendar

  • fetchEndDate - the right border of visible date range in the FullCalendar.

The fetchEndDate value is exclusive. For instance, if the visible date range is from 2024-09-29 to 2024-11-09 the actual value of the fetchEndDate will be 2024-11-10.

The full example of using callbackDataProvider:

<calendar:dataProviders>
    <calendar:callbackDataProvider title="title"
                                   startDateTime="startDate"
                                   endDateTime="endDate">
        <calendar:itemsQuery class="com.company.fullcalendarsample.entity.Event">
            <calendar:fetchPlan extends="_base"/>
            <calendar:query>
                <![CDATA[select e from Event e
                            where e.startDate >= :fetchStartDate
                                and e.endDate < :fetchEndDate]]>
            </calendar:query>
        </calendar:itemsQuery>
    </calendar:callbackDataProvider>
</calendar:dataProviders>
This JPQL query assumes that the startDate and endDate values are not null. If they might be null, you’ll need to add a null check to the query.

To work programmatically with the callback data provider, use the EntityCalendarDataRetriever class. This class is a Spring bean with prototype scope, so you should initialize it carefully using Spring’s dependency injection mechanisms.

CallbackDataProvider and Load Delegate

In situations where complex business logic requires building intricate JPQL queries with numerous conditions, writing the query directly in an XML descriptor can become cumbersome. To address this, you can set a load delegate for the CallbackDataProvider.

@Autowired
private EventService eventService;

@Install(to = "calendar.myDataProvider", subject = "loadDelegate")
private List<CalendarEvent> calendarMyDataProviderLoadDelegate(final ItemsFetchContext context) {
    return eventService.fetchCalendarEvents(context.getStartDate(), context.getEndDate());
}
myDataProvider is the ID of the data provider. You can specify it using the id attribute in the XML definition.
If your implementation of the load delegate returns a list of EntityCalendarEvent, you will need to specify property mappings within the data provider.

CalendarDataRetriever

The CalendarDataRetriever is a simple data provider that is similar to the callbackDataProvider with a load delegate. However, it lacks an XML definition. This data provider can be used in conjunction with services to load data, providing a more flexible and programmatic approach to data management within the calendar component.

@ViewComponent
private FullCalendar calendar;

@Autowired
private TaskEventService taskEventService;

@Subscribe
public void onInit(final InitEvent event) {
    calendar.addDataProvider(new CalendarDataRetriever() {
        @Override
        public List<CalendarEvent> onItemsFetch(ItemsFetchContext context) {
            return taskEventService.fetchCalendarEvents(context);
        }
    });
}

Calendar Display Modes

In FullCalendar, a display mode represents a specific way of visualizing calendar data. It allows users to view events across different timeframes, like days, weeks, or months. This flexibility helps users interact with the calendar in various formats, depending on their needs. For example, you might prefer a detailed view of a single day or a broader overview of an entire month.

FullCalendar provides a range of built-in display modes:

  • Day-grid modes display calendar events in a grid format, similar to traditional paper calendars. Each cell within the day-grid represents a single day.

    • DAY_GRID_DAY - focuses on a single day, offering a detailed view of events scheduled for that specific day.

    • DAY_GRID_WEEK - a full week’s worth of days, ideal for focusing on upcoming events.

    • DAY_GRID_MONTH - displays an entire month at a glance, enabling users to see all days and their associated events.

    • DAY_GRID_YEAR - presents an entire year, providing a high-level overview.

      You can use the initialDisplayMode attribute to set the initial day-grid mode for your FullCalendar instance:

      <calendar:calendar id="calendar"
                   initialDisplayMode="DAY_GRID_WEEK"
                   height="100%"
                   width="100%"/>

      The screenshot below demonstrates a day-grid month display mode:

      day grid month mode

  • Time-grid modes offer time-oriented layouts for displaying events across one or more days. These formats are especially useful for users who need to manage their schedules with a strong focus on specific times throughout the day.

    FullCalendar provides two time-grid modes:

    • TIME_GRID_DAY - displays a single day in detail, allowing users to see all events scheduled for that day along with their specific start and end times.

    • TIME_GRID_WEEK - shows an entire week, providing a broader view while still maintaining the time slots for each day. This mode is ideal for visualizing weekly schedules or planning meetings across multiple days.

      You can use the initialDisplayMode attribute to set the initial time-grid mode for your FullCalendar instance:

      <calendar:calendar id="calendar"
                   initialDisplayMode="TIME_GRID_WEEK"
                   height="100%"
                   width="100%"/>

      The screenshot below demonstrates a time-grid week display mode:

      time grid week mode

  • List modes present events in a straightforward vertical format, making it easy for users to view and manage their schedules over a specified period. This layout is ideal for users who prefer a simple, text-based representation of their events.

    FullCalendar offers various list modes:

    • LIST_DAY - displays all events for a single day.

    • LIST_WEEK - displays events for an entire week.

    • LIST_MONTH - lists events for the entire month.

    • LIST_YEAR - provides an overview of events throughout the year.

      You can use the initialDisplayMode attribute to set the initial list mode for your FullCalendar instance:

      <calendar:calendar id="calendar"
                   initialDisplayMode="LIST_WEEK"
                   height="100%"
                   width="100%"/>

      The screenshot below demonstrates a list week display mode:

      list week mode

  • Multi-month year mode provides a comprehensive way to visualize several months at once, offering a high-level overview of events across a longer period.

    • MULTI_MONTH_YEAR displays a grid of months, allowing users to see all 12 months of the year in a single view. This is useful for planning and tracking events that span across multiple months.

      You can use the initialDisplayMode attribute to set the initial multi-month year mode for your FullCalendar instance:

      <calendar:calendar id="calendar"
                   initialDisplayMode="MULTI_MONTH_YEAR"
                   height="100%"
                   width="100%"/>

      The screenshot below demonstrates a multi-month year display mode:

      multi month year mode

Display Mode Properties

Each predefined display mode has its own set of properties. Some properties are specific to a particular display mode, while others are general.

For example, you can configure dayHeaderFormat only for the day-grid day mode, and other modes won’t affect its format.

<calendar:calendar id="calendar" height="100%" width="100%">
    <calendar:displayModeProperties>
        <calendar:dayGridDay dayHeaderFormat="dddd D"/>
    </calendar:displayModeProperties>
</calendar:calendar>

FullCalendar also allows you to override properties in the calendar component using properties configured from the display mode.

For instance, imagine the component enables the weekNumbersVisible property. However, if you need to disable this feature for the day-grid month display mode, you should use the properties tag within the display mode properties.

<calendar:calendar id="calendar"
                   height="100%"
                   width="100%"
                   weekNumbersVisible="true">
    <calendar:displayModeProperties>
        <calendar:dayGridMonth>
            <calendar:properties>
                <calendar:property name="weekNumbers" value="false"/>
            </calendar:properties>
        </calendar:dayGridMonth>
    </calendar:displayModeProperties>
</calendar:calendar>
In the name attribute, you should specify the property name as it is defined in FullCalendar.js. Refer to the FullCalendar.js documentation to find the correct property name. Use this feature carefully; FullCalendar might ignore this display mode property setup if you change the same property in the component at runtime.

Custom Calendar Display Mode

If the predefined display modes don’t meet your needs, you can create your own custom display mode with a specific date range. There are two ways to create a custom display mode:

  • Programmatically, using the CustomCalendarDisplayMode class.

  • Declaratively, using the customDisplayModes element in an XML.

Custom display modes should be based on one of four base types: day-grid, time-grid, list, and multi-month.

For example, you can define a time-oriented display mode declaratively using the following code:

<calendar:calendar id="calendar"
                   initialDisplayMode="timeGridThreeDays"
                   height="100%"
                   width="100%">
    <calendar:customDisplayModes>
        <calendar:displayMode id="timeGridThreeDays" type="TIME_GRID" dayCount="3">
        </calendar:displayMode>
    </calendar:customDisplayModes>
</calendar:calendar>
The dayCount attribute sets the exact number of days displayed in a custom display mode, regardless of the weekendsVisible or hiddenDays properties.

You can also use the duration element instead of the dayCount attribute to specify the date range:

<calendar:displayMode id="timeGridThreeDays" type="TIME_GRID">
    <calendar:duration days="3"/>
</calendar:displayMode>
When a date range is specified using duration, hidden days will be omitted, and the display mode will stretch to fill the missing space. However, if you specify dayCount, you are guaranteed to see a specific number of days.

For programmatic creation of custom display modes, use CustomCalendarDisplayMode.

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    calendar.addCustomCalendarDisplayMode(
            new CustomCalendarDisplayMode("dayGridTwoDays")
                    .withDayCount(2));

    calendar.setInitialCalendarDisplayMode(() -> "dayGridTwoDays");
}
The default display mode is the day grid, but you can customize it by choosing a different type from the GenericCalendarDisplayModes enumeration.

Display Mode and Visible Range

You can further customize the date range displayed in a calendar by using the visibleRange property. This property should be used in conjunction with the options from the GenericCalendarDisplayModes enumeration.

It’s important to note that visibleRange does not have an XML definition and can only be configured programmatically.

For example, you can configure the calendar to display the day grid like this:

<calendar:calendar id="calendar"
                   initialDisplayMode="DAY_GRID"
                   height="100%"
                   width="100%"/>
The GenericCalendarDisplayModes enum provides the following display options in XML: DAY_GRID, TIME_GRID, LIST, and MULTI_MONTH.

Set the required visible range in the view controller:

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    calendar.setVisibleRange(
            LocalDate.now(), LocalDate.now().plusDays(3));
}
The last date is exclusive. For example, a visible range of October 1, 2024, to October 3, 2024, will display only two days (October 1st and 2nd).
When a visible range is set, navigation methods like navigateToNext() will not function.

Calendar Event Editing

FullCalendar lets you edit calendar events by dragging and dropping to change the start date, and resizing to adjust the duration. To handle these changes, you should add the following event listeners: EventDropEvent and EventResizeEvent.

The component can modify only three properties of the CalendarEvent based on event changes:

Drag and Drop

To enable the drag and drop feature, set the eventStartEditable property to true.

<calendar:calendar id="calendar"
                   eventStartEditable="true"
                   height="100%"
                   width="100%"/>

Event Drop Event

To handle changes when a calendar event is dropped, subscribe to the EventDropEvent. This event is emitted by the FullCalendar component when a user moves a calendar event to a different position.

Before proceeding with an event to the listeners, the component applies changes to the calendar event in the data provider.

The event contains the following information:

  • The dropped calendar event

  • The calendar event’s data provider

  • Old values

  • Information about the current display mode

  • The delta (duration) between the old start date and the new start date

  • Related calendar events that were also dropped with the dropped calendar event

The example below demonstrates how to immediately save changes to an entity calendar event:

@Autowired
private DataManager dataManager;

@Subscribe("calendar")
public void onCalendarEventDrop(final EventDropEvent event) {
    EntityCalendarEvent<Event> calendarEvent = event.getCalendarEvent();

    dataManager.save(calendarEvent.getEntity());
}

Resizable

To enable calendar event resizing, set the eventDurationEditable property to true. This allows users to change the duration (size) of a calendar event by modifying its end date.

To resize the calendar event by modifying its start date, set the eventResizableFromStart property to true:

<calendar:calendar id="calendar"
                   eventDurationEditable="true"
                   eventResizableFromStart="true"
                   height="100%"
                   width="100%"/>

Event Resize Event

To handle changes when a calendar event is resized, subscribe to the EventResizeEvent. This event is triggered by the FullCalendar component when a user resizes a calendar event.

Before proceeding with an event to the listeners, the component applies changes to the calendar event in the data provider.

The event contains the following information:

  • The resized calendar event

  • The calendar event’s data provider

  • Old values

  • Information about the current display mode

  • The start delta (duration) between the old start date and the new start date

  • The end delta (duration) between the old end date and the new old date

  • Related calendar events that were also resized with the dropped calendar event

The example below demonstrates how to immediately save changes to an entity calendar event:

@Autowired
private DataManager dataManager;

@Subscribe("calendar")
public void onCalendarEventResize(final EventResizeEvent event) {
    EntityCalendarEvent<Event> calendarEvent = event.getCalendarEvent();

    dataManager.save(calendarEvent);
}

Calendar Event Constraints

FullCalendar allows you to configure limitations for dragging and resizing events. You can restrict event changes in three ways:

  • Event Constraint Group ID:

    Set an eventConstraintGroupId value. If this property is set, events that are being dragged or resized must be fully contained within at least one of the events linked to the specified group ID.

  • Default Business Hours:

    Enable the default business hours using the eventConstraintBusinessHoursEnabled property. Events that are being dragged or resized must be fully contained within the week’s business hours. If defaultBusinessHoursEnabled is set, the default business hours are Monday to Friday, 9 AM to 5 PM. Custom business hours are also respected.

  • Custom Business Hours:

    Set custom business hours. As with the default business hours, events must be contained within the defined custom business hours.

Event Overlap

The eventOverlap attribute provides another way to limit dragging and resizing calendar events. It controls whether events can overlap each other while being dragged or resized. By default, overlapping is enabled.

For more granular control, you can use a JavaScript function to define custom overlap rules.

The following example demonstrates how to allow all-day calendar events to overlap only with other all-day events:

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    calendar.setEventOverlapJsFunction(new JsFunction("""
            function(stillEvent, movingEvent) {
                return stillEvent.allDay && movingEvent.allDay;
            }"""));
}
The JavaScript function definition for event overlap takes precedence over the eventOverlap property.
You can access all available properties of events in the FullCalendar.js documentation. Within the JavaScript function, you can utilize additionalProperties available under the extendedProps object of an event. For example, if a calendar event has an additional property called myEventStatus, you can retrieve its value like this: stillEvent.extendedProps.myEventStatus.

Selection

The selection feature in FullCalendar allows users to select multiple days or time slots by clicking or dragging their mouse. To enable this feature, set the selectionEnabled property to true:

<calendar:calendar id="calendar"
                   selectionEnabled="true"
                   height="100%"
                   width="100%"/>

Select Event

To handle selection events, subscribe to the SelectEvent. This event is triggered by the FullCalendar component when a user selects multiple days or time slots.

The event contains the following information:

  • The start date and time.

  • The end date and time.

  • The allDay property. Indicates whether the selected dates are day cells or time slots.

  • Information about the current display mode.

  • Information about the mouse click.

The example of subscribing to select event:

@Autowired
private Notifications notifications;

@Subscribe("calendar")
public void onCalendarSelect(final SelectEvent event) {
    notifications.show(String.format("Selected dates: from %s to %s",
            event.getStartDateTime(), event.getEndDateTime()));
}
The end date and time are exclusive. For example, if the selection is all-day and the last date value is 2024-10-15, the value of the end date property will be 2024-10-16.

Unselect Event

To handle the clearing of a selection, subscribe to the UnselectEvent. This event is triggered by the FullCalendar component when a selection is cleared. It is fired in the following cases:

  • User clicks away from the current selection: This happens unless the unselectAuto property is disabled.

  • User makes a new selection: The event is fired before the new selection occurs.

  • User moves forward or backward in the calendar view or switches to a different mode.

  • The unselect() method is called.

The event contains the following information:

  • Information about the current display mode.

  • Information about the mouse click.

The example of subscribing to unselect event:

@Autowired
private Notifications notifications;

@Subscribe("calendar")
public void onCalendarUnselect(final UnselectEvent event) {
    notifications.show("Selection is cleared");
}

Select Constraints

Selection constraints in FullCalendar are similar to Calendar Event Constraints, but they apply to the selection area. These constraints limit the selectable area based on the following options:

  • The selectConstraintGroupId property: if this property is set, only dates or time slots containing events with the specified group ID can be selected.

  • The selectConstraintBusinessHoursEnabled property: the selection can only be made within the week’s business hours. If defaultBusinessHoursEnabled is set, the default business hours are Monday to Friday, 9 AM to 5 PM. Custom business hours are also respected.

  • Custom business hours: as with the default business hours, selections must be made within the custom business hours.

Select Overlap

The selectOverlap attribute provides another way to limit selection in FullCalendar. It controls whether the selection area can overlap with existing calendar events. By default, overlap is allowed.

For more fine-grained control, you can use a JavaScript function definition to check whether a selection can overlap with a calendar event.

The following example demonstrates how to allow selection in cells that contain background calendar events:

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    calendar.setSelectOverlapJsFunction(new JsFunction("""
            function(event) {
                return event.display === 'background';
            }"""));
}
The JavaScript function definition for selection overlap takes precedence over the selectOverlap property.
You can find all available properties of events in the FullCalendar.js documentation. Within the JavaScript function, you can utilize additionalProperties available under the extendedProps object of an event. For example, if a calendar event has an additional property called myEventStatus, you can retrieve its value like this: event.extendedProps.myEventStatus.

Programmatic Selection Control

FullCalendar provides the following methods for programmatically selecting or unselecting a date range:

  • select(): Selects a date range.

  • unselect(): Clears the current selection.

The following code selects a date range of two days, including the current day:

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    calendar.select(LocalDate.now(), LocalDate.now().plusDays(2));
}
The end date in the example above is excluded, effectively selecting the current and next days.

Controlling Selection with a JavaScript Function

You can control selection behavior for each cell using a JavaScript function. For example, the following function enables selection only for yesterday, today, and tomorrow:

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    calendar.setSelectAllowJsFunction(
            new JsFunction(String.format("""
                            function(selectionInfo) { (1)
                                return selectionInfo.start >= new Date('%s')
                                && selectionInfo.end <= new Date('%s');
                            }""",
                    convertToStrDate(LocalDate.now().minusDays(1)), (2)
                    convertToStrDate(LocalDate.now().plusDays(2)))));
}

protected String convertToStrDate(LocalDate date) { (3)
    TimeZone timeZone = calendar.getTimeZone() == null
            ? TimeZone.getDefault()
            : calendar.getTimeZone();
    return date.atStartOfDay(timeZone.toZoneId()).toOffsetDateTime().toString();
}
1 The selectionInfo parameter in this function contains the following properties:

  • allDay: A Boolean indicating whether the selection is in all-day cells.

  • end: A Date object representing the end date of the selection (exclusive).

  • endStr: A String representation of the end date.

  • start: A Date object representing the start date of the selection.

  • startStr: A String representation of the start date.
2 The start and end dates are applicable to the selection.
3 This method converts LocalDate to ISO format with the component’s time zone.

Business Hours

Business hours define the specific times during which calendar events can be scheduled or displayed. There are two ways to configure business hours in the FullCalendar component:

  • The defaultBusinessHoursEnabled property.

  • Custom list of business hours definitions. Allows you to specify custom business hours, overriding the defaults.

Here is an example of how to configure business hours with the defaultBusinessHoursEnabled property:

<calendar:calendar id="calendarDefault"
                   defaultBusinessHoursEnabled="true"
                   height="100%"
                   width="100%"/>

When business hours are defined, they are visually emphasized on the calendar.

business hours enabled

For more fine-grained control over business hours, you can set a list of custom business hours. This allows you to configure different hours for different days of the week or even split hours into segments (like morning and afternoon shifts).

Let’s set up a duty schedule as an example. On Monday, Wednesday, and Friday, work hours are from 8 AM to 12 PM, while on Tuesday and Thursday, they are from 12 PM to 6 PM:

<calendar:calendar id="calendar"
                   initialDisplayMode="TIME_GRID_WEEK"
                   height="100%"
                   width="100%">
    <calendar:businessHours>
        <calendar:entry startTime="PT8h" endTime="PT12h">
            <calendar:day name="MONDAY"/>
            <calendar:day name="WEDNESDAY"/>
            <calendar:day name="FRIDAY"/>
        </calendar:entry>
        <calendar:entry startTime="PT12h" endTime="PT16h">
            <calendar:day name="TUESDAY"/>
            <calendar:day name="THURSDAY"/>
        </calendar:entry>
    </calendar:businessHours>
</calendar:calendar>
The startTime and endTime properties follow the ISO-8601 duration format, which is the same format used by the java.time.Duration class.
business hours custom

Context Menu

The FullCalendar component provides a context menu through the FullCalendarContextMenu class. You can customize the content of this menu based on the clicked day cell or calendar event.

However, there are limitations on where the context menu can be opened:

  • Calendar Events: Available in all display modes.

  • Day Cells: Available in all day-grid display modes and the multi-month year mode.

  • Time Slots: Not available.

The example of dynamic context menu handling:

@ViewComponent
private CollectionContainer<Event> eventsDc;
@ViewComponent
private FullCalendar calendar;

@Autowired
private DialogWindows dialogWindows;

@Subscribe
public void onInit(final InitEvent event) {
    FullCalendarContextMenu contextMenu = calendar.getContextMenu(); (1)
    contextMenu.setContentMenuHandler(context -> { (2)
        EntityCalendarEvent<Event> calendarEvent = context.getCalendarEvent();
        if (calendarEvent != null) {
            contextMenu.removeAll(); (3)

            contextMenu.addItem("Edit", clickEvent -> { (4)
                dialogWindows.detail(this, Event.class)
                        .editEntity(calendarEvent.getEntity())
                        .open();
            });
            contextMenu.addItem("Remove", clickEvent -> {
                eventsDc.getMutableItems().remove(calendarEvent.getEntity());
            });

            return true; (5)
        }
        return false;
    });
}
1 Gets the context menu instance from the FullCalendar component.
2 Sets the context menu handler, allowing you to configure the menu items.
3 Removes all menu items that were previously in the context menu.
4 Adds a new menu item with a click listener.
5 Returns true to indicate that the context menu can be opened.
context menu

Styling

You can style the calendar and its events with CSS. Use your browser’s developer tools to inspect the DOM tree of the calendar and write CSS selectors.

For example, the following selectors change the background color of Saturday and Sunday in day-grid modes:

.fc-day-sat.fc-daygrid-day,
.fc-day-sun.fc-daygrid-day {
    background-color: #FF9191AD;
}

There are CSS variables that FullCalendar.js provides for customization:

html jmix-full-calendar {
    --fc-small-font-size: var(--lumo-font-size-s);
    --fc-page-bg-color: var(--lumo-base-color);
    --fc-neutral-bg-color: var(--lumo-contrast-10pct);
    --fc-neutral-text-color: var(--lumo-secondary-text-color);
    --fc-border-color: var(--lumo-contrast-20pct);

    --fc-event-bg-color: var(--lumo-primary-color-50pct);
    --fc-event-border-color: var(--lumo-primary-color-50pct);
    --fc-event-text-color: var(--lumo-primary-contrast-color);
    --fc-event-selected-overlay-color: var(--lumo-primary-color-10pct);;

    --fc-more-link-bg-color: #a6a6a6;
    --fc-more-link-text-color: inherit;

    --fc-event-resizer-thickness: 8px;
    --fc-event-resizer-dot-total-width: 8px;
    --fc-event-resizer-dot-border-width: 1px;

    --fc-non-business-color: var(--lumo-contrast-5pct);
    --fc-bg-event-color: rgb(143, 223, 130);
    --fc-bg-event-opacity: 0.3;
    --fc-highlight-color: var(--lumo-primary-color-10pct);
    --fc-today-bg-color: rgba(255, 220, 40, 0.15);
    --fc-now-indicator-color: red;
}

Component and Event Properties

The FullCalendar component and calendar events have properties that define event colors.

For instance, the following example sets colors for all calendar events:

<calendar:calendar id="calendar"
                   eventTextColor="#5CCCCC"
                   eventBorderColor="#679B00"
                   eventBackgroundColor="#006363"
                   height="100%"
                   width="100%"/>
styling properties1

Individual calendar events have properties that can override the component’s color definitions:

CalendarEvent calendarEvent = SimpleCalendarEvent.create()
        .withTitle("Colored event")
        .withAllDay(true)
        .withStartDateTime(LocalDateTime.now())
        .withTextColor("#80EA69")
        .withBorderColor("#A6A200")
        .withBackgroundColor("#188A00")
        .build();
styling properties2

Another way to style calendar events is by assigning a class name to an event. This allows you to apply custom CSS styles to specific events.

CalendarEvent redCalendarEvent = SimpleCalendarEvent.create()
        .withTitle("Colored event")
        .withStartDateTime(LocalDateTime.now())
        .withClassNames("red-text-event")
        .build();

The CSS selector:

.fc-event.red-text-event {
    color: red;
}
styling properties3

Class Names Generators

Class name generators help generate class names for calendar UI elements, based on the context of their generation.

For instance, let’s highlight weekends using dayHeaderClassNamesGenerator:

@Install(to = "calendar", subject = "dayHeaderClassNamesGenerator")
private List<String> calendarDayHeaderClassNamesGenerator(final DayHeaderClassNamesContext context) {
    if (context.getDayOfWeek() == DayOfWeek.SATURDAY
            || context.getDayOfWeek() == DayOfWeek.SUNDAY) {
        return List.of("weekend");
    }
    return null;
}

To style the background and text colors, add two CSS selectors:

.fc-col-header-cell.weekend {
    background-color: rgba(195, 195, 255, 0.73);
}

.fc-col-header-cell.weekend a {
    color: var(--lumo-primary-color)
}
styling day header class names generator1

Refer to the Handlers section for a complete list of class name generators.

Localization

Localization can be changed locally for a single FullCalendar component or globally using the messages mechanism.

To configure the localization of a single component, use component properties and the FullCalendarI18n object. The FullCalendarI18n object contains locale-dependent properties, some of which can affect the component’s behavior, such as firstDayOfWeek, direction, and others.

For instance, let’s change the first day of the week and the direction:

<calendar:calendar id="calendar"
                   firstDayOfWeek="MONDAY"
                   direction="RTL"
                   height="100%"
                   width="100%"/>

Programmatically you can do the following:

@ViewComponent
private FullCalendar calendar;

@Subscribe
public void onInit(final InitEvent event) {
    calendar.setI18n(new FullCalendarI18n()
            .withFirstDayOfWeek(DayOfWeek.MONDAY)
            .withDirection(FullCalendarI18n.Direction.RTL));
}

To change localization globally, add message keys from the FullCalendar add-on to your messages bundle. You can find the complete list of available messages in jmix/fullcalendarflowui/messages.properties.

For example, you can translate the default names for months:

io.jmix.fullcalendarflowui.component/months=January, February, March, April, May, June, July, August, September, October, November, December
io.jmix.fullcalendarflowui.component/monthsShort=Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec
io.jmix.fullcalendarflowui.component/weekdays=Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
io.jmix.fullcalendarflowui.component/weekdaysShort=Sun, Mon, Tue, Wed, Thu, Fri, Sat
io.jmix.fullcalendarflowui.component/weekdaysMin=Su, Mo, Tu, We, Th, Fr, Sa
Make sure the translated names are in the same order as the original names because the parser expects weekdays from Sunday to Saturday and months from January to December.

Attributes

In Jmix there are many common attributes that serve the same purpose for all components. The following are attributes specific to calendar:

Name Description Default

allDayMaintainDurationEnabled

Determines how an event’s duration should be mutated when it is dragged from a timed section to an all-day section or vice versa.

  • true - the duration will remain roughly the same before and after it is dragged to or from an all-day section. "Roughly" because if an event has a duration with hourly precision, it will be rounded down to the nearest whole-day.

  • false - the event’s duration will be reset to defaultAllDayEventDuration if it is being dropped in an all-day section or defaultTimedEventDuration if it is being dropped in a timed section

false

allDayText

Sets the all-day text. The text is visible in time-grid display modes.

-

closeHint

Sets the hint for the close button in the popover when you click the "more" link.

-

dateAlignment

Sets the first visible date of CustomCalendarDisplayMode.

When a custom calendar display mode is being used, and you’d like to guarantee that the calendar begins at a certain interval, like the start-of-week or start-of-month, specify a value like week or month. If the property is not specified, a reasonable default will be generated based on the display mode’s duration.

If a display mode’s range is explicitly defined by visible date range, this property will be ignored.

-

dayHeadersVisible

Sets whether the day headers should appear. It works for day-grid, time-grid and month display modes.

true

dayMaxEventRows

Sets rows count of events in day-grid display modes and in "all-day" section in time-grid display modes.

Note that "more" row is included to count. For instance, if the value is 1, only the "more" row will be shown. Takes precedence over the defaultDayMaxEventRowsEnabled.

-

dayMaxEvents

Sets rows count of events in day-grid display modes and in "all-day" section in time-grid display modes.

Note that "+ more" row is not included to count. For instance, if the value is 1, one event and the "more" row will be shown. Takes precedence over the defaultDayMaxEventsEnabled.

-

dayOfYear

The rule how to define the first week of the year. For instance, if the first day of the week is 1 and the day of year equals to 4, it means that the week that contains Jan 4th is the first week of the year.

-

defaultAllDay

Sets the default value for each calendar event’s allDay property when it is unspecified.

If the property is set to true, all events without allDay property (e.g. is not specified mapping in a data provider or calendar event returns null for this property) will be considered as all-day events.

Note, in this case, events without allDay property will be shown as all-day events. If such event will be changed by dragging or resizing, and you have listeners for these events, the component will apply changes to a calendar event, which can lead to modifying entity/ DTO instance.

false

defaultAllDayEventDuration

Sets the default duration of all-day events if they don’t specify endDateTime property.

For instance, the property is set to 2 days. The event that has allDay property equals to true and do not have endDateTime property, will be shown in all-day section and will occupy two days.

Note, calendar event’s endDateTime property will remain unset, unless forceEventDuration has been set to true. In this case, the calendar will explicitly assign end date-time to an event. If such event will be changed by dragging or resizing, and you have listeners for these events, the component will set to calendar event end date-time value, which can lead to modifying entity/ DTO instance.

This property only affects events with allDay property equals to true.

P1d

defaultBusinessHoursEnabled

Enables default business hours. The default business hour is: monday - friday from 9 AM to 5 PM.

false

defaultDayHeaderFormat

Sets the format of the text that will be displayed on the calendar’s column headings.

By default, component sets localized format from messages when is created. This property act as default format for all display modes and for CustomCalendarDisplayMode until specific property won’t be set for these display modes. However, all display-mode properties objects by default explicitly specify the format, thus they override this property.

As component uses moment plugin for FullCalendar, you should follow the moment.js formatting rules: Moment.js Documentation. For instance, the dd produces the Mo value.

The property change is not applied after component attached to the UI.

-

defaultDayMaxEventRowsEnabled

Limits the maximum number of stacked events within a given day.

  • true - limits the number of events by height of the day cell.

  • false - component displays all events as is.

This property is applied for day-grid display modes and in all-day cells.

false

defaultDayMaxEventsEnabled

Limits the maximum number of stacked events within a given day.

  • true - limits the number of events by height of the day cell.

  • false - component displays all events as is.

This property is applied for day-grid display modes and in all-day cells.

false

defaultDayPopoverFormat

Sets the date format of title of the popover that is shown when "more" link is clicked. By default, component sets localized format from messages when is created.

This property act as default format for all display modes and for CustomCalendarDisplayMode until specific property won’t be set for these display modes. However, all display-mode properties objects by default explicitly specify the format, thus they override this property.

As component uses moment plugin for FullCalendar, you should follow the moment.js formatting rules: Moment.js Documentation. For instance, the MMM D, YY produces the Sep 9, 24 value.

The property change is not applied after component attached to the UI.

-

defaultEventTimeFormat

Sets the format of the time-text that will be displayed on each event. By default, component sets localized format from messages when is created.

This property act as default format for all display modes and for CustomCalendarDisplayMode until specific property won’t be set for these display modes. However, all display-mode properties objects by default explicitly specify the format, thus they override this property.

As component uses moment plugin for FullCalendar, you should follow the moment.js formatting rules: Moment.js Documentation. For instance, the HH:mm produces the 00:00 (01, 2, …​ 23 : 01, 02 …​ 59).

The property change is not applied after component attached to the UI.

-

defaultSlotLabelFormat

Sets the format of the text that will be displayed within a time slot. By default, component sets localized format from messages when is created.

This property act as default format for all display modes and for CustomCalendarDisplayMode until specific property won’t be set for these display modes. However, all display-mode properties objects by default explicitly specify the format, thus they override this property.

As component uses moment plugin for FullCalendar, you should follow the moment.js formatting rules: Moment.js Documentation. For instance, the ha produces 1 am (1, 2, …​ 12 am/ pm).

The property change is not applied after component attached to the UI.

-

defaultTimedEventDuration

Sets the default duration for timed events if they don’t specify endDateTime property.

For instance, the property is set to 2 hours. The event that has allDay` property equals to false and do not have endDateTime property, will occupy two hours in time slots.

Note, calendar event’s endDateTime property will remain unset, unless forceEventDuration has been set to true. In this case, the calendar will explicitly assign end date to an event. If such event will be changed by dragging or resizing, and you have listeners for these events, the component will set new value to calendar event’s endDateTime property, which can lead to modifying entity/ DTO instance.

This property only affects events with allDay property equals to false.

PT1h

defaultWeekNumberFormat

Sets the format of the week number that will be displayed when weekNumbersVisible is true. By default, component sets localized format from messages when is created.

This property act as default format for all display modes and for CustomCalendarDisplayMode until specific property won’t be set for these display modes. However, all display-mode properties objects by default explicitly specify the format, thus they override this property.

As component uses moment plugin for FullCalendar, you should follow the moment.js formatting rules: Moment.js Documentation. For instance, the [Week] w produces the Week 1 (1, 2, …​ 52, 53).

The property change is not applied after component attached to the UI.

-

direction

The direction in which text should be written. It also reorganizes the component layout.

-

displayEventTime

Determines visibility of time text of each event.

The property applies to timed-events (not all-day). If set to true, time text will always be displayed on the event. If set to false, time text will never be displayed on the event. Events that are all-day will never display time text anyhow.

true

dragRevertDuration

Sets the time it takes for an event to revert to its original position after an unsuccessful drag.

500

dragScroll

Enables to automatically scroll the scroll-containers during event drag-and-drop and date selecting.

The property change is not applied after component attached to the UI.

true

eventBackgroundColor

Sets the background color for all events on the calendar.

Note, calendar events can override this value if they specify backgroundColor property.

Supported values are:

  • #f00

  • #ff0000

  • rgb(255,0,0)

  • Color name - red

-

eventBorderColor

Sets the border color for all events on the calendar.

Note, calendar events can override this value if they specify borderColor property.

Supported values are:

  • #f00

  • #ff0000

  • rgb(255,0,0)

  • Color name - red

-

eventConstraintBusinessHoursEnabled

Sets whether events being dragged or resized must be fully contained within the week’s business hours. It also respects custom business hours.

false

eventConstraintGroupId

Sets a group ID to limit the dragging and resizing of events. Events that are being dragged or resized must be fully contained by at least one of the events linked to by the given group ID.

Takes precedence over eventConstraintBusinessHoursEnabled.

The group ID can be an entity instance, string, enum or other types.

-

eventDisplay

Sets the display mode that controls the appearance of all events that do not specify display mode.

To control the display of specific events, use the display property of calendar event.

AUTO

eventDragMinDistance

Sets how many pixels the user’s mouse/touch must move before an event drag activates.

5

eventDurationEditable

Enables to edit event duration using resizing. This property can be overridden on per-event by durationEditable property.

false

eventHint

Sets for list display modes' non-visible table header the name of the column with event names.

-

eventInteractive

Enables to edit event duration using resizing

This property can be overridden on per-event by interactive property.

false

eventLongPressDelay

Sets the amount of time, in milliseconds, that the user must hold down before an event becomes draggable on touch devices.

1000

eventMaxStack

Sets the maximum number of events that stack top-to-bottom for time-grid display modes.

-

eventOrder

Sets the list of calendar event properties that should participate in sorting. It is also available to specify properties from event’s additionalProperties property.

For most calendar display modes, this property determines the vertical ordering of events within the same day. For time-grid display modes however, it determines the horizontal ordering of events within the same time slot.

The default value puts earlier events first. If tied, it puts longer events first. If still tied, it puts all-day events first. If still tied, orders events by title, alphabetically.

If putting a lower-precedent event before a higher-precedent improves compactness, the algorithm will do so. To disable this behavior, set eventOrderStrict to true.

The provided properties are sorted in ascending order. If a property is prefixed with a minus sign like -title, sorting will be in descending order.

start,-duration,allDay,title

eventOrderStrict

Enables the component to strictly follow the specified event order.

The false value, meaning the event order is not strict and compactness will be prioritized over following event order exactly.

false

eventOverlap

Allows events to overlap each other during dragging and resizing.

true

eventResizableFromStart

Enables to resize an event from its starting date.

false

eventStartEditable

Enables to edit event start time using dragging.

This property can be overridden on per-event by startEditable property.

false

eventTextColor

Sets the text color for all events on the calendar.

Note, calendar events can override this value if they specify textColor property.

Supported values are:

  • #f00

  • #ff0000

  • rgb(255,0,0)

  • Color name - red

The color applies in time-grid display modes and for all-day events in day-grid display modes.

-

expandRows

Enables to expand rows of time-grid display modes if they don’t take up the entire height.

false

firstDayOfWeek

Sets the day that each week begins. The default value is taken from locale.

-

forceEventDuration

Makes the component to assign endDateTime property value to events if they do not have it.

Note, if event does not specify endDateTime property, the component will set it explicitly. If such event will be changed by dragging or resizing, and you have listeners for these events, the component will set new value to calendar event endDateTime property, which can lead to modifying entity/ DTO instance.

false

initialDate

Sets the initial date that will be displayed when the component is attached to UI. If not specified, the current date will be used.

The property change is not applied after component attached to the UI.

-

initialDisplayMode

Sets initial calendar display mode that will be shown after attaching component to th UI.

The property change is not applied after component attached to the UI.

DAY_GRID_MONTH

moreLinkClassNames

Sets CSS class names that should be added to "more" link.

-

moreLinkDisplayMode

Sets the calendar display mode that should be shown when "more" link is clicked.

-

moreLinkHint

Sets the "more" link hint. The provided text can be a JavaScript Template string. This template takes the count parameter that has Number type, for instance:

setMoreLinkHint("Show ${count} more event${count === 1 ? '' : 's'}");

It also takes a string definition of JavaScript function that takes count as a parameter. For instance:

setMoreLinkHint("function (count) { return `Show ${count} more event${count === 1 ? '' : 's'}`; }");

-

moreLinkText

Sets the "more" link text. The provided text can be a JavaScript Template string. This template takes the count parameter, for instance:

setMoreLinkText("+${count} event(s)");

It also takes a string definition of JavaScript function that takes the count as a parameter. For instance:

setMoreLinkText("function (count) { return `See +${count} event` + (count === 1 ? '' : 's'); }");

-

navLinkHint

Sets the hint text of navigation links. The provided text can be a JavaScript Template string. This template takes the date parameter that has String type, for instance:

setNavLinkHint("Navigate to ${date}");

It also takes a string definition of JavaScript function that takes the date as a parameter with the String type. For instance:

setNavLinkHint("function (date) { return `Navigate to ${date}`; }");

-

navigationLinksEnabled

Enables navigation to date using day names and week names.

false

nextDayThreshold

Sets the minimum time that event’s endDateTime property should achieve to render event as it if were on that day.

For instance, the property is set to 09:00:00. And there is an event with dates:

  • start - 2024-09-01T20:00:00;

  • end - 2024-09-02T02:00:00;

So, the event spans to another day, but it will be rendered as a one-day event, because the nextDayThreshold property is specified. However, If the event has end date - 2024-09-02T10:00:00, it will be rendered as two-day event.

Only affects timed events that appear on whole-days cells. Whole-day cells occur in day-grid display modes and the all-day slots in the time-grid display modes.

Note that this property is ignored when event’s allDay property is set to true.

-

noEventsText

Sets text that will be shown when no events are displayed in list display modes

-

progressiveEventRendering

Enables displaying a marker indicating the current time. The property applies in time-grid display modes.

The property change is not applied after component attached to the UI.

false

progressiveEventRendering

Enables rendering of events from the data provider as soon as the events are loaded.

  • true - renders each data provider as it is received. Will result in more renders.

  • false - waits until all data providers have received their data and then renders everything at once, resulting in fewer renders.

false

scrollTime

Sets the initial scroll position to a specific time. Users will be able to scroll back to see events before this time. If you want to prevent users from doing this, use the slotMinTime instead.

By default, the scroll time is reapplied to the calendar whenever the date range changes. To disable this, set scrollTimeReset to false.

The property change is not applied after component attached to the UI.

PT6h

scrollTimeReset

Sets whether the calendar should scroll to scrollTime every time the date range changes.

By default, whenever the date range changes, either via calendar methods or user actions, the scroll is reset. To disable this behavior, set the property to false.

true

selectConstraintBusinessHoursEnabled

Sets whether the selection must be fully contained within the week’s business hours. It also respects custom business hours.

This property will be applied if selectionEnabled is enabled.

false

selectConstraintGroupId

Sets a group ID to limit selection. If group ID is set, only cells with events that contain the same group ID can be selected. Takes precedence over the selectConstraintBusinessHoursEnabled.

This property will be applied if selectionEnabled is enabled.

selectLongPressDelay

Sets the amount of time the user must hold down before a date becomes selectable on touch devices.

1000

selectMinDistance

Sets the minimum distance the user’s mouse must travel after a mousedown, before a selection is allowed. A non-zero value is useful for differentiating a selection from a date click event.

This property is only applicable to mouse-related interaction. For touch interaction, see selectLongPressDelay.

The property change is not applied after component attached to the UI.

0

selectMirror

Enables the drawing of a placeholder event while the user is dragging. This property applies to time-grid display modes.

false

selectOverlap

Enables to select cells that contains events.

true

selectionEnabled

Allows the user to highlight multiple days or timeslots by clicking and dragging.

false

slotDuration

Sets the interval at which time slots are displayed.

In XML component definition, the attribute value should follow the ISO-8601 duration format, which is used by the java.time.Duration class.

PT30m

slotLabelInterval

Sets the frequency for labeling time slots with text. If not specified, a reasonable value will be automatically computed based on slotDuration.

When specifying this property, give the 1 hour value, this will cause the header labels to appear on the hour marks, even if the slotDuration was hypothetically 15 or 30 minutes long.

In XML component definition, the attribute value should follow the ISO-8601 duration format, which is used by the java.time.Duration class.

-

slotMaxTime

Sets the last time slot that will be displayed for each day. The specified value represents the exclusive end time, meaning the time slot ending at this value will not be included. The property determines the last slot, even when the scrollbars have been scrolled all the way back.

In XML component definition, the attribute value should follow the ISO-8601 duration format, which is used by the java.time.Duration class.

PT24h

slotMinTime

Sets the first time slot that will be displayed for each day. The property determines the first time slot, even when the scrollbars have been scrolled all the way back.

In XML component definition, the attribute value should follow the ISO-8601 duration format, which is used by the java.time.Duration class.

PT0h

snapDuration

Sets a value that determines the time interval at which a dragged event will snap to the time axis. This also affects the granularity at which selections can be made.

In XML component definition, the attribute value should follow the ISO-8601 duration format, which is used by the java.time.Duration class.

PT30m

timeHint

Sets for list display modes' non-visible table header the name of the column with days and times

-

unselectAuto

Sets whether clicking elsewhere on the page will clear the current selection. Works only if selectionEnabled is true.

The property change is not applied after component attached to the UI.

true

unselectCancelSelector

Sets the CSS selector that will ignore the unselectAuto property. For instance:

vaadin-form-layout .custom-text-input

The property change is not applied after component attached to the UI.

-

weekNumbersVisible

Sets whether week numbers should be displayed on the calendar.

false

weekTextLong

The long name of the week.

-

weekendsVisible

Sets whether to include Saturday and Sunday columns in any of the calendar display modes.

true

windowResizeDelay

Sets the delay, in milliseconds, that the calendar will wait before adjusting its size after a window resize occurs.

100

Handlers

In Jmix there are many common handlers that are configured in the same way for all components. The following are handlers specific to calendar:

在 Jmix Studio 生成处理器桩代码时，可以使用 Jmix UI 组件面板的 Handlers 标签页或者视图类顶部面板的 Generate Handler 添加，也可以通过 Code → Generate 菜单（Alt+Insert / Cmd+N）生成。
Name Description

DateClickEvent

io.jmix.fullcalendarflowui.component.event.DateClickEvent fired when a day cell or time cell is clicked.

DatesSetEvent

io.jmix.fullcalendarflowui.component.event.DatesSetEvent fired after the calendar’s date range has been initially set or changed in some way and the DOM of component has been updated.

The calendar’s dates can change any time the user does the following:

  • navigates to next and previous;

  • switches the display mode;

  • clicks a navigation link (e.g.week or day if navigationLinksEnabled is true.

The dates can also change when the current-date is manipulated via the API.

DayNavigationLinkClickEvent

Fired when the user clicks on day heading navigation link. The navigation link can be activated by the navigationLinksEnabled property.

EventClickEvent

io.jmix.fullcalendarflowui.component.event.EventClickEvent fired when the calendar event is clicked.

EventDropEvent

io.jmix.fullcalendarflowui.component.event.EventDropEvent fired when the dragging stops and the event has been moved to a different day or time slot.

EventMouseEnterEvent

io.jmix.fullcalendarflowui.component.event.EventMouseEnterEvent fired when the user mouses over a calendar event.

EventMouseLeaveEvent

io.jmix.fullcalendarflowui.component.event.EventMouseLeaveEvent fired when the user mouses out of a calendar event.

EventResizeEvent

io.jmix.fullcalendarflowui.component.event.EventResizeEvent fired when the resizing stops and the calendar event’s duration has changed.

MoreLinkClickEvent

io.jmix.fullcalendarflowui.component.event.MoreLinkClickEvent fired when the user clicks on "more" link. The "more" link can be activated by the following properties:

SelectEvent

io.jmix.fullcalendarflowui.component.event.SelectEvent fired when a date/time selection is made.

Selection mode can be enabled by selectionEnabled property.

UnselectEvent

io.jmix.fullcalendarflowui.component.event.UnselectEvent fired when the current selection is cleared. A selection might be cleared for a number of reasons:

  • The user clicks away from the current selection (doesn’t happen when unselectAuto is disabled).

  • The user makes a new selection. The unselect event will be fired before the new selection occurs.

  • The user moves forward or backward in the current calendar’s display mode, or switches to another mode.

  • The unselect() method is called.

WeekNavigationLinkClickEvent

Fired when the user clicks on the week number navigation link.

The navigation link can be activated by the navigationLinksEnabled property.

dayCellBottomText- ClassNamesGenerator

Generates CSS class names for day cell’s bottom text.

Note, the generator will be invoked only if cell’s bottom text is not null.

dayCellBottomTextGenerator

Generates the bottom text for day cells. It applies only for day-grid month and year and display modes.

Note that in some cases, events in a cell can overlap the text at the bottom. To avoid this, it is recommended to limit the visible number of events. For instance, you can use the dayMaxEvents property.

dayCellClassNamesGenerator

Generates CSS class names for day cells. The day cell appears in day-grid and time-grid display modes as an all-day cell.

dayHeaderClassNamesGenerator

Generates CSS class names for day headers. The day header is a cell that shows day of week and date in some display modes.

moreLinkClassNamesGenerator

Generates CSS class names for "more" link.

The generator takes precedence over other methods that set CSS class names.

nowIndicatorClassNamesGenerator

Generates CSS class names for a now-indicator. The now-indicator consists of two parts: the line and the axis.

The now-indicator can be enabled by nowIndicatorVisible property.

slotLabelClassNamesGenerator

Generates CSS class names for the slot label, which appears as a cell with a time label in time-grid display modes.

Elements

Elements of the calendar provide a wide range of options to control the appearance, behavior, formatting, data binding and other functionalities.

To add an element to a selected component click the Add button in the Jmix UI inspector panel.

businessHours

The businessHours is a group element that contains business hours entries.

XML Element

businessHours

Elements

entry

entry

The business hours definition.

XML Element

entry

Elements

day
Attributes

Name

Description

Default

endTime

The end time of business hours. The value of time must be in ISO-8601 duration format, which is used by the java.time.Duration class. For instance:

  • "P9h" - 9 hours.

  • "PT18h30m" - 18 hours and 30 minutes.

-

startTime

The start time of business hours. The value of time must be in ISO-8601 duration format, which is used by the java.time.Duration class. For instance:

  • "P9h" - 9 hours.

  • "PT18h30m" - 18 hours and 30 minutes.

-

customDisplayModes

The customDisplayModes is a group element that contains definitions of custom display modes that the component can use.

XML Element

customDisplayModes

Elements

displayMode

displayMode

The definition of custom display mode.

XML Element

displayMode

Elements

duration - properties
Attributes

Name

Description

Default

id

Required attribute, the ID can be used to set as initial or current display mode.

-

type

The type on which custom display mode will be based. See Custom Calendar Display Mode for details.

DAY_GRID

dayCount

The exact number of days displayed in a custom display mode.

-

duration

Describes the duration of custom calendar display mode.

XML Element

duration

Elements

-
Attributes

Name

Description

Default

days

Sets days for a duration.

0

hours

Sets hours for a duration

0

milliseconds

Sets milliseconds for a duration

0

minutes

Sets minutes for a duration

0

months

Sets months for a duration

0

seconds

Sets seconds for a duration

0

weeks

Sets weeks for a duration

0

years

Sets years for a duration

0

dataProviders

The dataProviders is a group element that contains definitions of data providers that the component uses.

XML Element

dataProviders

Elements

containerDataProvider - callbackDataProvider

containerDataProvider

The containerDataProvider is a data provider that binds to data containers. It contains attributes for mapping properties from an entity to a calendar event.

XML Element

containerDataProvider

Elements

-
Attributes

Name

Description

Default

id

The data provider identifier.

-

dataContainer

The ID of a data container that is defined in the same view. Attribute is required.

-

additionalProperties

The additional properties from an entity. The properties must be split by comma or space.

Refer to additionalProperties of a calendar event.

-

allDay

The allDay property in an entity.

Refer to allDay of a calendar event.

-

backgroundColor

The backgroundColor property in an entity.

Refer to backgroundColor of a calendar event.

-

borderColor

The borderColor property in an entity.

Refer to borderColor of a calendar event.

-

classNames

The classNames property in an entity. Note, an entity should contain string value with class names separated by space.

Refer to classNames of a calendar event.

-

constraint

The constraint property in an entity.

Refer to constraint of a calendar event.

-

description

The description property in an entity.

Refer to description of a calendar event.

-

display

The display property in an entity.

Refer to display of a calendar event.

-

durationEditable

The durationEditable property in an entity.

Refer to durationEditable of a calendar event.

-

endDateTime

The endDateTime property in an entity.

Refer to endDateTime of a calendar event.

-

groupId

The groupId property in an entity.

Refer to groupId of a calendar event.

-

interactive

The interactive property in an entity.

Refer to interactive of a calendar event.

-

overlap

The overlap property in an entity.

Refer to overlap of a calendar event.

-

recurringDaysOfWeek

The recurringDaysOfWeek property in an entity.

Refer to recurringDaysOfWeek of a calendar event.

-

recurringEndDate

The recurringEndDate property in an entity.

Refer to recurringEndDate of a calendar event.

-

recurringEndTime

The recurringEndTime property in an entity.

Refer to recurringEndTime of a calendar event.

-

recurringStartDate

The recurringStartDate property in an entity.

Refer to recurringStartDate of a calendar event.

-

recurringStartTime

The recurringStartTime property in an entity.

Refer to recurringStartTime of a calendar event.

-

startDateTime

The startDateTime property in an entity.

Refer to startDateTime of a calendar event.

-

startEditable

The startEditable property in an entity.

Refer to startEditable of a calendar event.

-

textColor

The textColor property in an entity.

Refer to textColor of a calendar event.

-

title

The title property in an entity.

Refer to title of a calendar event.

-

callbackDataProvider

The callbackDataProvider is a data provider that loads entities using a JPQL query or a load delegator. It contains attributes for mapping properties from an entity to a calendar event.

XML Element

callbackDataProvider

Elements

itemsQuery
Attributes

Name

Description

Default

id

The data provider identifier.

-

additionalProperties

The additional properties from an entity. The properties must be split by comma or space.

Refer to additionalProperties of a calendar event.

-

allDay

The allDay property in an entity.

Refer to allDay of a calendar event.

-

backgroundColor

The backgroundColor property in an entity.

Refer to backgroundColor of a calendar event.

-

borderColor

The borderColor property in an entity.

Refer to borderColor of a calendar event.

-

classNames

The classNames property in an entity. Note, an entity should contain string value with class names separated by space.

Refer to classNames of a calendar event.

-

constraint

The constraint property in an entity.

Refer to constraint of a calendar event.

-

description

The description property in an entity.

Refer to description of a calendar event.

-

display

The display property in an entity.

Refer to display of a calendar event.

-

durationEditable

The durationEditable property in an entity.

Refer to durationEditable of a calendar event.

-

endDateTime

The endDateTime property in an entity.

Refer to endDateTime of a calendar event.

-

groupId

The groupId property in an entity.

Refer to groupId of a calendar event.

-

interactive

The interactive property in an entity.

Refer to interactive of a calendar event.

-

overlap

The overlap property in an entity.

Refer to overlap of a calendar event.

-

recurringDaysOfWeek

The recurringDaysOfWeek property in an entity.

Refer to recurringDaysOfWeek of a calendar event.

-

recurringEndDate

The recurringEndDate property in an entity.

Refer to recurringEndDate of a calendar event.

-

recurringEndTime

The recurringEndTime property in an entity.

Refer to recurringEndTime of a calendar event.

-

recurringStartDate

The recurringStartDate property in an entity.

Refer to recurringStartDate of a calendar event.

-

recurringStartTime

The recurringStartTime property in an entity.

Refer to recurringStartTime of a calendar event.

-

startDateTime

The startDateTime property in an entity.

Refer to startDateTime of a calendar event.

-

startEditable

The startEditable property in an entity.

Refer to startEditable of a calendar event.

-

textColor

The textColor property in an entity.

Refer to textColor of a calendar event.

-

title

The title property in an entity.

Refer to title of a calendar event.

-
Handlers

Name

Description

LoadDelegate

Sets load delegate that will be used for loading events.

itemsQuery

The itemsQuery element describes a JPQL query for loading entities.

XML Element

itemsQuery

Elements

-
Attributes

Name

Description

Default

class

The fully qualified name of the entity class.

-

fetchPlan

The fetch plan that should be used for loading the entity graph.

-

query

The JPQL query.

-

displayModeProperties

The displayModeProperties is a group element that contains all predefined display mode elements to configure their properties.

XML Element

displayModeProperties

Elements

dayGridDay - dayGridWeek - dayGridMonth - dayGridYear - timeGridDay - timeGridWeek - listDay - listWeek - listMonth - listYear - multiMonthYear -

dayGridDay

The properties of the dayGridDay display mode.

XML Element

dayGridDay

Elements

properties
Attributes

Name

Description

Default

dayHeaderFormat

Sets the format for a day header specifically for this display mode. The format rules are the same as for defaultDayHeaderFormat.

-

dayPopoverFormat

Sets the format for a popover specifically for this display mode. The format rules are the same as for defaultDayPopoverFormat.

-

displayEventEnd

Determines an event’s end time visibility.

true

eventTimeFormat

Sets the format for an event time specifically for this display mode. The format rules are the same as for defaultEventTimeFormat.

-

weekNumberFormat

Sets the format for a week specifically for this display mode. The format rules are the same as for defaultWeekNumberFormat.

-

dayGridWeek

The properties of the dayGridWeek display mode.

XML Element

dayGridWeek

Elements

properties
Attributes

Name

Description

Default

dayHeaderFormat

Sets the format for a day header specifically for this display mode. The format rules are the same as for defaultDayHeaderFormat.

-

dayPopoverFormat

Sets the format for a popover specifically for this display mode. The format rules are the same as for defaultDayPopoverFormat.

-

displayEventEnd

Determines an event’s end time visibility.

false

eventTimeFormat

Sets the format for an event time specifically for this display mode. The format rules are the same as for defaultEventTimeFormat.

-

weekNumberFormat

Sets the format for a week specifically for this display mode. The format rules are the same as for defaultWeekNumberFormat.

-

dayGridMonth

The properties of the dayGridMonth display mode.

XML Element

dayGridMonth

Elements

properties
Attributes

Name

Description

Default

dayHeaderFormat

Sets the format for a day header specifically for this display mode. The format rules are the same as for defaultDayHeaderFormat.

-

dayPopoverFormat

Sets the format for a popover specifically for this display mode. The format rules are the same as for defaultDayPopoverFormat.

-

displayEventEnd

Determines an event’s end time visibility.

false

eventTimeFormat

Sets the format for an event time specifically for this display mode. The format rules are the same as for defaultEventTimeFormat.

-

fixedWeekCount

Determines the number of displayed weeks. If true, the calendar will always be 6 weeks tall. If false, the calendar will have either 4, 5, or 6 weeks, depending on the month.

true

showNonCurrentDates

Determines displaying dates from previous and next months.

true

weekNumberFormat

Sets the format for a week specifically for this display mode. The format rules are the same as for defaultWeekNumberFormat.

-

dayGridYear

The properties of the dayGridYear display mode.

XML Element

dayGridYear

Elements

properties
Attributes

Name

Description

Default

dayHeaderFormat

Sets the format for a day header specifically for this display mode. The format rules are the same as for defaultDayHeaderFormat.

-

dayPopoverFormat

Sets the format for a popover specifically for this display mode. The format rules are the same as for defaultDayPopoverFormat.

-

displayEventEnd

Determines an event’s end time visibility.

false

eventTimeFormat

Sets the format for an event time specifically for this display mode. The format rules are the same as for defaultEventTimeFormat.

-

monthStartFormat

Sets the format of the text format for the first cell of each month. By default, component sets localized format from messages when is created.

As the component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "MMMM" produces September (November, December, etc.).

-

weekNumberFormat

Sets the format for a week specifically for this display mode. The format rules are the same as for defaultWeekNumberFormat.

-

timeGridDay

The properties of the timeGridDay display mode.

XML Element

timeGridDay

Elements

properties
Attributes

Name

Description

Default

allDaySlotVisible

Determines if the all-day slots are displayed at the top of the calendar.

true

dayHeaderFormat

Sets the format for a day header specifically for this display mode. The format rules are the same as for defaultDayHeaderFormat.

-

dayPopoverFormat

Sets the format for a popover specifically for this display mode. The format rules are the same as for defaultDayPopoverFormat.

-

displayEventEnd

Determines an event’s end time visibility.

true

eventMinHeight

Sets the minimum height that an event can have.

15

eventShortHeight

Sets the height threshold for when an event has a "short" style.

-

eventTimeFormat

Sets the format for an event time specifically for this display mode. The format rules are the same as for defaultEventTimeFormat.

-

slotEventOverlap

Determines if timed events should visually overlap each other.

true

slotLabelFormat

Sets the format for slot labels specifically for this display mode. The format rules are the same as for defaultSlotLabelFormat.

-

weekNumberFormat

Sets the format for a week specifically for this display mode. The format rules are the same as for defaultWeekNumberFormat.

-

timeGridWeek

The properties of the timeGridWeek display mode.

XML Element

timeGridWeek

Elements

properties
Attributes

Name

Description

Default

allDaySlotVisible

Determines if the all-day slots are displayed at the top of the calendar.

true

dayHeaderFormat

Sets the format for a day header specifically for this display mode. The format rules are the same as for defaultDayHeaderFormat.

-

dayPopoverFormat

Sets the format for a popover specifically for this display mode. The format rules are the same as for defaultDayPopoverFormat.

-

displayEventEnd

Determines an event’s end time visibility.

true

eventMinHeight

Sets the minimum height that an event can have.

15

eventShortHeight

Sets the height threshold for when an event has a "short" style.

-

eventTimeFormat

Sets the format for an event time specifically for this display mode. The format rules are the same as for defaultEventTimeFormat.

-

slotEventOverlap

Determines if timed events should visually overlap each other.

true

slotLabelFormat

Sets the format for slot labels specifically for this display mode. The format rules are the same as for defaultSlotLabelFormat.

-

weekNumberFormat

Sets the format for a week specifically for this display mode. The format rules are the same as for defaultWeekNumberFormat.

-

listDay

The properties of the listDay display mode.

XML Element

listDay

Elements

properties
Attributes

Name

Description

Default

listDayFormat

Sets the format of the text on the left side of the day headings. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "dd" produces Mo (Monday).

-

listDaySideFormat

Sets the format of the text on the right side of the day headings. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "dd" produces Mo (Monday).

-

listDaySideVisible

Sets the visibility of the text on the right side of the day headings.

true

listDayVisible

Sets the visibility of the text on the left side of the day headings.

true

listWeek

The properties of the listWeek display mode.

XML Element

listWeek

Elements

properties
Attributes

Name

Description

Default

listDayFormat

Sets the format of the text on the left side of the day headings. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "dd" produces Mo (Monday).

-

listDaySideFormat

Sets the format of the text on the right side of the day headings. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "dd" produces Mo (Monday).

-

listDaySideVisible

Sets the visibility of the text on the right side of the day headings.

true

listDayVisible

Sets the visibility of the text on the left side of the day headings.

true

listMonth

The properties of the listMonth display mode.

XML Element

listMonth

Elements

properties
Attributes

Name

Description

Default

listDayFormat

Sets the format of the text on the left side of the day headings. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "dd" produces Mo (Monday).

-

listDaySideFormat

Sets the format of the text on the right side of the day headings. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "dd" produces Mo (Monday).

-

listDaySideVisible

Sets the visibility of the text on the right side of the day headings.

true

listDayVisible

Sets the visibility of the text on the left side of the day headings.

true

listYear

The properties of the listYear display mode.

XML Element

listYear

Elements

properties
Attributes

Name

Description

Default

listDayFormat

Sets the format of the text on the left side of the day headings. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "dd" produces Mo (Monday).

-

listDaySideFormat

Sets the format of the text on the right side of the day headings. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "dd" produces Mo (Monday).

-

listDaySideVisible

Sets the visibility of the text on the right side of the day headings.

true

listDayVisible

Sets the visibility of the text on the left side of the day headings.

true

multiMonthYear

The properties of the multiMonthYear display mode.

XML Element

multiMonthYear

Elements

properties
Attributes

Name

Description

Default

fixedWeekCount

Determines the number of displayed weeks. If true, the calendar will always be 6 weeks tall. If false, the calendar will have either 4, 5, or 6 weeks, depending on the month.

true

multiMonthMaxColumns

Sets the maximum columns of months that the display mode will attempt to render.

By default, the display mode will attempt to display 3 columns of mini-months. If there is insufficient space, requiring each month to be smaller than multiMonthMinWidth, fewer columns will be displayed.

3

multiMonthMinWidth

Sets the minimum width of each mini-month. The component will not allow mini-month to be become smaller than this value.

If the available width requires each mini-month to become smaller than this pixel value, the mini-months will wrap to subsequent rows instead.

350

multiMonthTitleFormat

Sets the format of the text above each month. By default, component sets localized format from messages when is created.

As component uses moment plugin for FullCalendar, we should follow the moment.js formatting rules: Moment.js Documentation For instance, the "MMM" produces Sep (Nov, …​).

showNonCurrentDates

Determines displaying dates from previous and next months.

true

hiddenDays

The hiddenDays is a group element that contains the days of the week that should be hidden in the FullCalendar component.

XML Element

hiddenDays

Elements

day

properties

A group element for FullCalendar.js properties.

XML Element

properties

Elements

property

property

The FullCalendar.js property definition.

XML Element

property

Elements

-
Attributes

Name

Description

Default

name

The property name.

-

value

The property value

-

day

The day element represents a day of the week.

XML Element

day

Elements

-
Attributes

Name

Description

Default

name

The name of the day of the week, such as MONDAY, TUESDAY, and other days.

-

See Also

See the FullCalendar Docs for more information.