Schedule-X Add-on for Vaadin Flow

This is a Vaadin Flow add-on based on the Schedule-X JavaScript component.

It allows you to build an event calendar with multiple customizable views to easily display, organize, and coordinate events.

⚠️ Important: This add-on requires a Schedule-X Premium Subscription. The Resource View feature and several used plugins (e.g., event drawing, iCal support, resource views, etc.) are distributed as private npm packages.

To use this component, you must:

1. Subscribe to Schedule-X Premium
2. Configure an .npmrc file as explained in the Schedule-X Premium installation guide

This component is part of the Vaadin Component Factory.

Features

• Supported views:

  • Day
  • Week
  • Month Grid
  • Month Agenda
  • Resource View (*)

• Java Configuration API:

  • Default view and initial date
  • Week and month view customization (via WeekOptions, MonthGridOptions)
  • Define visible day/time boundaries (DayBoundaries)
  • First day of the week
  • Minimum and maximum date limits
  • Resize/drag interval granularity
  • Scroll controller config
  • Current time indicator customization
  • Draw options
  • ICal integration to import events from an iCalendar source

• Calendar Interaction:

  • Programmatically set view, date, first day of week, day boundaries, calendars, etc.
  • Implementation to allow navigate forwards or backwards in the views
  • Scroll to time
  • Configuration updates

• Event Support:

  • Create, update, and remove events from server side
  • Define title, location, description, and attendees
  • Assign events to calendars (calendarId)
  • Assign events to resources (resourceId)
  • Recurring events using RRULE (RecurrenceRule) and excluded date support
  • Drag & drop events
  • Resize events
  • Draw events (*)

• Lazy loading:

  • Supports lazy loading using CallbackDataProvider

• Resource Scheduler Support(*):

  • Display resources in a time grid (hourly and daily views available)
  • Resource row and event height control
  • Control initial visible hours/days
  • Enable/disable drag and resize
  • Infinite scrolling

• Scheduling Assistant Plugin (*):

  • Conflict detection and available time slot visualization

• Full Event Listener Support:

  • Event click handling (CalendarEventClickEvent)
  • Event add/update/remove notifications
  • Drag/resize updates (EventUpdateEvent)
  • Selected date change (SelectedDateUpdateEvent)
  • View and date update (CalendarViewAndDateChangeEvent)

(*) These features are part of the Premium Schedule-X package.

Examples

Calendar with Month View

Calendar with Week View

Calendar with Day View

Calendar with Agenda View

Resource Scheduler with Hourly View

Resource Scheduler with Daily View

Resource Scheduler with Scheduling Assistant (Hourly view only)

Installing the component

Run from the command line:

• mvn clean install -DskipTests

Running the component demo

1. Create an .npmrc file as described in the Schedule-X installation guide. Place this file in the root folder of the vcf-schedule-x-demo module.

2. Run from the command line:

• mvn -pl vcf-schedule-x-demo -Pwar install jetty:run

3. Then navigate to http://localhost:8080/

Using the component in a Flow application

To use the component in an application using maven, add the following dependency to your pom.xml:

<dependency>
    <groupId>org.vaadin.addons.componentfactory</groupId>
    <artifactId>vcf-schedule-x</artifactId>
    <version>${component.version}</version>
</dependency>

How to Use

Usage examples are available in the vcf-schedule-x-demo module.

Profiles

Profile "directory"

This profile, when enabled, will create the zip file for uploading to Vaadin's directory

Profile "production"

This profile, when enabled, will execute a production build for the demo

Flow documentation

Documentation for Vaadin Flow can be found in Flow documentation.

License

Distributed under Apache Licence 2.0.

Sponsored development

Major pieces of development of this add-on has been sponsored by multiple customers of Vaadin. Read more about Expert on Demand at: Support and Pricing.