Skip to main content

Dropbox

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

tip

Try out the live example or take it for a spin in CodeSandbox.

When should I use this?

When you want to let 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.

You can self-host Companion or get a hosted version with any Transloadit plan.

npm install @uppy/dropbox

Use

Using Dropbox requires setup in both Uppy and Companion.

Use in Uppy

import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import Dropbox from '@uppy/dropbox';

import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';

new Uppy().use(Dashboard, { inline: true, target: '#dashboard' }).use(Dropbox, {
target: Dashboard,
companionUrl: 'https://your-companion.com',
});

Use in Companion

You can create a Dropbox App on the Dropbox Developers site.

Things to note:

  • Choose the “Dropbox API”, not the business variant.
  • Typically you’ll want “Full Dropbox” access, unless you are absolutely certain that you need the other one.

You’ll be redirected to the app page. This page lists the app key and app secret, which you should use to configure Companion as shown above.

The app page has a “Redirect URIs” field. Here, add:

https://$YOUR_COMPANION_HOST_NAME/dropbox/redirect

If you are using Transloadit hosted Companion:

https://api2.transloadit.com/companion/dropbox/redirect

You can only use the integration with your own account initially. Make sure to apply for production status on the app page before you publish your app, or your users will not be able to sign in!

Configure the Dropbox key and secret. With the standalone Companion server, specify environment variables:

export COMPANION_DROPBOX_KEY="Dropbox API key"
export COMPANION_DROPBOX_SECRET="Dropbox API secret"

When using the Companion Node.js API, configure these options:

companion.app({
providerOptions: {
dropbox: {
key: 'Dropbox API key',
secret: 'Dropbox API secret',
},
},
});

API

Options

id

A unique identifier for this plugin (string, default: 'Dropbox').

title

Title / name shown in the UI, such as Dashboard tabs (string, default: 'Dropbox').

target

DOM element, CSS selector, or plugin to place the drag and drop area into (string or Element, default: null).

companionUrl

URL to a Companion instance (string, default: null).

companionHeaders

Custom headers that should be sent along to Companion on every request (Object, default: {}).

companionAllowedHosts

The valid and authorised URL(s) from which OAuth responses should be accepted (string or RegExp or Array, default: companionUrl).

This value can be a string, a RegExp pattern, or an Array of both. This is useful when you have your Companion running on several hosts. Otherwise, the default value should do fine.

companionCookiesRule

This option correlates to the RequestCredentials value (string, default: 'same-origin').

This tells the plugin whether to send cookies to Companion.

locale

export default {
strings: {
pluginNameDropbox: 'Dropbox',
},
};