Vue UI Components Documentation

Vue Popover Component

The Popover component for Vue represents a small overlay of content that is used to display secondary information of any element when it is clicked by a user.

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

import JqxPopover from 'jqwidgets-scripts/jqwidgets-vue/vue_jqxpopover.vue';

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

 components: {
    JqxPopover
 },

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

<template>
    <JqxPopover :title="title" :selector="selector"
                :offset="offset">
        <div ref="employees"></div>
    </JqxPopover>
    <JqxButton style="float: right; margin-top: 10px; padding: 8px 0px; border-radius: 6px;"
               class="my-button" :width="140" :height="35">View Employees
    </JqxButton>
</template>

Properties

The properties of the <JqxPopover/> 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 {
        selector: '.my-button',
        title: 'Employees',
        offset: { left: 0, top: -125 }
    }
}

Events

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

<JqxPopover @open="onOpen()" :title="title" 
            :selector="selector" :offset="offset">
    <div ref="employees"></div>
</JqxPopover>

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

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

<JqxPopover ref="popover"></JqxPopover>

Here how you can use a component's method:

this.$refs.popover.close();

methods: {
    // Add here all used callbacks and/or events
    onOpen: function () {
        // Do something...
        setTimeout(() => {
            this.refs.popover.close()
        });
    }
}

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

In case we need to do something after the components are rendered, we should use the mounted member. In this case:

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

App.vue:

Popover Example

Run Code