In this article, we will talk about how to handle file uploads with VueJs. We will create an images uploader that allow user to upload single or multiple images file by drag and drop or select file dialog.

We will then upload the selected images and display them accordingly. We will also learn to filter the upload file type, for example, we only allow images, do not allow file type like PDF.

File upload consists of two parts: the UI (front-end) and the API (back-end). We will be using VueJs to handle the UI part. We need a backend application to accept the uploaded files. You may follow the backend tutorials or download and run either one of these server side application to handle file upload for your backend:-

File upload with Hapi.js: https://scotch.io/bar-talk/handling-file-uploads-with-hapi-js, or

File upload with Express + Multer: https://scotch.io/tutorials/express-file-uploads-with-multer, or

Switch to any cloud solution of your choice (Amazon S3, Google Drive, etc).

We will be using File upload with Hapi.js as our backend throughout this articles. We will also learn the tricks to enable fake upload on the front-end.

We will be using vue-cli to scaffold Vue.js projects. We will be using the webpack-simple project template.

npm install vue-cli -g vue init webpack-simple file-upload-vue

Alright, all set. Let's proceed to create our component.

We will write our code in App.vue . Remove all the auto-generated code in the file.

< template > < div id = " app " > < div class = " container " > < form enctype = " multipart/form-data " novalidate v-if = " isInitial || isSaving " > < h1 > Upload images </ h1 > < div class = " dropbox " > < input type = " file " multiple :name = " uploadFieldName " :disabled = " isSaving " @change = " filesChange($event.target.name, $event.target.files); fileCount = $event.target.files.length " accept = " image/* " class = " input-file " > < p v-if = " isInitial " > Drag your file(s) here to begin < br > or click to browse </ p > < p v-if = " isSaving " > Uploading {{ fileCount }} files... </ p > </ div > </ form > </ div > </ template > < script > </ script > < style lang = " scss " > </ style >

Notes:-

Upgrade Your JS Go from vanilla JavaScript 👉 React

Watch for FREE

Our App.vue component consists of 3 part: template (HTML), script (Javascript) and styles (SASS). Our template has an upload form. The form attribute enctype="multipart/form-data" is important. To enable file upload, this attribute must be set. Learn more about enctype here. We have a file input <input type="file" /> to accept file upload. The property multiple indicate it's allow multiple file upload. Remove it for single file upload. We will handle the file input change event. Whenever the file input change (someone drop or select files), we will trigger the filesChange function and pass in the control name and selected files $event.target.files , and then upload to server. We limit the file input to accept images only with the attribute accept="image/*" . The file input will be disabled during upload, so user can only drop / select files again after upload complete. We capture the fileCount of the when file changes. We use the fileCount variable in displaying number of files uploading Uploading {{ fileCount }} files... .

Now, that's the interesting part. Currently, our component look like this:

We need to transform it to look like this:

Let's style it!

