@apideck/file-picker-js

中文文档
1.0.2发布于 2023/02/02MITTypeScriptESM + CJS零依赖近 30 天下载 3882

一个香草 JavaScript 库来嵌入 Apideck 文件选择器 在任何网络应用程序中.

中文使用文档
文档目录6 节
  1. 安装
  2. 软件包
  3. 脚本
  4. 先决条件
  5. 使用量
  6. 属性

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” 模式选择要上传所提供文件的文件夹

版本与发布记录

@apideck/file-picker-js 共发布 2 个版本,首次发布于 2023/02/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.2latest2023/02/023 年前
1.0.12023/02/023 年前

关于 @apideck/file-picker-js 的常见问题

@apideck/file-picker-js 是什么?

一个香草 JavaScript 库来嵌入 Apideck 文件选择器 在任何网络应用程序中.

如何安装 @apideck/file-picker-js?

在项目目录运行 npm install @apideck/file-picker-js,或使用 pnpm add / yarn add / bun add。

@apideck/file-picker-js 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@apideck/file-picker-js 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@apideck/file-picker-js 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=12。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@apideck/file-picker-js 可以商用吗?

@apideck/file-picker-js 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@apideck/file-picker-js 的下载量有多少?

根据 npm 官方下载统计,@apideck/file-picker-js 在 2026/10/06 – 2026/11/04 这 30 天内被下载 3,882 次,日均约 129 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@apideck/file-picker-js 还在维护吗?

最新版本 1.0.2 发布于 2023/02/02(3 年前);至今共发布 2 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/02/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。