mirror of https://github.com/transloadit/uppy.git synced 2026-07-22 17:58:05 +00:00

History

Kevin van Zonneveld 764c2ccada Update Linter (#2796 ) * relocate .vscode * Switch to transloadit linter * Update .eslintrc.json * autofix code * unlink and install eslint-config-transloadit@1.1.1 * Change 0 to "off" * Don't change 'use strict' * Do not vertically align * disable key-spacing * add import/no-extraneous-dependencies per package * add more react/a11y warnings * Revert "autofix code" This reverts commit `14c8a8cde8`. * add import/no-extraneous-dependencies per example and main package * autofix code (2) * Allow devDependencies in ./bin * Change import/no-extraneous-dependencies to warn again * upgrade linter * Set import/no-extraneous-dependencies to warn		2021-03-15 16:25:17 +00:00
..
src	Update Linter (#2796 )	2021-03-15 16:25:17 +00:00
types	Actually check types (#1918 )	2020-02-12 16:22:09 +01:00
LICENSE	Move `Form` to `@uppy/form`.	2018-06-14 16:31:19 +02:00
package.json	Release	2021-03-10 13:11:28 +01:00
README.md	Add all the CI badges (#2725 )	2021-01-13 00:30:59 +00: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

const Uppy = require('@uppy/core')
const Form = require('@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.