<!-- App . vue --> ... <!-- SASS styling --> <style lang= "scss" > . dropbox { outline : 2px dashed grey; / * the dash box * / outline-offset : -10px; background : lightcyan; color : dimgray; padding : 10px 10px; min-height : 200px; / * minimum height * / position : relative; cursor : pointer; } . input-file { opacity : 0; / * invisible but it's there! * / width : 100 % ; height : 200px; position : absolute; cursor : pointer; } .dropbox : hover { background : lightblue; / * when mouse over to the drop zone, change color * / } . dropbox p { font-size : 1.2em; text-align : center; padding : 50px 0; } </style>

With only few lines of scss, our component looks prettier now.

Notes:-

We make the file input invisible by applying opacity: 0 style. This doesn't hide the file input, it just make it invisible. Then, we style the file input parent element, the dropbox css class. We make it look like a drop file zone surround with dash. Then, we align the text inside dropbox to center.

Let's proceed to code our component.

< ! -- App . vue -- > ... < ! -- Javascript -- > < script > import { upload } from './file-upload.service' ; const STATUS_INITIAL = 0 , STATUS_SAVING = 1 , STATUS_SUCCESS = 2 , STATUS_FAILED = 3 ; export default { name : 'app' , data ( ) { return { uploadedFiles : [ ] , uploadError : null , currentStatus : null , uploadFieldName : 'photos' } } , computed : { isInitial ( ) { return this . currentStatus === STATUS_INITIAL ; } , isSaving ( ) { return this . currentStatus === STATUS_SAVING ; } , isSuccess ( ) { return this . currentStatus === STATUS_SUCCESS ; } , isFailed ( ) { return this . currentStatus === STATUS_FAILED ; } } , methods : { reset ( ) { this . currentStatus = STATUS_INITIAL ; this . uploadedFiles = [ ] ; this . uploadError = null ; } , save ( formData ) { this . currentStatus = STATUS_SAVING ; upload ( formData ) . then ( x => { this . uploadedFiles = [ ] . concat ( x ) ; this . currentStatus = STATUS_SUCCESS ; } ) . catch ( err => { this . uploadError = err . response ; this . currentStatus = STATUS_FAILED ; } ) ; } , filesChange ( fieldName , fileList ) { const formData = new FormData ( ) ; if ( ! fileList . length ) return ; Array . from ( Array ( fileList . length ) . keys ( ) ) . map ( x => { formData . append ( fieldName , fileList [ x ] , fileList [ x ] . name ) ; } ) ; this . save ( formData ) ; } } , mounted ( ) { this . reset ( ) ; } , } < / script >

Notes:-

Our component will have a few statuses: STATUS_INITIAL, STATUS_SAVING, STATUS_SUCCESS, STATUS_FAILED, the variable name is pretty expressive themselves. Later on, we will call the Hapi.js file upload API to upload images, the API accept a field call photos . That's our file input field name. We handle the file changes with the filesChange function. FileList is an object returned by the files property of the HTML element. It allow us to access the list of files selected with the element. Learn more [here]((https://developer.mozilla.org/en/docs/Web/API/FileList). We then create a new FormData , and append all our photos files to it. FormData interface provides a way to easily construct a set of key/value pairs representing form fields and their values. Learn more here. The save function will call our file upload service (hang on, we will create the service next!). We also set the status according to the result. mount() is the vue component life cycle hook. During that point, we will set our component status to initial state.

Let's proceed to create our service. We will be using axios to make HTTP calls.

Install axios

npm install axios --save

Service

import * as axios from 'axios' ; const BASE_URL = 'http://localhost:3001' ; function upload ( formData ) { const url = ` ${ BASE_URL } /photos/upload` ; return axios . post ( url , formData ) . then ( x => x . data ) . then ( x => x . map ( img => Object . assign ( { } , img , { url : ` ${ BASE_URL } /images/ ${ img . id } ` } ) ) ) ; } export { upload }

Nothing much, the code is pretty expressive itself. We upload the files, wait for the result, map it accordingly.

You may run the application now with npm run dev command. Try uploading a couple of images, and it's working! (Remember to start your backend server)

We can upload the files successfully now. However, there's no indication in UI. Let's update our HTML template.

< template > < div id = " app " > < div class = " container " > ...form... < div v-if = " isSuccess " > < h2 > Uploaded {{ uploadedFiles.length }} file(s) successfully. </ h2 > < p > < a href = " javascript:void(0) " @click = " reset() " > Upload again </ a > </ p > < ul class = " list-unstyled " > < li v-for = " item in uploadedFiles " > < img :src = " item.url " class = " img-responsive img-thumbnail " :alt = " item.originalName " > </ li > </ ul > </ div > < div v-if = " isFailed " > < h2 > Uploaded failed. </ h2 > < p > < a href = " javascript:void(0) " @click = " reset() " > Try again </ a > </ p > < pre > {{ uploadError }} </ pre > </ div > </ div > </ div > </ template >

Notes:-

Display the uploaded image when upload successfully. Display the error message when upload failed.

If you are lazy to start the back-end application (Hapi, Express, etc) to handle file upload. Here is a fake service to replace the file upload service.

function upload ( formData ) { const photos = formData . getAll ( 'photos' ) ; const promises = photos . map ( ( x ) => getImage ( x ) . then ( img => ( { id : img , originalName : x . name , fileName : x . name , url : img } ) ) ) ; return Promise . all ( promises ) ; } function getImage ( file ) { return new Promise ( ( resolve , reject ) => { const fReader = new FileReader ( ) ; const img = document . createElement ( 'img' ) ; fReader . onload = ( ) => { img . src = fReader . result ; resolve ( getBase64Image ( img ) ) ; } fReader . readAsDataURL ( file ) ; } ) } function getBase64Image ( img ) { const canvas = document . createElement ( 'canvas' ) ; canvas . width = img . width ; canvas . height = img . height ; const ctx = canvas . getContext ( '2d' ) ; ctx . drawImage ( img , 0 , 0 ) ; const dataURL = canvas . toDataURL ( 'image/png' ) ; return dataURL ; } export { upload }

Came across this solution in this Stackoverflow post. Pretty useful. My online demo is using this service.

Basically, what the code do is read the source, draw it in canvas, and save it as data url with the canvas toDataURL function. Learn more about canvas here.

Now you can swap the real service with the fake one.

< ! -- App . vue -- > ... < ! -- Javascript -- > < script > import { upload } from './file-upload.fake.service' ; < / script > ...

Done! Stop your backend API, refresh your browser, you should see our app is still working, calling fake service instead.

Sometimes, you may want to delay the promises to see the state changes. In our case, the file upload may complete too fast. Let's write a helper function for that.

function wait ( ms ) { return ( x ) => { return new Promise ( resolve => setTimeout ( ( ) => resolve ( x ) , ms ) ) ; } ; } export { wait }

Then, you can use it in your component

< ! -- App . vue -- > ... < ! -- Javascript -- > < script > import { wait } from './utils' ; ... save ( formData ) { ... . upload ( formData ) . then ( wait ( 1500 ) ) . then ( x => { this . uploadedFiles = [ ] . concat ( x ) ; this . currentStatus = STATUS_SUCCESS ; } ) ... } , < / script >

That's it. This is how you can handle file upload without using any 3rd party libraries and plugins in Vue. It isn't that hard right?

Happy coding!

The UI (Front-end)

The API (Back-end) Tutorials and Sourcode

File upload with Hapi.js: https://scotch.io/bar-talk/handling-file-uploads-with-hapi-js, or

File upload with Express + Multer: https://scotch.io/tutorials/express-file-uploads-with-multer, or

Switch to any cloud solution of your choice (Amazon S3, Google Drive, etc).

Like this article? Follow @JecelynYeen on Twitter