Vue Component

FullCalendar seamlessly integrates with the Vue JavaScript framework. It provides a component that exactly matches the functionality of FullCalendar’s standard API.

This package is released under an MIT license, the same license the standard version of FullCalendar uses. Useful links:

• Browse the Github repo (please star it!)
• Bug report instructions
• Example projects:
  • Vue 2 example (uses Webpack and css-loader) - runnable
  • Vue 3 example (uses Vite) - runnable

This guide does not go into depth about initializing a Vue project. Please consult the aforementioned example/runnable projects for that.

The first step is to install the FullCalendar-related dependencies. You’ll need FullCalendar core, the Vue adapter, and any plugins you plan to use.

If using Vue 2:

npm install --save \
  @fullcalendar/core \
  @fullcalendar/vue

If using Vue 3:

npm install --save \
  @fullcalendar/core \
  @fullcalendar/vue3

Then install any additional FullCalendar plugins like @fullcalendar/daygrid

You may then begin to write a parent component that leverages the <FullCalendar> component:

<script>
import FullCalendar from '@fullcalendar/vue3'
import dayGridPlugin from '@fullcalendar/daygrid'
import interactionPlugin from '@fullcalendar/interaction'

export default {
  components: {
    FullCalendar // make the <FullCalendar> tag available
  },
  data() {
    return {
      calendarOptions: {
        plugins: [ dayGridPlugin, interactionPlugin ],
        initialView: 'dayGridMonth'
      }
    }
  }
}
</script>
<template>
  <FullCalendar :options="calendarOptions" />
</template>

Props and Emitted Events

Vue has the concept of “props” (via v-bind or :) versus “events” (via v-on or @). For the FullCalendar connector, there is no distinction between props and events. Everything is passed into the master options object as key-value pairs. Here is an example that demonstrates passing in an events array and a dateClick handler:

<script>
import FullCalendar from '@fullcalendar/vue3'
import dayGridPlugin from '@fullcalendar/daygrid'
import interactionPlugin from '@fullcalendar/interaction'

export default {
  components: {
    FullCalendar // make the <FullCalendar> tag available
  },
  data() {
    return {
      calendarOptions: {
        plugins: [ dayGridPlugin, interactionPlugin ],
        initialView: 'dayGridMonth',
        dateClick: this.handleDateClick,
        events: [
          { title: 'event 1', date: '2019-04-01' },
          { title: 'event 2', date: '2019-04-02' }
        ]
      }
    }
  },
  methods: {
    handleDateClick: function(arg) {
      alert('date click! ' + arg.dateStr)
    }
  }
}
</script>
<template>
  <FullCalendar :options="calendarOptions" />
</template>

Modifying Options

You can modify your calendar’s options after initialization by reassigning them within the options object. This is an example of changing the weekends options:

<script>
import FullCalendar from '@fullcalendar/vue3'
import dayGridPlugin from '@fullcalendar/daygrid'
import interactionPlugin from '@fullcalendar/interaction'

export default {
  components: {
    FullCalendar // make the <FullCalendar> tag available
  },
  data() {
    return {
      calendarOptions: {
        plugins: [ dayGridPlugin, interactionPlugin ],
        initialView: 'dayGridMonth',
        weekends: false // initial value
      }
    }
  },
  methods: {
    toggleWeekends: function() {
      this.calendarOptions.weekends = !this.calendarOptions.weekends // toggle the boolean!
    }
  }
}
</script>
<template>
  <button @click="toggleWeekends">toggle weekends</button>
  <FullCalendar :options="calendarOptions" />
</template>

Slot Templates

Slot templates can be passed to FullCalendar components. They accepts slots for all content-injection settings such as eventContent.

<template>
  <FullCalendar :options="calendarOptions">
    <template v-slot:eventContent='arg'>
      <b>{{ arg.event.title }}</b>
    </template>
  </FullCalendar>
</template>

All slots are scoped slots that accept an argument (explicitly named arg in the above example).

Calendar API

Hopefully you won’t need to do it often, but sometimes it’s useful to access the underlying Calendar object for raw data and methods.

This is especially useful for controlling the current date. The initialDate prop will set the initial date of the calendar, but to change it after that, you’ll need to rely on the date navigation methods.

To do something like this, you’ll need to get ahold of the component’s ref (short for “reference”). In the template:

<FullCalendar ref="fullCalendar" :options="calendarOptions" />

Once you have the ref, you can get the underlying Calendar object via the getApi method:

let calendarApi = this.$refs.fullCalendar.getApi()
calendarApi.next()

Kebab-case in Markup

Some people prefer to write component names in kebab-case when writing markup. This will work fine:

<full-calendar :options="calendarOptions" />

However, the properties within calendarOptions must have the same names.

FullCalendar Premium

How do you use FullCalendar Premium’s plugins with Vue? They are no different than any other plugin. Just follow the same instructions as you did dayGridPlugin in the above example. If you plan to use resources, you’ll need the @fullcalendar/resource package:

npm install --save \
  @fullcalendar/core \
  @fullcalendar/vue3 \
  @fullcalendar/resource \
  @fullcalendar/resource-timeline

Then, initialize your calendar. Make sure to include your schedulerLicenseKey:

<script>
import FullCalendar from '@fullcalendar/vue3'
import resourceTimelinePlugin from '@fullcalendar/resource-timeline'

export default {
  components: {
    FullCalendar
  },
  data() {
    return {
      calendarOptions: {
        plugins: [ resourceTimelinePlugin ],
        schedulerLicenseKey: 'XXX'
      }
    }
  }
}
</script>
<template>
  <FullCalendar :options="calendarOptions" />
</template>

TypeScript

For @fullcalendar/vue3, nothing special is needed for TypeScript integration.

For @fullcalendar/vue (Vue 2), it is recommended to use class-based components. See an example TypeScript project

Vuex

Vuex is a popular state management library for Vue that works well with the FullCalendar connector. View an example project

Nuxt

If you plan to use the Nuxt Vue framework, you’ll need special configuration. See the example project