uppy Documentation

File: README.md Copy Chapter

[Uppy](https://uppy.io) [](https://www.npmjs.com/package/uppy)

Uppy is a sleek, modular JavaScript file uploader that integrates seamlessly
with any application. It’s fast, has a comprehensible API and lets you worry
about more important problems than building a file uploader.

• Fetch files from local disk, remote URLs, Google Drive, Dropbox, Box,
  or snap and record selfies with a camera
• Preview and edit metadata with a nice interface
• Upload to the final destination, optionally process/encode

Read the docs |
Try Uppy

Uppy is being developed by the folks at Transloadit,
a versatile API to handle any file in your app.

Example Copy Chapter

Code used in the above example:

import Uppy from '@uppy/core'
import Dashboard from '@uppy/dashboard'
import RemoteSources from '@uppy/remote-sources'
import ImageEditor from '@uppy/image-editor'
import Webcam from '@uppy/webcam'
import Tus from '@uppy/tus'

const uppy = new Uppy()
  .use(Dashboard, { trigger: '#select-files' })
  .use(RemoteSources, { companionUrl: 'https://companion.uppy.io' })
  .use(Webcam)
  .use(ImageEditor)
  .use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' })
  .on('complete', (result) => {
    console.log('Upload result:', result)
  })

Try it online or
read the docs for more details on how to use Uppy
and its plugins.

Integrations Copy Chapter

Uppy has first-class support for plain JS/HTML,
React, Svelte,
Vue, and Angular.

For the supported frameworks (except Angular) Uppy offers three ways to build user interfaces:

1. Pre-composed, plug-and-play components. Mainly <Dashboard />.
   The downside is that you can’t customize the UI.
2. Headless components. Smaller components, easier to override the styles
   or compose them together with your own components.
3. Hooks. Attach our logic to your own components, no restrictions, create a
   tailor-made UI.

Features Copy Chapter

• Lightweight, modular plugin-based architecture, light on dependencies :zap:
• Resumable file uploads via the open tus standard, so large
  uploads survive network hiccups
• Supports picking files from: Webcam, Dropbox, Box, Google Drive,
  bypassing the user’s device where possible, syncing between servers directly
  via @uppy/companion
• Works great with file encoding and processing backends, such as
  Transloadit, which handles encoding, conversion and
  delivery for you; works great without one too, if you would rather run and
  scale your own Apache/Nginx/Node/FFmpeg pipeline
• Sleek user interface :sparkles:
• Optional file recovery (after a browser crash) with
  Golden Retriever
• Speaks several languages (i18n) :earth_africa:
• Built with accessibility in mind
• Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
• Cute as a puppy, also accepts cat pictures :dog:

Installation Copy Chapter

npm install @uppy/core @uppy/dashboard @uppy/tus

Add CSS
uppy.min.css,
either to your HTML page’s <head> or include in JS, if your bundler of choice
supports it.

Alternatively, you can also use a pre-built bundle from Transloadit’s CDN: Smart
CDN. In that case Uppy will attach itself to the global window.Uppy object.

⚠️ The bundle consists of most Uppy plugins, so this method is not recommended
for production, as your users will have to download all plugins when you are
likely using only a few.

<link
  href="https://releases.transloadit.com/uppy/v5.2.4/uppy.min.css"
  rel="stylesheet"
/>



<script type="module">
  import {
    Uppy,
    Dashboard,
    Tus,
  } from 'https://releases.transloadit.com/uppy/v5.2.4/uppy.min.mjs'

  const uppy = new Uppy()
  uppy.use(Dashboard, { target: '#files-drag-drop' })
  uppy.use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' })
</script>

Documentation Copy Chapter

• Uppy — full list of options, methods and events
• Companion — setting up and running a
  Companion instance, which adds support for Dropbox, Box, Google
  Drive and remote URLs
• React — components to integrate Uppy UI plugins
  with React apps
• Architecture & Writing a Plugin — how
  to write a plugin for Uppy

Plugins Copy Chapter

UI Elements Copy Section

• Dashboard — universal UI with previews,
  progress bars, metadata editor and all the cool stuff. Required for most UI
  plugins like Webcam
• Headless components (react, svelte, vue)

Sources Copy Section

• Drag & Drop — plain drag and drop area
• File Input — even plainer “select files”
  button
• Webcam — snap and record those selfies 📷
• ⓒ Google Drive — import files from
  Google Drive
• ⓒ Dropbox — import files from Dropbox
• ⓒ Box — import files from Box
• ⓒ Facebook — import images and videos from
  Facebook
• ⓒ OneDrive — import files from Microsoft
  OneDrive
• ⓒ Import From URL — import direct URLs from
  anywhere on the web

The ⓒ mark means that @uppy/companion, a
server-side component, is needed for a plugin to work.

Destinations Copy Section

• Tus — resumable uploads via the open
  tus standard
• XHR Upload — regular uploads for any
  backend out there (like Apache, Nginx)
• AWS S3 — plain upload to AWS S3 or
  compatible services

File Processing Copy Section

• Transloadit — support for
  Transloadit’s robust file uploading and encoding
  backend

Miscellaneous Copy Section

• Golden Retriever — restores files
  after a browser crash, like it’s nothing
• Thumbnail Generator — generates
  image previews (included by default with Dashboard)
• Form — collects metadata from <form> right
  before an Uppy upload, then optionally appends results back to the form

Browser Support Copy Chapter

We aim to support recent versions of Chrome, Firefox, and Safari.

FAQ Copy Chapter

Why not use ``? Copy Section

Having no JavaScript beats having a lot of it, so that’s a fair question!
Running an uploading & encoding business for ten years though we found that in
cases, the file input leaves some to be desired:

• We received complaints about broken uploads and found that resumable uploads
  are important, especially for big files and to be inclusive towards people on
  poorer connections (we also launched tus.io to attack that
  problem). Uppy uploads can survive network outages and browser crashes or
  accidental navigate-aways.
• Uppy supports editing meta information before uploading.
• Uppy allows cropping images before uploading.
• There’s the situation where people are using their mobile devices and want to
  upload on the go, but they have files in Dropbox
  or a plain file URL from anywhere on the open web. Uppy allows to pick files
  from those and push it to the destination without downloading it to your
  mobile device first.
• Accurate upload progress reporting is an issue on many platforms.
• Some file validation — size, type, number of files — can be done on the client
  with Uppy.
• Uppy integrates webcam support, in case your users want to upload a
  picture/video/audio that does not exist yet :)
