Vue UI Components Documentation

Vue FileUpload Component

The FileUpload component for Vue is a widget which can be used to select files and upload them to a server. The file upload widget supports automatic upload and multiple files upload.

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

import JqxFileUpload from "jqwidgets-scripts/jqwidgets-vue/vue_jqxfileupload.vue";

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

 components: {
    JqxFileUpload
 },

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

<template>
    <JqxFileUpload :width="300" :uploadUrl="uploadUrl" 
                   :fileInputName="fileInputName" :cancelTemplate="cancelTemplate" 
                   :browseTemplate="browseTemplate" :uploadTemplate="uploadTemplate">
    </JqxFileUpload>
</template>

Properties

The properties of the <JqxFileUpload/> 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 {
        uploadUrl: 'imageUpload.php',
        fileInputName: 'fileToUpload',
        cancelTemplate: 'danger',
        browseTemplate: 'success',
        uploadTemplate: 'primary'
    }
}

Events

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

<JqxFileUpload @select="onFileSelected()"
               :width="300" :uploadUrl="uploadUrl"
               :fileInputName="fileInputName" :cancelTemplate="cancelTemplate"
               :browseTemplate="browseTemplate" :uploadTemplate="uploadTemplate">
</JqxFileUpload>

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

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

<JqxFileUpload ref="fileupload"></JqxFileUpload>

Here how you can use a component's method:

this.$refs.fileupload.browse();

methods: {
    // Add here all used callbacks and/or events
    onFileSelected: function () {
        // Do something...
        this.$refs.fileupload.browse();
    }
}

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>
    <JqxFileUpload ref="fileupload" @select="onFileSelected()"
                   :width="300" :uploadUrl="uploadUrl"
                   :fileInputName="fileInputName" :cancelTemplate="cancelTemplate"
                   :browseTemplate="browseTemplate" :uploadTemplate="uploadTemplate">
    </JqxFileUpload>
</template>
 
<script>
    // Import the components that will be used
    import JqxFileUpload from "jqwidgets-scripts/jqwidgets-vue/vue_jqxfileupload.vue";
    
    export default {
        components: {
        // Adding imported widgets here
            JqxFileUpload
        },
        data: function () {
            // Define properties which will use in the widget
            return {
                uploadUrl: 'imageUpload.php',
                fileInputName: 'fileToUpload',
                cancelTemplate: 'danger',
                browseTemplate: 'success',
                uploadTemplate: 'primary'
            }
        },        
        beforeCreate: function () {            
            // Add here any data where you want to transform before components be rendered
        },
        methods: {
            // Add here all used callbacks and/or events
            onFileSelected: function () {
                // Do something...
                this.$refs.fileupload.browse();
            }
        }
    }
</script>
 
<style>
</style>

FileUpload Example

<template>
    <JqxFileUpload :width="300" :uploadUrl="'upload.php'" 
                   :fileInputName="'fileToUpload'" :renderFiles="renderFiles">
    </JqxFileUpload>
</template>
 
<script>
    import JqxFileUpload from "jqwidgets-scripts/jqwidgets-vue/vue_jqxfileupload.vue";
     
    export default {
        components: {
            JqxFileUpload
        },
        beforeCreate: function () {
            this.imageTypes = ['.gif', '.jpg', '.png'];
            this.videoTypes = ['.wmv', '.mov', '.avi', '.divx', '.mpeg', '.mpg', '.m4p'];
        },
        methods: {
            renderFiles: function (fileName) {
                let stopIndex = fileName.indexOf('.');
                let name = fileName.slice(0, stopIndex);
                let extension = fileName.slice(stopIndex);
                let iconUrl;
                if (this.imageTypes.indexOf(extension) !== -1) {
                    iconUrl = 'images/nav3.png';
                } else if (this.videoTypes.indexOf(extension) !== -1) {
                    iconUrl = 'images/movie.png';
                } else {
                    iconUrl = 'images/nav1.png';
                }
                return '<div><img src="' + iconUrl + '" style="dislplay: inline; width: 16px; height: 16px; margin-right: 5px;" /><span>' + name + '<strong>' + extension + '</strong></span></div>';
            }
        }
    }
</script>
 
<style>
</style>

Run Code