Vue UI Components Documentation

Vue Calendar Component

The Calendar component for Vue represents a set of buttons that can work as normal buttons, radio buttons or checkboxes.

Prerequisites

Refer to Vue Getting Started before you start with this help topic.

Configuration

After you have created your App.vue file, here is how you should structure it:

The Calendar component for Vue requires the following import:

import JqxCalendar from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxcalendar.vue';

Add the jqxCalendar component to the components section of the the Vue class:

 components: {
    JqxCalendar
 },

Template

The App.vue has a <template> structural tag where we determine the application structure. There we will also set the tags for the new components - <JqxCalendar/>

<template>
    <JqxCalendar :width="220" :height="220"
                 :selectionMode="'range'" :value="value">
    </JqxCalendar>
</template>

Properties

The properties of the <JqxCalendar/> component are defined in the data member of the Vue class. We should put them in the return object of the data function:

data: function () {
    return {
        value: new Date(2016, 7, 7)
    }
}

Events

The events in Vue are set as an attribute with @ prefix, for example:

<JqxCalendar @change="myCalendarOnChange($event)"
             :width="220" :height="220"
             :selectionMode="'range'" :value="value">
</JqxCalendar>

All events that are bound to a component are implemented in the methods member of the Vue class.

methods: {
    myCalendarOnChange: function (event) {
        // Do something...
    }
}

Methods

To use a component's method we should have its reference. In Vue we refer to a component by the special $refs property. Before that we need to add the desired name reference to that component:

<JqxCalendar ref="calendar"></JqxCalendar>

Here how you can use a component's method:

this.$refs.calendar.refresh();

methods: {
    // Add here all used callbacks and/or events
    myCalendarOnChange: function (event) {
        // Do something on changing the calendar
        this.$refs.calendar.refresh();
    }
}

If we want to add additional methods we should also implement them in the methods member.

In case we need to do some precalculation or something else before the components are rendered, we should use the beforeCreate member. It depends on the case.

If you have followed the above steps, you App.vue file would look like this:

App.vue:

Calendar Examples

<template>
    <div>
        <JqxCalendar ref="myCalendar" @change="myCalendarOnChange($event)"
                     :width="220" :height="220"
                     :selectionMode="'range'" :value="value">
        </JqxCalendar>
        <div ref="log"></div>
    </div>
</template>
 
<script>
    import JqxCalendar from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxcalendar.vue';
     
    export default {
        components: {
            JqxCalendar
        },
        data: function () {
            return {
                value: new Date(2016, 7, 7)
            }
        },
        mounted: function () {
            let date1 = new Date();
            date1.setFullYear(2016, 7, 7);
            let date2 = new Date();
            date2.setFullYear(2016, 7, 15);
            this.$refs.myCalendar.setRange(date1, date2);
        },
        methods: {
            myCalendarOnChange: function (event) {
                let selection = event.args.range;
                this.$refs.log.innerHTML = '<div>From: ' + selection.from.toLocaleDateString() + ' <br/>To: ' + selection.to.toLocaleDateString() + '</div>';
            }
        }
    }
</script>
 
<style>
</style>

Run Code