• A larger drag and drop surface can be pleasant to work with. Some people also
  like that you can control the styling, language, etc.
• Uppy is aware of encoding backends. Often after an upload, the server needs to
  rotate, detect faces, optimize for iPad, or what have you. Uppy can track
  progress of this and report back to the user in different ways.
• Sometimes you might want your uploads to happen while you continue to interact
  on the same single page.

Not all apps need all these features. An `` is fine in many
situations. But these were a few things that our customers hit / asked about
enough to spark us to develop Uppy.

Why is all this goodness free? Copy Section

Transloadit’s team is small and we have a shared ambition to make a living from
open source. By giving away projects like tus.io and
Uppy, we’re hoping to advance the state of the art, make life
a tiny little bit better for everyone and in doing so have rewarding jobs and
get some eyes on our commercial service:
a content ingestion & processing platform.

Our thinking is that if only a fraction of our open source userbase can see the
appeal of hosted versions straight from the source, that could already be enough
to sustain our work. So far this is working out! We’re able to dedicate 80% of
our time to open source and haven’t gone bankrupt yet. :D

Does Uppy support S3 uploads? Copy Section

Yes, please check out the docs for more
information.

Can I use Uppy with Rails/Node.js/Go/PHP? Copy Section

Yes, whatever you want on the backend will work with @uppy/xhr-upload plugin,
since it only does a POST or PUT request. Here’s a
PHP backend example.

If you want resumability with the Tus plugin, use
one of the tus server implementations 👌🏼

And you’ll need @uppy/companion if you’d
like your users to be able to pick files from Google Drive, Dropbox
or via direct URLs (with more services coming).

Contributions are welcome Copy Chapter

• Contributor’s guide in .github/CONTRIBUTING.md
• Changelog to track our release progress (we aim to roll out a release every
  month): CHANGELOG.md

Used by Copy Chapter

Uppy is used by: Photobox, Issuu,
Law Insider, Cool Tabs,
Soundoff, Scrumi,
Crive and others.

Use Uppy in your project?
Let us know!

Contributors Copy Chapter

License Copy Chapter

The MIT License.

File: examples/xhr-python/README.md Copy Chapter

Uppy + Python Example

This example uses a Python Flask server and @uppy/xhr-upload to upload files
to the local file system.

Run it Copy Chapter

To run this example, make sure you've correctly installed the repository
root:

corepack yarn install
corepack yarn build

That will also install the npm dependencies for this example.

