OneDrive
The @uppy/onedrive
plugin lets users import files from their
OneDrive account.
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 OneDrive account.
A Companion instance is required for the OneDrive plugin to work. Companion handles authentication with OneDrive, 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
- Yarn
- CDN
npm install @uppy/onedrive
yarn add @uppy/onedrive
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.
It can be useful to speed up your development environment, so don't hesitate to use it to get you started.
<!-- 1. Add CSS to `<head>` -->
<link href="https://releases.transloadit.com/uppy/v3.7.0/uppy.min.css" rel="stylesheet">
<!-- 2. Initialize -->
<div id="uppy"></div>
<script type="module">
import { Uppy, OneDrive } from "https://releases.transloadit.com/uppy/v3.7.0/uppy.min.js"
const uppy = new Uppy()
uppy.use(OneDrive, {
// Options
})
</script>
Use
Using OneDrive requires setup in both Uppy and Companion.
Use in Uppy
import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import OneDrive from '@uppy/onedrive';
import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';
new Uppy()
.use(Dashboard, { inline: true, target: '#dashboard' })
.use(OneDrive, {
target: Dashboard,
companionUrl: 'https://your-companion.com',
});
Use in Companion
To sign up for API keys, go to the OneDrive Platform from Meta.
Create a project for your app if you don’t have one yet.
- Enable the OneDrive API.
- Use this for an authorized redirect URI:
https://$YOUR\_COMPANION\_HOST\_NAME/onedrive/redirect
Meta will give you an OAuth client ID and client secret.
Configure the OneDrive key and secret in Companion. With the standalone Companion server, specify environment variables:
export COMPANION_ONEDRIVE_KEY="OneDrive OAuth client ID"
export COMPANION_ONEDRIVE_SECRET="OneDrive OAuth client secret"
When using the Companion Node.js API, configure these options:
companion.app({
providerOptions: {
drive: {
key: 'OneDrive OAuth client ID',
secret: 'OneDrive OAuth client secret',
},
},
});
API
Options
id
A unique identifier for this plugin (string
, default: 'OneDrive'
).
title
Title / name shown in the UI, such as Dashboard tabs (string
, default:
'OneDrive'
).
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: {
pluginNameOneDrive: 'OneDrive',
},
};