Vue UI Components Documentation

Vue Layout Component

The Layout component for Vue allows the creation of complex layouts with panels that can be nested, resized, pinned, unpinned and closed.

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

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

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

<template>
    <JqxLayout :width="width" :layout="layout">
        <div data-container="Document1Panel">Document 1 content</div>
        <div data-container="Document2Panel">Document 2 content</div>
        <div data-container="ErrorListPanel">List of errors</div>
        <div data-container="OutputPanel">Output</div>
        <div data-container="SolutionExplorerPanel">Solution structure</div>
        <div data-container="PropertiesPanel">List of properties</div>
    </JqxLayout>
</template>

Properties

The properties of the <JqxLayout/> component are defined in the data member of the Vue class. We should put them in the return object of the data function:

Events

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

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:

<JqxLayout ref="layout"></JqxLayout>

Here how you can use a component's method:

this.$refs.layout.refresh();

methods: {
    // Add here all used callbacks and/or events
    onResize: function () {
        // Do something...
        this.$refs.layout.refresh();
    }
}

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>
    <JqxLayout ref="layout" @resize="onResize()"
               :width="width" :layout="layout">
        <div data-container="Document1Panel">Document 1 content</div>
        <div data-container="Document2Panel">Document 2 content</div>
        <div data-container="ErrorListPanel">List of errors</div>
        <div data-container="OutputPanel">Output</div>
        <div data-container="SolutionExplorerPanel">Solution structure</div>
        <div data-container="PropertiesPanel">List of properties</div>
    </JqxLayout>
</template>
 
<script>
    // Import the components that will be used
    import JqxLayout from "jqwidgets-scripts/jqwidgets-vue/vue_jqxlayout.vue";
    
    export default {
        components: {
        // Adding imported widgets here
            JqxLayout
        },
        data: function () {
            // Define properties which will use in the widget
            return {
                width: '100%',
                layout: [{
                    type: 'layoutGroup',
                    orientation: 'horizontal',
                    items: [{
                        type: 'layoutGroup',
                        orientation: 'vertical',
                        width: '60%',
                        items: [{
                            type: 'documentGroup',
                            height: '50%',
                            minHeight: '25%',
                            items: [{
                                type: 'documentPanel',
                                title: 'Document 1',
                                contentContainer: 'Document1Panel'
                            }, {
                                type: 'documentPanel',
                                title: 'Document 2',
                                contentContainer: 'Document2Panel'
                            }]
                        }, {
                            type: 'tabbedGroup',
                            height: '50%',
                            pinnedHeight: '10%',
                            items: [{
                                type: 'layoutPanel',
                                title: 'Error List',
                                contentContainer: 'ErrorListPanel'
                            }, {
                                type: 'layoutPanel',
                                title: 'Output',
                                contentContainer: 'OutputPanel',
                                selected: true
                            }]
                        }]
                    }, {
                        type: 'tabbedGroup',
                        width: '40%',
                        items: [{
                            type: 'layoutPanel',
                            title: 'Solution Explorer',
                            contentContainer: 'SolutionExplorerPanel'
                        }, {
                            type: 'layoutPanel',
                            title: 'Properties',
                            contentContainer: 'PropertiesPanel'
                        }]
                    }]
                }]
            }
        },        
        beforeCreate: function () {            
            // Add here any data where you want to transform before components be rendered
        },
        methods: {
            // Add here all used callbacks and/or events
            onResize: function () {
                // Do something...
                this.$refs.layout.refresh();
            }
        }
    }
</script>
 
<style>
</style>

Layout Example

<template>
    <div>
        <JqxLayout ref="myLayout" :width="width" :height="600" :layout="layout">
            <!--The panel content divs can have a flat structure-->
            <!--autoHideGroup-->
            <div data-container="ToolboxPanel">
                List of tools
            </div>
            <div data-container="HelpPanel">
                Help topics
            </div>
            <!--documentGroup-->
            <div data-container="Document1Panel">
                Document 1 content
            </div>
            <div data-container="Document2Panel">
                Document 2 content
            </div>
            <!--bottom tabbedGroup-->
            <div data-container="ErrorListPanel">
                List of errors
            </div>
            <div data-container="OutputPanel">
                Output
            </div>
            <!--right tabbedGroup-->
            <div data-container="SolutionExplorerPanel">
                <div id="treeContainer" style="border: none;"></div>
            </div>
            <div data-container="PropertiesPanel">
                List of properties
            </div>
        </JqxLayout>
         
        <div style="margin-top: 25px">
 
            <JqxButton @click="saveLayoutBtnOnClick()">Save Layout</JqxButton>
 
            <JqxButton ref="myLoadLayoutBtn" @click="loadLayoutBtnOnClick()" :disabled="true">Load Layout</JqxButton>
             
        </div>
    </div>
