pages/fullcalendar-main/packages/icalendar/README.md
2024-03-06 14:33:17 +01:00

43 lines
972 B
Markdown

# FullCalendar iCalendar Plugin
Display events from a public [iCalendar feed](https://icalendar.org/)
## Installation
First, ensure ical.js is installed:
```sh
npm install ical.js
```
Then, install the FullCalendar core package, the iCalendar plugin, and any other plugins (like [daygrid](https://fullcalendar.io/docs/month-view)):
```sh
npm install @fullcalendar/core @fullcalendar/icalendar @fullcalendar/daygrid
```
## Usage
Instantiate a Calendar with the necessary plugins and options:
```js
import { Calendar } from '@fullcalendar/core'
import iCalendarPlugin from '@fullcalendar/icalendar'
import dayGridPlugin from '@fullcalendar/daygrid'
const calendarEl = document.getElementById('calendar')
const calendar = new Calendar(calendarEl, {
plugins: [
iCalendarPlugin,
dayGridPlugin
],
initialView: 'dayGridMonth',
events: {
url: 'https://mywebsite.com/icalendar-feed.ics',
format: 'ics' // important!
}
})
calendar.render()
```