Skip to content

Latest commit

 

History

History
119 lines (95 loc) · 4.24 KB

README.md

File metadata and controls

119 lines (95 loc) · 4.24 KB

vue-dropzone

A Vue component for file uploads, powered by Dropzone.js. Check out the demo.

Install

// For Vue.js 2.0+
npm install vue2-dropzone@^2.0.0

You'll also need to load either the Material Icon or FontAwesome icon kits depending on which style of icon you'd like.

    <link href="https://fonts.googleapis.com/icon?family=Material+Icons"
      rel="stylesheet">
    <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet">

Usage

  1. Import the module
  2. Register it as a component as you would any other Vue component
  3. Use it within your template

Example

<template>
  <div id="app">
    <p>Welcome to your Vue.js app!</p>

    <dropzone id="myVueDropzone" url="https://httpbin.org/post" v-on:vdropzone-success="showSuccess"></dropzone>

  </div>
</template>

<script>
  import Dropzone from 'vue2-dropzone'

  export default {
    name: 'MainApp',
    components: {
      Dropzone
    },
    methods: {
      'showSuccess': function (file) {
        console.log('A file was successfully uploaded')
      }
    }
  }
</script>

Props

Many of these props are inherited from dropzone configuration so see their doco for further details.

Prop Name Type Description
id String A string by which to identify the component, can be anything. Required
url String Url to post the upload to. Required
clickable Boolean Whether the dropzone area is clickable, if false then users can only drag items on to the area.
acceptedFileTypes String A comma separated string of accepted file types eg 'image/*,application/pdf,.psd' .
thumbnailHeight Number The height of thumbnails in pixels.
thumbnailWidth Number The width of thumbnails in pixels.
showRemoveLink Boolean Whether the Remove link is shown on items.
maxFileSizeInMB Number The maximum file size for a single upload in MB.
maxNumberOfFiles Number The maximum number of files to allow the user to upload.
autoProcessQueue Boolean Whether the files are automatically uploaded or not.
useFontAwesome Boolean Whether to use Font Awesome instead of Material Icon.
headers Object If you want to add additional headers.
useCustomDropzoneOptions Boolean If you want to define your own Dropzone config set this to true and define a dropzoneOptions.
dropzoneOptions Object A custom set of rules to define your dropzone object, use anything available in the dropzone config.

Methods

Methods you can call on the component.

Method Description
removeAllFiles() Empties the dropzone area.
processQueue() Uploads the files, required if autoProcessQueue is set to false.
removeFile(file) Removes a file from the dropzone area.

##Using Methods Methods can be called from your parent component by making use of the special tag "ref".

When you initialize the compnonent add a unique ID to the dropzone element using the ref tag, like this

<dropzone ref="myUniqueID"></dropzone>

Then from your parent Vue instance, you can call the methods by using the following:

vm.$refs.myUniqueID.processQueue()
//vm refers to your current instance

Events

Events emitted by the component to the parent.

Event Name Description
vdropzone-file-added(file) File added to the dropzone.
vdropzone-success(file, response) File successfully uploaded.
vdropzone-error(file) File uploaded encountered an error.
vdropzone-removed-file(file, error, xhr) A file was removed from the dropzone.
vdropzone-sending(file, xhr, formData) Modify the request and add addtional parameters to request before sending.
vdropzone-queue-complete() Called when all files in the queue finish uploading.

Development

# install dependencies
npm install

# serve example at localhost:8080
npm run dev

# build any changes made
npm run build