</template>
<script>
    import JqxLayout from "jqwidgets-scripts/jqwidgets-vue/vue_jqxlayout.vue";
    import JqxButton from "jqwidgets-scripts/jqwidgets-vue/vue_jqxbuttons.vue";
    import JqxTree from "jqwidgets-scripts/jqwidgets-vue/vue_jqxtree.vue";
 
    export default {
        components: {
            JqxLayout,
            JqxButton
        },
        data: function () {
            return {
                width: 800,
                layout: [{
                    type: 'layoutGroup',
                    orientation: 'horizontal',
                    items: [{
                        type: 'autoHideGroup',
                        alignment: 'left',
                        width: 80,
                        unpinnedWidth: 200,
                        items: [{
                            type: 'layoutPanel',
                            title: 'Toolbox',
                            contentContainer: 'ToolboxPanel'
                        }, {
                            type: 'layoutPanel',
                            title: 'Help',
                            contentContainer: 'HelpPanel'
                        }]
                    }, {
                        type: 'layoutGroup',
                        orientation: 'vertical',
                        width: 500,
                        items: [{
                            type: 'documentGroup',
                            height: 400,
                            minHeight: 200,
                            items: [{
                                type: 'documentPanel',
                                title: 'Document 1',
                                contentContainer: 'Document1Panel'
                            }, {
                                type: 'documentPanel',
                                title: 'Document 2',
                                contentContainer: 'Document2Panel'
                            }]
                        }, {
                            type: 'tabbedGroup',
                            height: 200,
                            pinnedHeight: 30,
                            items: [{
                                type: 'layoutPanel',
                                title: 'Error List',
                                contentContainer: 'ErrorListPanel'
                            }, {
                                type: 'layoutPanel',
                                title: 'Output',
                                contentContainer: 'OutputPanel',
                                selected: true
                            }]
                        }]
                    }, {
                        type: 'tabbedGroup',
                        width: 220,
                        minWidth: 200,
                        items: [{
                            type: 'layoutPanel',
                            title: 'Solution Explorer',
                            contentContainer: 'SolutionExplorerPanel',
                            initContent: () => {
                                jqwidgets.createInstance('#treeContainer', 'jqxTree', { source: this.source, height: '99%', width: '100%' })
                            }
                        },
                        {
                            type: 'layoutPanel',
                            title: 'Properties',
                            contentContainer: 'PropertiesPanel'
                        }]
                    }]
                }]
            }
        },
        beforeCreate: function () {
            this.source = [{
                icon: 'images/earth.png',
                label: 'Project',
                expanded: true,
                items: [{
                    icon: 'images/folder.png',
                    label: 'css',
                    expanded: true,
                    items: [{
                        icon: 'images/nav1.png',
                        label: 'jqx.base.css'
                    }, {
                        icon: 'images/nav1.png',
                        label: 'jqx.energyblue.css'
                    }, {
                        icon: 'images/nav1.png',
                        label: 'jqx.orange.css'
                    }]
                }, {
                    icon: 'images/folder.png',
                    label: 'scripts',
                    items: [{
                        icon: 'images/nav1.png',
                        label: 'jqxcore.js'
                    }, {
                        icon: 'images/nav1.png',
                        label: 'jqxdata.js'
                    }, {
                        icon: 'images/nav1.png',
                        label: 'jqxgrid.js'
                    }]
                }, {
                    icon: 'images/nav1.png',
                    label: 'index.htm'
                }]
            }];
 
            this.savedLayout;
        },
        methods: {
            saveLayoutBtnOnClick: function () {
                this.savedLayout = this.$refs.myLayout.saveLayout();
                this.$refs.myLoadLayoutBtn.disabled = false;
            },
            loadLayoutBtnOnClick: function () {
                this.$refs.myLayout.loadLayout(this.savedLayout);
                this.$refs.myLoadLayoutBtn.disabled = true;
            }
        }
    }
</script>
 
<style>
    .jqx-layout-group-auto-hide-content-vertical {
        width: 200px;
    }
 
    .jqx-button {
        width: fit-content;
        display: inline;
        margin-right: 5px;
    }
</style>

Run Code