uppy/website/src/docs/dropbox.md

---

type: docs order: 11 title: "Dropbox" menu_prefix: "ⓒ " module: "@uppy/dropbox" permalink: docs/dropbox/ category: "Sources"

tagline: "import files from Dropbox"

The @uppy/dropbox plugin lets users import files from their Dropbox account.

A Companion instance is required for the Dropbox plugin to work. Companion handles authentication with Dropbox, downloads the files, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.

const Dropbox = require('@uppy/dropbox')

uppy.use(Dropbox, {
  // Options
})

Try it live

Installation

This plugin is published as the @uppy/dropbox package.

Install from NPM:

npm install @uppy/dropbox

In the CDN package, it is available on the Uppy global object:

const Dropbox = Uppy.Dropbox

CSS

Dashboard plugin is recommended as a container to all Provider plugins, including Dropbox. If you are using Dashboard, it comes with all the nessesary styles for Dropbox as well.

⚠️ If you are feeling adventurous, and want to use Dropbox plugin separately, without Dashboard, make sure to include @uppy/provider-views/dist/style.css (or style.min.css) CSS file. This is experimental, not officialy supported and not recommended.

Options

The @uppy/dropbox plugin has the following configurable options:

uppy.use(Dropbox, {
  target: Dashboard,
  companionUrl: 'https://companion.uppy.io/',
})

id: 'Dropbox'

A unique identifier for this plugin. It defaults to 'Dropbox'.

title: 'Dropbox'

Title / name shown in the UI, such as Dashboard tabs. It defaults to 'Dropbox'.

target: null

DOM element, CSS selector, or plugin to mount the Dropbox provider into. This should normally be the Dashboard.

companionUrl: null

URL to a Companion instance.

companionHeaders: {}

Custom headers that should be sent along to Companion on every request.

companionAllowedHosts: companionUrl

The valid and authorised URL(s) from which OAuth responses should be accepted.

This value can be a String, a Regex pattern, or an Array of both.

This is useful when you have your Companion running on multiple hosts. Otherwise, the default value should do just fine.

locale: {}

Localize text that is shown to the user.

The default English strings are:

strings: {
  // TODO
}