uppy/packages/@uppy/form
prakash 9fa8886a2a
chore(deps): upgrade TypeScript to 6
Moves all 43 workspaces to typescript ^6.0.3 (@uppy/companion was already
pinned to 6.0.3). The two Angular workspaces stay on their own lines,
~5.7.3 and ~5.9.3, because the Angular compiler pins its supported range.

TypeScript 6 reports TS2882 for side-effect imports of files it has no
declarations for, which the browser tests in @uppy/dashboard,
@uppy/golden-retriever and @uppy/xhr-upload hit when importing plugin CSS.
Each gets a one-line ambient declaration.

Nothing else changed: no source, no config, no lockfile churn beyond the
compiler itself.

Verified: yarn build (54/54), yarn typecheck (75/75), yarn check:ci,
yarn test (19/19).
2026-07-26 02:45:03 +05:30
..
src refactor(core): merge @uppy/utils into core via ./utils export 2026-06-22 01:40:25 +05:30
.npmignore @uppy/form: migrate to TS (#4937) 2024-02-28 10:36:19 +01:00
CHANGELOG.md [ci] release (#6060) 2025-12-02 10:09:28 +01:00
LICENSE Move Form to @uppy/form. 2018-06-14 16:31:19 +02:00
package.json chore(deps): upgrade TypeScript to 6 2026-07-26 02:45:03 +05:30
README.md Fix links (#5492) 2024-10-29 13:54:00 +01:00
tsconfig.build.json refactor(core): merge @uppy/utils into core via ./utils export 2026-06-22 01:40:25 +05:30
tsconfig.json refactor(core): merge @uppy/utils into core via ./utils export 2026-06-22 01:40:25 +05:30
turbo.json Fix turbo race condition (#5839) 2025-07-23 10:49:11 +02: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: Smart CDN. 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.