uppy/packages/@uppy/vue
Merlijn Vos 7d6937300a
meta: enable prettier for markdown (#5133)
* meta: enable prettier for markdown

* Ignore changelogs

* revert CHANGELOG changes

* More formatting

---------

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
2024-05-02 11:35:55 +02:00
..
src @uppy/vue: export FileInput (#4736) 2023-10-16 11:47:25 +02:00
types meta: run Prettier on existing files (#4713) 2023-09-29 11:11:28 +02:00
.gitignore meta: fix yarn build:clean 2024-01-22 15:55:22 +01:00
.npmignore add .npmignore files to ignore .gitignore when packing (#3380) 2021-12-21 14:39:54 +01:00
CHANGELOG.md Release: uppy@3.18.0 (#4754) 2023-10-20 15:20:18 +00:00
LICENSE Vue integration (#2500) 2020-11-25 22:59:06 +00:00
package.json Release: uppy@3.22.1 (#4935) 2024-02-20 09:36:32 +00:00
README.md meta: enable prettier for markdown (#5133) 2024-05-02 11:35:55 +02:00

@uppy/vue

Uppy logo: a smiling puppy above a pink upwards arrow

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

Vue component wrappers around Uppys 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 Transloadits 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.