FilePicker 联合来文
一个香草 JavaScript 库来嵌入 Apideck 文件选择器 在任何网络应用程序中.
FilePicker 联合来文 | 文件选择器反应
安装
软件包
npm install @apideck/file-picker-js
脚本
如果你不想建立一个建筑环境,你可以得到 @apideck/file-picker-js 从一个像 unpkg.com 的 CDN 中,它将通过 window.FilePicker 对象.
<script src="https://unpkg.com/@apideck/file-picker-js"></script>
先决条件
在打开文件选择器模式之前 @apideck/file-picker-js,您需要使用 Vault API 或我们中的一个 SDKs 软件中查找更多内容 文档。 。 。 .
使用量
将您从 Vault 会话得到的 JWT 传递到 @apideck/file-picker-js 并提供一个 onSelect 在选择文件时行事的函数:
import { FilePicker } from '@apideck/file-picker-js';
FilePicker.open({
token: 'REPLACE_WITH_SESSION_TOKEN',
onSelect: file => console.log(file),
});
如果你想在模式打开和关闭时得到通知,你可以提供 onReady 财务报告和审定财务报表 onClose 选项。 消费者通过使用 onConnectionSelect 选项.
import { FilePicker } from '@apideck/file-picker-js';
FilePicker.open({
token: 'REPLACE_WITH_SESSION_TOKEN',
onSelect: file => console.log(file),
onClose: () => {
console.log('closed!');
},
onReady: () => {
console.log('ready!');
},
onConnectionSelect: connection => {
console.log(connection);
},
});
您也可以通过 fileToSave 选项将迫使文件选择器进入“上载”模式。 这将允许用户选择文件需要保存的连接器和文件夹 .
import { FilePicker } from '@apideck/file-picker-js';
FilePicker.open({
token: 'REPLACE_WITH_SESSION_TOKEN',
fileToSave: '<add-file-here>',
});
属性
| 财产 | 类型 | 需求 | 默认 | 说明 |
|---|---|---|---|---|
| 符号 | 字符串 | 真实 | - 说吧 | JSON 网络键从创建会话呼叫返回 |
| 选择 | 事件 | 虚假 | - 说吧 | 选择文件时调用的函数 |
| 连接选择 | 事件 | 虚假 | - 说吧 | 选择连接时调用的函数 |
| 标题 | 字符串 | 虚假 | Apideck 文件拾取器 | 模式中显示的标题 |
| 子标题 | 字符串 | 虚假 | 选择文件 | 在模式中显示的子标题 |
| 显示归属 | 布尔 | 虚假 | 真实 | 在模式背景中显示“ Powered by Apideck” |
| 打开 | 布尔 | 虚假 | 虚假 | 如果设置为真, 打开文件拾取器 |
| 关闭 | 事件 | 虚假 | - 说吧 | 模式关闭时调用的函数 |
| 要保存的文件 | 文件 | 虚假 | - 说吧 | 强制“ Upload” 模式选择要上传所提供文件的文件夹 |