Vue UI Components Documentation

Vue Docking Component

The Docking component for Vue represents a widget which allows you to manage multiple windows and even the layout of your web page. Each window in the Docking can be dragged around the Web page, docked into docking zones, removed from the docking, collapsed into a minimized state to hide its content, expanded to display its content or pinned in place.

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

import JqxDocking from "jqwidgets-scripts/jqwidgets-vue/vue_jqxdocking.vue";

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

 components: {
    JqxDocking
 },

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

<template>
    <JqxDocking :orientation="orientation" :width="width" :mode="mode">
        <div>
            <div id="window1" style="height: 220px;">
                <div>
                    Date and Time
                </div>w
                <div style="overflow: hidden;">
                    Content of the "Date and Time" section
                </div>
            </div>
            <div id="window2" style="height: 220px">
                <div>
                    News
                </div>
                <div style="overflow: hidden;">
                    Content of the "News" section
                </div>
            </div>
        </div>
    </JqxDocking>
</template>

Properties

The properties of the <JqxDocking/> 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: 250,
        orientation: 'horizontal',
        mode: 'docked'
    }
}

Events

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

<JqxDocking @dragStart="onDragStart()" :orientation="orientation"
            :width="width" :mode="mode">
    <div>
        <div id="window1" style="height: 220px;">
            <div>
                Date and Time
            </div>
            <div style="overflow: hidden;">
                Content of the "Date and Time" section
            </div>
        </div>
        <div id="window2" style="height: 220px">
            <div>
                News
            </div>
            <div style="overflow: hidden;">
                Content of the "News" section
            </div>
        </div>
    </div>
</JqxDocking>

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

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:

<JqxDocking ref="docking"></JqxDocking>

Here how you can use a component's method:

this.$refs.docking.disable();

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:

Docking Example

Run Code