Vue ListBox Component

The ListBox component for Vue represents a listbox widget that contains a list of selectable items.

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

import JqxListBox from "jqwidgets-scripts/jqwidgets-vue/vue_jqxlistbox.vue";

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

 components: {
    JqxListBox
 },

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

<template>
    <JqxListBox :width="width" :height="height"
                :source="source" :selectedIndex="3">
    </JqxListBox>
</template>

Properties

The properties of the <JqxListBox/> 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: 200,
        height: 250,
        source: [
            "Affogato",
            "Americano",
            "Bicerin",
            "Breve",
            "Café Bombón",
            "Café au lait",
            "Caffé Corretto",
            "Café Crema",
            "Caffé Latte",
            "Caffé macchiato",
            "Café mélange",
            "Coffee milk",
            "Cafe mocha",
            "Cappuccino",
            "Carajillo",
            "Cortado",
            "Cuban espresso",
            "Espresso",
            "Eiskaffee",
            "The Flat White",
            "Frappuccino",
            "Galao",
            "Greek frappé coffee",
            "Iced Coffee",
            "Indian filter coffee",
            "Instant coffee",
            "Irish coffee",
            "Liqueur coffee"
        ]
    }
}

Events

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

<JqxListBox @select="onSelect()"
            :width="width" :height="height"
            :source="source" :selectedIndex="3">
</JqxListBox>

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

methods: {
    onSelect: 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:

<JqxListBox ref="listbox"></JqxListBox>

Here how you can use a component's method:

this.$refs.listbox.getSelectedItems(); 

methods: {
    // Add here all used callbacks and/or events
    onSelect: function () {
        // Do something...
        let items = this.$refs.listbox.getSelectedItems();
        alert(items);
    }
}

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>
    <JqxListBox ref="listbox" @select="onSelect()"
                :width="width" :height="height"
                :source="source" :selectedIndex="3">
    </JqxListBox>
</template>
 
<script>
    // Import the components that will be used
    import JqxListBox from "jqwidgets-scripts/jqwidgets-vue/vue_jqxlistbox.vue";
    
    export default {
        components: {
        // Adding imported widgets here
            JqxListBox
        },
        data: function () {
            // Define properties which will use in the widget
            return {
                width: 200,
                height: 250,
                source: [
                    "Affogato",
                    "Americano",
                    "Bicerin",
                    "Breve",
                    "Café Bombón",
                    "Café au lait",
                    "Caffé Corretto",
                    "Café Crema",
                    "Caffé Latte",
                    "Caffé macchiato",
                    "Café mélange",
                    "Coffee milk",
                    "Cafe mocha",
                    "Cappuccino",
                    "Carajillo",
                    "Cortado",
                    "Cuban espresso",
                    "Espresso",
                    "Eiskaffee",
                    "The Flat White",
                    "Frappuccino",
                    "Galao",
                    "Greek frappé coffee",
                    "Iced Coffee",
                    "Indian filter coffee",
                    "Instant coffee",
                    "Irish coffee",
                    "Liqueur coffee"
                ]
            }
        },        
        beforeCreate: function () {            
            // Add here any data where you want to transform before components be rendered
        },
        methods: {
            // Add here all used callbacks and/or events
            onSelect: function () {
                // Do something...
                let items = this.$refs.listbox.getSelectedItems();
                alert(items);
            }
        }
    }
</script>
 
<style>
</style>

ListBox Example

<template>
    <div>
        <JqxListBox ref="myListBox"
                    @checkChange="checkChange($event)"
                    :source="source"
                    :checkboxes="true"
                    :width="200"
                    :height="250">
        </JqxListBox>
 
        <div style="font-size: 13px; font-family: Verdana; margin-top: 20px;" ref="events"></div>
        <div style="font-size: 13px; font-family: Verdana; margin-top: 10px;" ref="checkedItems"></div>
    </div>
</template>
<script>
    import JqxListBox from "jqwidgets-scripts/jqwidgets-vue/vue_jqxlistbox.vue";
 
    export default {
        components: {
            JqxListBox
        },
        data: function () {
            return {
                source: [
                    "Affogato",
                    "Americano",
                    "Bicerin",
                    "Breve",
                    "Café Bombón",
                    "Café au lait",
                    "Caffé Corretto",
                    "Café Crema",
                    "Caffé Latte",
                    "Caffé macchiato",
                    "Café mélange",
                    "Coffee milk",
                    "Cafe mocha",
                    "Cappuccino",
                    "Carajillo",
                    "Cortado",
                    "Cuban espresso",
                    "Espresso",
                    "Eiskaffee",
                    "The Flat White",
                    "Frappuccino",
                    "Galao",
                    "Greek frappé coffee",
                    "Iced Coffee",
                    "Indian filter coffee",
                    "Instant coffee",
                    "Irish coffee",
                    "Liqueur coffee"
                ]
            }
        },
        mounted: function () {
            this.$refs.myListBox.checkIndex(0);
            this.$refs.myListBox.checkIndex(1);
            this.$refs.myListBox.checkIndex(2);
            this.$refs.myListBox.checkIndex(5);
        },
        methods: {
            checkChange: function (event) {
                let eventsContainer = this.$refs.events;
                let checkedItemsContainer = this.$refs.checkedItems;
 
                if (event.args.checked) {
                    eventsContainer.innerHTML = 'Checked: ' + event.args.label;
                }
                else {
                    eventsContainer.innerHTML = 'Unchecked: ' + event.args.label;
                }
 
                let items = this.$refs.myListBox.getCheckedItems();
                let checkedItems = '';
                for (let i = 0; i < items.length; i++) {
                    if (i < items.length - 1) {
                        checkedItems += items[i].label + ', ';
                    }
                    else checkedItems += items[i].label;
                }
 
                checkedItemsContainer.innerHTML = checkedItems;
            }
        }
    }
</script>
 
<style>
</style>

Run Code