uppy/packages/@uppy/form
Artur Paikin 113d6f09bb Release
- uppy@0.27.5
 - @uppy/aws-s3-multipart@0.27.4
 - @uppy/aws-s3@0.27.4
 - @uppy/core@0.27.3
 - @uppy/dashboard@0.27.5
 - @uppy/drag-drop@0.27.4
 - @uppy/dropbox@0.27.4
 - @uppy/file-input@0.27.4
 - @uppy/form@0.27.4
 - @uppy/golden-retriever@0.27.4
 - @uppy/google-drive@0.27.5
 - @uppy/informer@0.27.4
 - @uppy/instagram@0.27.5
 - @uppy/progress-bar@0.27.4
 - @uppy/provider-views@0.27.4
 - @uppy/react@0.27.5
 - @uppy/redux-dev-tools@0.27.4
 - @uppy/status-bar@0.27.4
 - @uppy/thumbnail-generator@0.27.4
 - @uppy/transloadit@0.27.5
 - @uppy/tus@0.27.5
 - @uppy/url@0.27.5
 - @uppy/webcam@0.27.4
 - @uppy/xhr-upload@0.27.4
2018-09-27 16:31:35 -04:00
..
src Export Plugin class from @uppy/core. 2018-06-28 12:20:21 +02:00
types Add uppy.use() overloads to plugin typings. 2018-06-28 16:30:13 +02:00
LICENSE Move Form to @uppy/form. 2018-06-14 16:31:19 +02:00
package.json Release 2018-09-27 16:31:35 -04:00
README.md Move Form to @uppy/form. 2018-06-14 16:31:19 +02:00

@uppy/form

Uppy logo: a superman puppy in a pink suit

Build Status

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

const Uppy = require('@uppy/core')
const Form = require('@uppy/form')

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

Installation

$ npm install @uppy/form --save

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.