mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-26 03:35:19 +00:00
| Package | Version | Package | Version | | ---------------------- | ------------- | ---------------------- | ------------- | | @uppy/companion | 5.0.0-beta.12 | @uppy/form | 4.0.0-beta.6 | | @uppy/companion-client | 4.0.0-beta.9 | @uppy/provider-views | 4.0.0-beta.11 | | @uppy/core | 4.0.0-beta.12 | uppy | 4.0.0-beta.14 | | @uppy/drag-drop | 4.0.0-beta.5 | | | - @uppy/companion: make `oauthOrigin` option required (Mikael Finstad / #5276) - @uppy/provider-views: `afterFill()` - add loading progress (Evgenia Karunus / #5288) |
||
|---|---|---|
| .. | ||
| src | ||
| .npmignore | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
@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. 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
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.