Additionally, this example uses python dependencies. Move into this directory,
and install them using pip:

corepack yarn workspace @uppy-example/python-xhr installPythonDeps

Then, again in the repository root, start this example by doing:

corepack yarn workspace @uppy-example/python-xhr start

File: examples/xhr-php/README.md Copy Chapter

Uppy + PHP Example

This example uses PHP server and @uppy/xhr-upload to upload files to the local
file system.

Run it Copy Chapter

To run this example, make sure you've correctly installed the repository
root:

corepack yarn install
corepack yarn build

That will also install the dependencies for this example.

Then, again in the repository root, start this example by doing:

corepack yarn workspace @uppy-example/php-xhr start

File: examples/xhr-node/README.md Copy Chapter

Uppy + Node Example

This example uses Node server and @uppy/xhr-upload to upload files to the
local file system.

Run it Copy Chapter

To run this example, make sure you've correctly installed the repository
root:

corepack yarn install
corepack yarn build

That will also install the dependencies for this example.

Then, again in the repository root, start this example by doing:

corepack yarn workspace @uppy-example/node-xhr start

File: examples/xhr-bundle/README.md Copy Chapter

XHR Bundle Upload

This example uses Uppy with XHRUpload plugin in bundle mode. Bundle mode
uploads all files to the endpoint in a single request, instead of firing off a
new request for each file. This makes uploading a bit slower, but it may be
easier to handle on the server side, depending on your setup.

server.cjs contains an example express.js server that receives
a multipart form-data upload and responds with some information about the files
that were received (name, size) as JSON. It uses
multer to parse the upload stream.

Run it Copy Chapter

To run this example, make sure you've correctly installed the repository
root:

corepack yarn install
corepack yarn build

That will also install the dependencies for this example.

Then, again in the repository root, start this example by doing:

corepack yarn workspace @uppy-example/xhr-bundle start

File: examples/vue/README.md Copy Chapter

Vue 3 example

To run the example, from the root directory of this repo, run the following
commands:

cp .env.example .env
corepack yarn install
corepack yarn build
corepack yarn workspace @uppy-example/vue3 dev

File: examples/transloadit/README.md Copy Chapter

Transloadit example

This example shows how to make advantage of Uppy API to upload files to
Transloadit.

Run it Copy Chapter

To run this example, make sure you've correctly installed the repository
root:

corepack yarn install
corepack yarn build

That will also install the dependencies for this example.

Then, again in the repository root, start this example by doing:

corepack yarn workspace @uppy-example/transloadit start

File: examples/sveltekit/README.md Copy Chapter

sv

Everything you need to build a Svelte project, powered by
sv.

Creating a project Copy Chapter

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npx sv create

# create a new project in my-app
npx sv create my-app

Developing Copy Chapter

Once you've created a project and installed dependencies with npm install (or
pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building Copy Chapter

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an
adapter for your target environment.

File: examples/reactrouter/README.md Copy Chapter

React Router v7 + Uppy Upload Examples

Complete showcase of Uppy Dashboard with TUS (resumable), XHR (standard), and Transloadit (with processing) uploads in React Router v7 framework mode.

Quick Start Copy Chapter

npm install
npm run dev

Visit http://localhost:3000 to explore three upload methods:

• TUS uploads: Resumable, perfect for large files
• XHR uploads: Standard HTTP, ideal for regular files
• Transloadit uploads: With powerful file processing capabilities

What You'll Learn Copy Chapter

This example demonstrates three upload approaches with Uppy in React Router v7:

1. TUS server setup with Express middleware for resumable uploads
2. XHR uploads using React Router's native resource routes
3. Transloadit uploads with signature generation and file processing

Transloadit Setup Copy Chapter

To use Transloadit uploads, you need to:

1. Sign up at transloadit.com
2. Get your credentials from your account dashboard
3. Create a template for your processing needs
4. Set environment variables:

export TRANSLOADIT_KEY="your_key_here"
export TRANSLOADIT_SECRET="your_secret_here"
export TRANSLOADIT_TEMPLATE_ID="your_template_id_here"

Or create a .env file:

TRANSLOADIT_KEY=your_key_here
TRANSLOADIT_SECRET=your_secret_here
TRANSLOADIT_TEMPLATE_ID=your_template_id_here

File: examples/nextjs/README.md Copy Chapter

This is a Next.js project bootstrapped with create-next-app.

Getting Started Copy Chapter

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.

Learn More Copy Chapter

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel Copy Chapter

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.