Facebook

The @uppy/facebook plugin lets users import files from their Facebook account.

A Companion instance is required for the @uppy/facebook plugin to work. Companion handles authentication with Facebook, downloads the pictures and videos, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.

const Facebook = require('@uppy/facebook')

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

Try it live

Installation

If you are using the uppy package, you do not need to install this plugin manually.

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

Install from NPM:

npm install @uppy/facebook

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

const Facebook = Uppy.Facebook

CSS

Dashboard plugin is recommended as a container to all Provider plugins, including Facebook. 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 Facebook 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/facebook plugin has the following configurable options:

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

`id: 'Facebook'`

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

`title: 'Facebook'`

Configures the title / name shown in the UI, for instance, on Dashboard tabs. It defaults to 'Facebook'.

`target: null`

DOM element, CSS selector, or plugin to mount the Facebook 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 be good enough.

`locale: {}`

Localize text that is shown to the user.

The default English strings are:

strings: {
  // TODO
}

Docs

UI Elements

Sources

Destinations

File Processing

Miscellaneous

React

Contributing