# @uppy/form

> Connect Uppy to an existing HTML .

Latest version **6.0.0** (published 2026-08-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @uppy/form
pnpm add @uppy/form
yarn add @uppy/form
bun add @uppy/form
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score; popular repo.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2026-08-26 |
| First published | 2018-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 24.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30991 |
| Maintainers | kvz, tim-kos, mifi, uppydev |
| Keywords | file uploader, uppy, uppy-plugin, form |

## Links

- npm: https://www.npmjs.com/package/@uppy/form
- Repository: https://github.com/transloadit/uppy
- Homepage: https://uppy.io
- Issues: https://github.com/transloadit/uppy/issues
- npm.io page: https://npm.io/package/@uppy/form

## Dependencies (1)

- [get-form-data](https://npm.io/package/get-form-data.md) ^3.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 6.0.0 (latest) — 2026-08-26
- 4.0.0-beta.6 (next) — 2024-07-02
- 5.1.0 — 2025-12-02
- 5.0.1 — 2025-09-16
- 5.0.0 — 2025-08-22
- 4.2.2 — 2025-08-01
- 4.2.1 — 2025-07-29
- 4.2.0 — 2025-07-29
- 4.1.1 — 2025-01-09
- 4.1.0 — 2025-01-06
- 4.0.2 — 2024-12-05
- 4.0.1 — 2024-10-31
- 4.0.0 — 2024-07-10
- 3.2.2 — 2024-07-02
- 4.0.0-beta.5 — 2024-06-27
- … 76 more at https://npm.io/package/@uppy/form/versions

## README

# @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">

[![npm version](https://img.shields.io/npm/v/@uppy/form.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/form)
![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg)
![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg)
![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg)

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: Smart CDN. 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).

---
_Source: https://npm.io/package/@uppy/form · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._