@uppy/vue

Vue component wrappers around Uppy’s officially maintained UI plugins.

Usage no npm install needed!

<script type="module">
  import uppyVue from 'https://cdn.skypack.dev/@uppy/vue';
</script>

README

@uppy/vue

Uppy logo: a superman puppy in a pink suit

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

Vue component wrappers around Uppy’s officially maintained UI plugins.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

<template>
  <dashboard-modal 
  :uppy="uppy" 
  :open="open" 
  :props="{
    onRequestCloseModal: handleClose
  }"/>
</template>

<script>
import Uppy from '@uppy/core'
import { DashboardModal } from '@uppy/vue'

export default {
  components: {
    DashboardModal
  },
  computed: {
    uppy: () => new Uppy()
  },
  data () {
    return {
      open: false
    }
  },
  methods: {
    handleClose() { this.open = false }
  }
}
</script>

Installation

$ npm install @uppy/vue

We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit’s CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.