Integration with Svelte
You should be familiar with the basic concepts and patterns of Svelte before reading this documentation. To refresh your knowledge, please refer to the Svelte documentation.
DHTMLX Event Calendar is compatible with Svelte. We have prepared code examples on how to use DHTMLX Event Calendar with Svelte. For more information, refer to the corresponding Example on GitHub.
Creating a project
There are several ways of creating a project:
- you can use the SvelteKit
or
- you can also use Svelte with Vite (but without SvelteKit):
npm create vite@latest
Check the details in the related article.
Installation of dependencies
Let's name the project as my-svelte-event-calendar-app and go to the app directory:
cd my-svelte-event-calendar-app
Install dependencies and run the app. For this, use a package manager:
- if you use yarn, run the following commands:
yarn install
yarn dev
- if you use npm, run the following commands:
npm install
npm run dev
The app should run on a localhost (for instance http://localhost:3000).
Creating Event Calendar
Now you should get the DHTMLX Event Calendar code. First of all, stop the app and proceed with installing the Event Calendar package.
Step 1. Package installation
Download the trial Event Calendar package and follow steps mentioned in the README file. Note that trial Event Calendar is available 30 days only.
Step 2. Component creation
Now you need to create a Svelte component, to add a Event Calendar into the application. Let's create a new file in the src/ directory and name it EventCalendar.svelte.
Importing source files
Open the EventCalendar.svelte file and import Event Calendar source files. Note that:
- if you use PRO version and install the Event Calendar package from a local folder, the import paths look like this:
import { EventCalendar } from 'dhx-eventcalendar-package';
import 'dhx-eventcalendar-package/dist/event-calendar.css';
Note that depending on the used package, the source files can be minified. In this case make sure that you are importing the CSS file as event-calendar.min.css.
- if you use the trial version of Event Calendar, specify the following paths:
import { EventCalendar } from '@dhx/trial-eventcalendar';
import '@dhx/trial-eventcalendar/dist/event-calendar.css';
In this tutorial you can see how to configure the trial version of Event Calendar.
Setting the container and adding Event Calendar
To display Event Calendar on the page, you need to set the container to render the component inside. Check the code below:
<script>
import { EventCalendar } from "@dhx/trial-eventcalendar";
import "@dhx/trial-eventcalendar/dist/event-calendar.min.css"
let container;
</script>
<div bind:this={container} style="width: 100%; height: 100%;"></div>
Then you need to render Event Calendar in the container. Use the new EventCalendar() constructor inside the onMount() method of Svelte, to initialize Event Calendar inside of the container:
<script>
import { EventCalendar } from "@dhx/trial-eventcalendar";
import "@dhx/trial-eventcalendar/dist/event-calendar.css";
import { onMount } from "svelte";
let container;
onMount(() => {
const calendar = new EventCalendar(container,{});
});
</script>
<div bind:this={container} style="width: 100%; height: 100%;"></div>
Loading data
To add data into the Event Calendar, we need to provide a data set. You can create the data.js file in the src/ directory and add some data into it:
export function getData() {
return [
{
id: '27',
type: 'work',
start_date: new Date('2024-06-10T14:00:00'),
end_date: new Date('2024-06-10T18:30:00'),
text: ' Olympiastadion - Berlin ',
details: ' Berlin, GER '
},
{
id: '28',
type: 'rest',
start_date: new Date('2024-06-12T14:00:00'),
end_date: new Date('2024-06-12T16:00:00'),
text: ' Commerz Bank Arena ',
details: ' Frankfurt, GER '
},
{
id: '29',
type: 'meeting',
start_date: new Date('2024-06-13T11:00:00'),
end_date: new Date('2024-06-13T16:00:00'),
text: ' Olympic Stadium - Munich ',
details: ' Munich, GER '
}
];
}
Then open the App.svelte file, import data, and pass it into the new created <EventCalendar/> components as props:
<script>
// ...
import { getData } from "./data.js";
const events = getData();
</script>
<EventCalendar events={events} />
Open the EventCalendar.svelte file and apply the passed props to the Event Calendar configuration object:
<script>
// ...
export let events; // props
let container;
onMount(() => {
new EventCalendar(container, { events })
});
</script>
<div bind:this={container} style="width: 100%; height: 100%;"></div>
You can also use the parse() method inside the onMount() method of Svelte to load data into Event Calendar:
<script>
// ...
export let events;
export let date;
let container;
onMount(() => {
const calendar = new EventCalendar(container, { date });
calendar.parse(events);
});
</script>
<!-- ... */}
Now the Event Calendar component is ready. When the element will be added to the page, it will initialize the Event Calendar object with data. You can provide necessary configuration settings as well. Visit our Event Calendar API docs to check the full list of available properties.
Handling events
When a user makes some action in the Event Calendar, it invokes an event. You can use these events to detect the action and run the desired code for it. See the full list of events.
Open EventCalendar.svelte and complete the onMount() method as in:
onMount(() => {
const calendar = new EventCalendar(container, { columns, cards });
calendar.events.on("add-event", (obj) => {
console.log(obj);
});
});
Step 3. Adding Event Calendar into the app
To add the component into the app, open the App.svelte file and replace the default code with the following one:
<script>
import EventCalendar from "./EventCalendar.svelte";
import { getData } from "./data.js";
const events = getData();
</script>
<EventCalendar events={events} date={new Date(2024, 5, 10)} />
After that, you can start the app to see Event Calendar loaded with data on a page.
Now you know how to integrate DHTMLX Event Calendar with Svelte. You can customize the code according to your specific requirements. The final example you can find on GitHub.