mirror of https://github.com/transloadit/uppy.git synced 2026-07-19 09:34:02 +00:00

History

Antoine du Hamel d69031524c @uppy/core: move `Uppy` class to its own module (#3225 ) * @uppy/core: move `Uppy` class to its own module Fixes: https://github.com/transloadit/uppy/issues/3220 * Rename snapshot file * Update docs * Update website/src/_posts/2021-08-2.0.md Co-authored-by: Merlijn Vos <merlijn@soverin.net> * Update migration guide * Do not bundle preact with non-UI plugin packages Co-authored-by: Merlijn Vos <merlijn@soverin.net>		2021-09-28 19:04:33 +02:00
..
src	@uppy/core: move `Uppy` class to its own module (#3225 )	2021-09-28 19:04:33 +02:00
types	UIPlugin fix: prevent Preact replacing contents of body element by using createDocumentFragment (#3072 )	2021-08-06 10:02:11 +01:00
LICENSE	Move `Form` to `@uppy/form`.	2018-06-14 16:31:19 +02:00
package.json	Release	2021-09-20 11:51:06 +02:00
README.md	doc: lint JS code snippets (#2954 )	2021-07-04 19:32:50 +02:00

README.md

@uppy/form

The Form plugin collects metadata from any specified <form> element, right before Uppy begins uploading/processing files. It optionally appends results back to the form. Currently the appended result is a stringified version of a result returned from uppy.upload().

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

Example

import Uppy from '@uppy/core'
import Form from '@uppy/form'

const uppy = new Uppy()
uppy.use(Form, {
  target: document.querySelector('form'),
  getMetaFromForm: true,
  addResultToForm: true,
  resultName: 'uppyResult',
  submitOnSuccess: true,
})

Installation

$ npm install @uppy/form

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.