Documentation
Getting Started
NPM and ES6 Module Imports
Install FullCalendar version 5.X core package and all the plugins you want to use:
Install SwipeCalendar:
Import SwipeCalendar and its FullCalendar’s plugins dependencies:
Add a placeholder in your HTML:
Initialize SwipeCalendar:
Manual Installation
Download FullCalendar version 5.X from its GitHub repository.
Download SwipeCalendar from the dist folder of its GitHub repository.
Include FullCalendar’s CSS and JS files in your HTML:
Include the SwipeCalendar JS file in your HTML:
Add a placeholder in your HTML:
Initialize SwipeCalendar:
SwipeCalendar Options
SwipeCalendar supports the same API as FullCalendar. This means that you can initialize SwipeCalendar with the same options and callbacks used in FullCalendar.
For the list of available options, please refer to the FullCalendar documentation.
In addition to the FullCalendar options, SwipeCalendar also defines the following options:
Name | Type | Description |
---|---|---|
swipeLicenseKey | String | The SwipeCalendar license key. Without a valid license key, SwipeCalendar will run in trial mode. Entering a valid license key will automatically remove the credit link to SwipeCalendar.io located at the bottom of the calendar. |
swipeSpeed | String | Duration in milliseconds of the transition between calendar views (Default is 250) |
swipeTitlePosition | String | Position of the title within the sliding view part. Value can be 'left', 'center', and 'right' (Default is 'center'). Any other specified value means that the title will not be included in the sliding view part. |
swipeEffect | String | Swipe Transition Effect. Value can be 'slide', 'cube', and 'coverflow' (Default is 'slide'). |