mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-28 12:37:00 +00:00
7d6937300a
* meta: enable prettier for markdown * Ignore changelogs * revert CHANGELOG changes * More formatting --------- Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
# @uppy/form
|
||
|
||
<img src="https://uppy.io/img/logo.svg" width="120" alt="Uppy logo: a smiling puppy above a pink upwards arrow" align="right">
|
||
|
||
[](https://www.npmjs.com/package/@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](https://transloadit.com),
|
||
a versatile file encoding service.
|
||
|
||
## Example
|
||
|
||
```js
|
||
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
|
||
|
||
```bash
|
||
$ 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](https://uppy.io/docs/#Installation) for instructions.
|
||
|
||
## Documentation
|
||
|
||
Documentation for this plugin can be found on the
|
||
[Uppy website](https://uppy.io/docs/form).
|
||
|
||
## License
|
||
|
||
[The MIT License](./LICENSE).
|