uppy/packages/@uppy/form
github-actions[bot] 937107a4a4
Release: uppy@3.27.2 (#5301)
| Package                | Version | Package                | Version |
| ---------------------- | ------- | ---------------------- | ------- |
| @uppy/companion        |  4.15.0 | @uppy/drag-drop        |   3.1.1 |
| @uppy/companion-client |   3.8.2 | @uppy/form             |   3.2.2 |
| @uppy/core             |  3.13.1 | uppy                   |  3.27.2 |

- @uppy/form: do not emit `'submit'` event more than once (Merlijn Vos / #5299)
- @uppy/companion: add `s3.forcePathStyle` option (Nadeem Reinhardt / #5066)
- meta: fix broken workflow status badges in README (Alexander Zaytsev / #5298)
- @uppy/core: add `clearUploadedFiles` to type definition (Augustine Smith / #5295)
- @uppy/companion: add `oauthOrigin` option (Antoine du Hamel / #5297)
- meta: add dark-mode Transloadit logo in README (Alexander Zaytsev / #5291)
- docs,@uppy/drag-drop: `uppy.io/docs` - fix typos/broken links (Evgenia Karunus / #5296)
- meta: Bump docker/build-push-action from 6.1.0 to 6.2.0 (dependabot[bot] / #5290)
2024-07-02 21:51:55 +00:00
..
src @uppy/form: do not emit 'submit' event more than once (#5299) 2024-07-02 17:52:17 +02:00
types meta: run Prettier on existing files (#4713) 2023-09-29 11:11:28 +02:00
.npmignore @uppy/form: migrate to TS (#4937) 2024-02-28 10:36:19 +01:00
CHANGELOG.md Release: uppy@3.27.2 (#5301) 2024-07-02 21:51:55 +00:00
LICENSE Move Form to @uppy/form. 2018-06-14 16:31:19 +02:00
package.json Release: uppy@3.27.2 (#5301) 2024-07-02 21:51:55 +00:00
README.md meta: enable prettier for markdown (#5133) 2024-05-02 11:35:55 +02:00
tsconfig.build.json @uppy/form: migrate to TS (#4937) 2024-02-28 10:36:19 +01:00
tsconfig.json @uppy/form: migrate to TS (#4937) 2024-02-28 10:36:19 +01:00

@uppy/form

Uppy logo: a smiling puppy above a pink upwards arrow

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

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 Transloadits 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.