An open API service indexing awesome lists of open source software.

https://github.com/stefanuebe/vaadin-fullcalendar

Integration of FullCalendar for Vaadin Flow.
https://github.com/stefanuebe/vaadin-fullcalendar

full-calendar-scheduler full-callendar fullcalendar fullcalendar-scheduler java vaadin vaadin-addon vaadin-flow

Last synced: 4 months ago
JSON representation

Integration of FullCalendar for Vaadin Flow.

Awesome Lists containing this project

README

          

# FullCalendar for Flow addon
This repository provides a Flow integration of the FullCalendar and the FullCalendar Scheduler for Vaadin Flow (14+).
It is based on the latest version of the FullCalendar library 5.x.

Please also visit the homepage of the FullCalendar at https://fullcalendar.io/. They did a great job at building the foundation for this addons.

## Migration guides, examples, release note details
Since the addon and it's related information grows and grows, we decided to move most of the
relevant information to our repository's wiki. Here you'll find
integration examples, **migration guides**, a feature list, etc. We strongly recommend to check it out :)

https://github.com/stefanuebe/vaadin_fullcalendar/wiki

## Authors of this addon
This addon is currently maintained by Carlo Zanocco and me. If you have any questions or issues, please
use the GitHub repository issues page.

GitHub profile of Carlo: https://github.com/aetasoul

## Scheduler license information:
Please be aware, that the FullCalender Scheduler library this addon is based on has a different license model
then the basic FullCalendar. For details about the license, visit https://fullcalendar.io/license.

**This addon does not provide any commercial license for the Scheduler. The license model of MIT does only affect
the additional files of this addon, not the used original files.**

## Feedback and co.
If there are bugs or you need more features (and I'm not fast enough) feel free to contribute on GitHub. :)
I'm also happy for feedback or suggestions about improvements.

## Vaadin directory
You find the official maven releases at the Vaadin directory:
Fullcalendar: https://vaadin.com/directory/component/full-calendar-flow
Fullcalendar Scheduler: https://vaadin.com/directory/component/full-calendar-scheduler-flow/overview

# FullCalendar Scheduler for Flow addon
This addon extends the **FullCalendar for Flow** addon with the FullCalendar Scheduler, which provides
additional resource based views (Timeline View and Vertical Resource View) for Vaadin 14+ (npm only).

It needs the basic addon (https://vaadin.com/directory/component/full-calendar-flow) to work.
Since this addon is not always updated when the basis gets an update, I suggest, that you add both dependencies
(basis and extension) to always use the latest versions. This extension is compatible as long as the readme
does not tells anything else.

## Additional links and information

For information about the Scheduler (functionality, features, license information, etc.)
visit https://fullcalendar.io/scheduler.

For a Vaadin 10-13 version (that is built on FC 3.10.x), see https://vaadin.com/directory/component/full-calendar-scheduler-extension-vaadin10

## License information:
Please be aware, that the FullCalender Scheduler library this addon is based on has a different license model
then the basic FullCalendar. For details about the license, visit https://fullcalendar.io/license.

**This addon does not provide any commercial license for the Scheduler. The license model of MIT does only affect
the additional files of this addon, not the used original files.**

## Activating the Scheduler
By default the scheduler is not active, when you use a FullCalendar instance. To have an instance with scheduler
activated, use the `withScheduler()` method of the `FullCalendarBuilder`.

This method will throw an exception, if the scheduler extension is not on the class path.

To link a resource with entries, use the Entry subclass `ResourceEntry`.

## Building with V14
It might be, that the transitive dependencies are not resolved correctly.

If you are using Spring Boot please add the `@EnableVaadin` annotation to your application class. Add
the package `org.vaadin.stefan` plus your root package as parameters. This should enable Spring to analyze
all npm dependencies at runtime. Other CDI version should work the same.

If you are not using Spring, but have similiar issues try to add also the goal `build-frontend` to the vaadin maven plugin. This should resolve transitive npm dependencies at build time.

For instance:
```

com.vaadin
vaadin-maven-plugin
${vaadin.version}



prepare-frontend
build-frontend


```

## Additional Features of the Scheduler extension
- Activation of the Scheduler by method in the FullCalendarBuilder.
- Adding resources to a calendar (hierarchies of resources are not yet supported).
- Link one or multiple resources with entries.
- List of possible Scheduler based views (timeline).

*Info:* Entries are linked to calendar internally. The calendar instance is used to resolve resources by after updating an
entry on the client side.

## Feedback and co.
If there are bugs or you need more features (and I'm not fast enough) feel free to contribute on GitHub. :)
I'm also happy for feedback or suggestions about improvements.