Vue UI Components Documentation

Vue RangeSelector Component

The RangeSelector component for Vue represents a widget which can easily be used to select a numeric or date range. The API of RangeSelector allows for a variety of user settings to be applied such as setting the range in numbers, days, weeks, months, years, etc.

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 RangeSelector component for Vue requires the following import:

import JqxRangeSelector from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxrangeselector.vue';

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

 components: {
    JqxRangeSelector
 },

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 - <JqxRangeSelector/>

<template>
    <JqxRangeSelector :width="width" :height="height"
                      :min="1000" :max="10000"
                      :range="{ from: 3000, to: 5000 }"
                      :minorTicksInterval="minorTicksInterval"
                      :majorTicksInterval="majorTicksInterval">
    </JqxRangeSelector>
</template>

Properties

The properties of the <JqxRangeSelector/> 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 {
        width: 500,
        height: 100,
        min: 1000,
        max: 10000,
        range: { from: 3000, to: 5000 },
        minorTicksInterval: 100,
        majorTicksInterval: 1500
    }
}

Events

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

<JqxRangeSelector @change="onChange()"
                  :width="width" :height="height"
                  :min="1000" :max="10000"
                  :range="{ from: 3000, to: 5000 }"
                  :minorTicksInterval="minorTicksInterval"
                  :majorTicksInterval="majorTicksInterval">
</JqxRangeSelector>

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

methods: {
    onChange: function () {
        // 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:

<JqxRangeSelector ref="rangeselector"></JqxRangeSelector>

Here how you can use a component's method:

this.$refs.rangeselector.getRange();

methods: {
    // Add here all used callbacks and/or events
    onChange: function () {
        // Do something...
        let range = this.refs.rangeselector.getRange();
        alert(range);
    }
}

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:

<template>
    <JqxRangeSelector ref="rangeselector" @change="onChange()"
                      :width="width" :height="height"
                      :min="1000" :max="10000"
                      :range="{ from: 3000, to: 5000 }"
                      :minorTicksInterval="minorTicksInterval"
                      :majorTicksInterval="majorTicksInterval">
    </JqxRangeSelector>
</template>
 
<script>
    // Import the components that will be used
    import JqxRangeSelector from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxrangeselector.vue';
    
    export default {
        components: {
        // Adding imported widgets here
            JqxRangeSelector
        },
        data: function () {
            // Define properties which will use in the widget
            return {
                width: 500,
                height: 100,
                min: 1000,
                max: 10000,
                range: { from: 3000, to: 5000 },
                minorTicksInterval: 100,
                majorTicksInterval: 1500
            }
        },        
        beforeCreate: function () {
            // Add here any data where you want to transform before components be rendered
        },
        methods: {
            // Add here all used callbacks and/or events
            onChange: function () {
                // Do something...
                let range = this.refs.rangeselector.getRange();
                alert(range);
            }
        }
    }
</script>
  
<style>
</style>

RangeSelector Example

<template>
    <div>
        <JqxRangeSelector ref="rangeSelector"
                          :width="500"
                          :height="100"
                          :min="min"
                          :max="max"
                          :range="range"
                          :majorTicksInterval="'week'"
                          :minorTicksInterval="'day'"
                          :labelsFormat="'dd'"
                          :markersFormat="'d'"
                          :showGroupLabels="true">
            <div id="JqxRangeSelectorContent">
                <img id="backgroundImage" />
            </div>
        </JqxRangeSelector>
        <br />
        <JqxButton style="margin-left: 80px;" @click="onClickSubmit()">
            Submit vacation
        </JqxButton>
        <div style="margin-left: 80px; margin-top: 10px;" ref="result">
        </div>
    </div>
</template>
 
<script>
    import JqxRangeSelector from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxrangeselector.vue';
    import JqxButton from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxbuttons.vue';
 
    export default {
        components: {
            JqxRangeSelector,
            JqxButton
        },
        data: function () {
            return {
                min: new Date(2014, 5, 1),
                max: new Date(2014, 9, 1),
                range: { from: new Date(2014, 5, 1), to: new Date(2014, 6, 29), min: { days: 7 } }
            }
        },
        methods: {
            onClickSubmit: function () {
                let months = new Array("January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December");
                let range = this.$refs.rangeSelector.getRange();
 
                let from = new Date(range.from.toString());
                let to = new Date(range.to.toString());
 
                let fromDate = from.getDate();
                let fromMonth = from.getMonth();
                let toDate = to.getDate();
                let toMonth = to.getMonth();
 
                this.$refs.result.innerHTML = "Vacation period selected: from " + months[fromMonth] + " " + fromDate + " to " + months[toMonth] + " " + toDate;
            }
        }
    }
</script>
 
<style>
    .jqx-button {
        width: fit-content;
    }
 
    html, body {
        width: 100vw;
        height: 100vh;
        padding: 0;
        margin: 0;
    }
 
    #backgroundImage {
        width: 500px;
        height: 100px;
        background: url(../public/images/imageNature5.jpg) -100px -100px;
    }
</style>

Run Code