Vue UI Components Documentation

Vue Button Component

The Button component for Vue - configured to show textual content only, or to display a predefined icon, an image, or a custom icon, or yet a combination of textual and image content.

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

import JqxButton from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxbuttons.vue';

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

 components: {
    JqxButton
 },

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

<template>
    <JqxButton ref="button"
               :width="width"
               :height="height"
               :value="value"
               @click="click()">
        Button
    </JqxButton>
</template>

Properties

The properties of the <JqxButton/> 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: 120,
        height: 30,
        value: "Button"
    }
}

Events

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

<JqxButton ref="button" @click="click()">
    Button
</JqxButton>

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

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

<JqxButton ref="button"></JqxButton>

Here how you can use a component's method:

this.$refs.button.val('Clicked');

methods: {
    // Add here all used callbacks and/or events
    click: function () {
        // Do something when clicking on the button
        this.$refs.button.val('Clicked');
    }
}

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:

Button Examples

Run Code