Uppy Facebook 插件

@uppy/facebook 插件允许用户从他们的 Facebook 账户导入文件。

何时使用？

当你想让用户从他们的 Facebook 账户导入文件时。

使用 Facebook 插件需要一个 Companion 实例。Companion 处理与 Facebook 的认证，下载文件，并将其上传到目标位置。这为用户节省了带宽，特别是当他们使用移动网络连接时非常有用。

你可以自托管 Companion 或者通过任何 Transloadit 计划获得托管版本。

安装

npm
```
npm install @uppy/facebook
```
yarn
```
yarn add @uppy/facebook
```

CDN

警告

此捆绑包包含了大部分Uppy插件，因此不建议在生产环境中使用此方法，因为尽管您可能仅仅用到其中一小部分插件，但用户却需要下载全部插件。
然而，这对于加速您的开发环境非常有帮助，所以在起步阶段，请放心使用它来提升开发速度。

<!-- 1. Add CSS to `<head>` -->
<link href="https://releases.transloadit.com/uppy/v3.27.3/uppy.min.css" rel="stylesheet">

<!-- 2. Initialize -->
<div id="uppy"></div>

<script type="module">
    import { Uppy, Facebook } from "https://releases.transloadit.com/uppy/v3.27.3/uppy.min.mjs"
    const uppy = new Uppy()
    uppy.use(Facebook, {
    // Options
    })
</script>

使用方法

使用 Facebook 需要在 Uppy 和 Companion 中进行设置。

在 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" });

在 Companion 中使用

你可以在 Facebook 开发者网站上创建一个 Facebook 应用程序。

应用页面有一个 “重定向 URI” 字段。在这里添加：

https://$YOUR_COMPANION_HOST_NAME/facebook/redirect

如果你使用的是 Transloadit 托管的 Companion：

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

最初，你只能用自己的账户进行集成。确保在发布应用之前，在应用页面上申请生产状态，否则你的用户将无法登录！

为了让 Companion 能够连接到用户的 Facebook 账户，你需要在 Facebook 应用中设置 OAuth。你需要为 user_photos 权限启用“高级访问”。为此的先决条件是“企业验证”，这涉及设置一个 Meta 企业账户并提交文件来证明企业所有权。

配置 Facebook 密钥和密钥。对于独立的 Companion 服务器，指定环境变量：

export COMPANION_FACEBOOK_KEY="Facebook API 密钥"
export COMPANION_FACEBOOK_SECRET="Facebook API 密钥"

当使用 Companion Node.js API 时，配置这些选项：

companion.app({
  providerOptions: {
    facebook: {
      key: "Facebook API 密钥",
      secret: "Facebook API 秘密",
    },
  },
});

API

选项

`id`

此插件的唯一标识符（ string，默认：'Facebook' ）。

`title`

在 UI 中显示的标题/名称，如 Dashboard 标签（ string，默认：'Facebook' ）。

`target`

放置拖放区域的 DOM 元素、CSS 选择器或插件（ string，Element，Function，或 UIPlugin，默认：Dashboard ）。

`companionUrl`

指向 Companion 实例的 URL（ string，默认：null ）。

`companionHeaders`

应随每个请求一起发送到 Companion 的自定义头（ Object，默认：{} ）。

`companionAllowedHosts`

有效且授权的 URL(s)，OAuth 响应应从此处接受 ( string 或 RegExp 或 Array，默认值: companionUrl )。

此值可以是 string、RegExp 模式或两者的 Array。当你有 Companion 在多个主机上运行时，这非常有用。否则，默认值应该足够好。

`companionCookiesRule`

此选项对应于 RequestCredentials 值（ string，默认值: 'same-origin' ）。

这告诉插件是否应向 Companion 发送 cookies。

`locale`

export default {
  strings: {
    pluginNameFacebook: "Facebook",
  },
};

Uppy Facebook 插件

何时使用？

安装

使用方法

在 Uppy 中使用

在 Companion 中使用

API

选项

id

title

target

companionUrl

companionHeaders

companionAllowedHosts

companionCookiesRule

locale

在本文档中