Vue UI Components Documentation

Vue DockPanel Component

The DockPanel component for Vue represents a container for other widgets or elements. It arranges its inner elements depending on the value of the 'dock' attribute. The possible 'dock' attribute values are: 'left, right, top and bottom'.

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

import JqxDockPanel from "jqwidgets-scripts/jqwidgets-vue/vue_jqxdockpanel.vue";

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

 components: {
    JqxDockPanel
 },

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

<template>
    <JqxDockPanel :width="width"
                  :height="height">
        <div ref="first" dock="left" style="background: #486974;">
            First Div
        </div>
        <div ref="second" dock="top" style="height: 100px; background: #368ba7;">
            Second Div
        </div>
        <div ref="third" dock="right" style="background: #df7169;">
            Third Div
        </div>
        <div ref="fourth" style="background: #a73654;">
            Fourth Div
        </div>
    </JqxDockPanel>
</template>

Properties

The properties of the <JqxDockPanel/> 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: 300,
        height: 210
    }
}

Events

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

<JqxDockPanel @layout="onLayout()"
              :width="width"
              :height="height">
    <div ref="first" dock="left" style="background: #486974;">
        First Div
    </div>
    <div ref="second" dock="top" style="height: 100px; background: #368ba7;">
        Second Div
    </div>
    <div ref="third" dock="right" style="background: #df7169;">
        Third Div
    </div>
    <div ref="fourth" style="background: #a73654;">
        Fourth Div
    </div>
</JqxDockPanel>

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

methods: {
    onLayout: function () {
        // Do something...
    }
}

Methods

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:

DockPanel Example