The @uppy/facebook
plugin lets users import files from their
Facebook account.
Try out the live example or take it for a spin in StackBlitz.
When should I use this?
When you want to let users import files from their Facebook account.
A Companion instance is required for the Facebook plugin to work. Companion handles authentication with Facebook, 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/facebook
yarn add @uppy/facebook
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/v4.4.0/uppy.min.css" rel="stylesheet">
<!-- 2. Initialize -->
<div id="uppy"></div>
<script type="module">
import { Uppy, Facebook } from "https://releases.transloadit.com/uppy/v4.4.0/uppy.min.mjs"
const uppy = new Uppy()
uppy.use(Facebook, {
// Options
})
</script>
Use
Using Facebook requires setup in both Uppy and Companion.
Use in Uppy
import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import Facebook from '@uppy/facebook';
import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';
new Uppy()
.use(Dashboard, { inline: true, target: '#dashboard' })
.use(Facebook, { companionUrl: 'https://your-companion.com' });
Use with Transloadit
import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit';
import Facebook from '@uppy/facebook';
uppy.use(Facebook, {
companionUrl: COMPANION_URL,
companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
});
You may also hit rate limits, because the OAuth application is shared between everyone using Transloadit.
To solve that, you can use your own OAuth keys with Transloadit’s hosted Companion servers by using Transloadit Template Credentials. Create a Template Credential on the Transloadit site. Select “Companion OAuth” for the service, and enter the key and secret for the provider you want to use. Then you can pass the name of the new credentials to that provider:
import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit';
import Facebook from '@uppy/facebook';
uppy.use(Facebook, {
companionUrl: COMPANION_URL,
companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
companionKeysParams: {
key: 'YOUR_TRANSLOADIT_API_KEY',
credentialsName: 'my_companion_dropbox_creds',
},
});
Use in Companion
You can create a Facebook App on the Facebook Developers site.
The app page has a “Redirect URIs” field. Here, add:
https://$YOUR_COMPANION_HOST_NAME/facebook/redirect
If you are using Transloadit hosted Companion:
https://api2.transloadit.com/companion/facebook/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!
You need to set up OAuth in your Facebook app for Companion to be able to
connect to users’ Facebook accounts. You have to enable “Advanced Access” for
the user_photos
permission. A precondition of that is “Business Verification”
which involves setting up a Meta Business Account and submitting documents to
prove business ownership.
Configure the Facebook key and secret. With the standalone Companion server, specify environment variables:
export COMPANION_FACEBOOK_KEY="Facebook API key"
export COMPANION_FACEBOOK_SECRET="Facebook API secret"
When using the Companion Node.js API, configure these options:
companion.app({
providerOptions: {
facebook: {
key: 'Facebook API key',
secret: 'Facebook API secret',
},
},
});
API
Options
id
A unique identifier for this plugin (string
, default: 'Facebook'
).
title
Title / name shown in the UI, such as Dashboard tabs (string
, default:
'Facebook'
).
target
DOM element, CSS selector, or plugin to place the drag and drop area into
(string
, Element
, Function
, or UIPlugin
, default:
Dashboard
).
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.