github-actions[bot] e07c83bebe Release: uppy@4.8.0 (#5541) 4 months ago
..
src 9e69b7fc26 meta: enforce `.ts` extension for relative import types (#5393) 8 months ago
.gitignore a47090c2c6 meta: fix `yarn build:clean` 1 year ago
.npmignore 1f8ecd72cb @uppy/vue: migrate to Composition API with TS & drop Vue 2 support (#5043) 1 year ago
CHANGELOG.md e07c83bebe Release: uppy@4.8.0 (#5541) 4 months ago
LICENSE b082e54029 Vue integration (#2500) 4 years ago
README.md 71a6fcd956 Fix links (#5492) 5 months ago
package.json e07c83bebe Release: uppy@4.8.0 (#5541) 4 months ago
tsconfig.build.json 8f97fd61fa cleanup tsconfig (#5520) 5 months ago
tsconfig.json 1f8ecd72cb @uppy/vue: migrate to Composition API with TS & drop Vue 2 support (#5043) 1 year ago

README.md

@uppy/vue

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

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit’s CDN: Smart CDN. 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.