Uppy Dropbox 插件

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

何时使用此插件？

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

使用 Dropbox 插件需要一个 Companion 实例。Companion 负责与 Dropbox 进行身份验证、下载文件并将其上传到目标位置。这节省了用户的带宽，特别是当他们使用移动网络时非常有用。

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

安装

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

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, Dropbox } from "https://releases.transloadit.com/uppy/v3.27.3/uppy.min.mjs"
    const uppy = new Uppy()
    uppy.use(Dropbox, {
    // Options
    })
</script>

使用方法

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

在 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, { companionUrl: "https://your-companion.com" });

在 Companion 中使用

你可以在 Dropbox 开发者网站创建一个 Dropbox 应用。

需要注意的点：

选择 “Dropbox API” ，而不是商业变体。
通常你需要 “完全访问 Dropbox” ，除非你绝对确定需要其他选项。

你将被重定向到应用页面。这个页面列出了应用密钥和应用秘密，你应该使用它们来配置 Companion，如上所示。

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

https://$YOUR_COMPANION_HOST_NAME/dropbox/redirect

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

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

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

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

export COMPANION_DROPBOX_KEY="Dropbox API 密钥"
export COMPANION_DROPBOX_SECRET="Dropbox API 秘密"

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

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

API

选项

`id`

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

`title`

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

`target`

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

`companionUrl`

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

`companionHeaders`

每次向 Companion 发送请求时应随附的自定义头（ Object，默认值：{} ）。

companionAllowedHosts

从 OAuth 响应应被接受的有效和授权的 URL（ string 或 RegExp 或 Array ，默认：companionUrl ）。

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

companionCookiesRule

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

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

locale

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