# @finicity/connect-web-sdk 中文文档

规范地址：https://npmcn.com/package/%40finicity/connect-web-sdk/

版本：1\.0\.0-rc\.4
npm 元数据更新时间：2022-05-13T18:52:57.220Z
中文译文更新时间：2026-11-14T18:50:15.314Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40finicity/connect-web-sdk
原文对照：https://npmcn.com/package/%40finicity/connect-web-sdk/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：168 kB，19 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：core-js ^3\.9\.1
- 首次发布：2021-05-11T19:04:15.401Z
- 最新版本发布：2022-05-13T18:52:57.139Z
- 近 30 天下载量：118168（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

Finicity 连接网络 SDK

## 安装

```sh
npm install @finicity/connect-web-sdk
```

也可以使用：`pnpm add @finicity/connect-web-sdk`、`yarn add @finicity/connect-web-sdk`、`bun add @finicity/connect-web-sdk`

## README

# Finicity 连接网络 SDK

## 概览

Finicity Connect Web SDK为开发者提供了一个将Finicity Connect集成到他们的网络应用中的简单方法. 它通过iframe或通过弹出窗口支持嵌入式体验.

## 安装

```bash
npm install @finicity/connect-web-sdk
```

## 使用量

### 积累的经验

```typescript
import { FinicityConnect, ConnectEventHandlers, ConnectOptions, ConnectDoneEvent, ConnectCancelEvent, ConnectErrorEvent, ConnectRouteEvent } from '@finicity/connect-web-sdk';

export class ConnectComponent {
  
  connectEventHandlers: ConnectEventHandlers = {
    onDone: (event: ConnectDoneEvent) => { console.log(event); },
    onCancel: (event: ConnectCancelEvent) => { console.log(event); },
    onError: (event: ConnectErrorEvent) => { console.log(event); },
    onRoute: (event: ConnectRouteEvent) => { console.log(event); },
    onUser: (event: any) => { console.log(event); },
    onLoad: () => { console.log('loaded'); }
  };

  connectOptions: ConnectOptions = {
    overlay: 'rgba(199,201,199, 0.5)'
  };

  constructor() {
    FinicityConnect.launch(
      'CONNECT_URL',
     this.connectEventHandlers,
     this.connectOptions);
  }
}
```

### 弹出体验

```typescript
import { FinicityConnect, ConnectEventHandlers, ConnectOptions, ConnectDoneEvent, ConnectCancelEvent, ConnectErrorEvent, ConnectRouteEvent } from '@finicity/connect-web-sdk';

export class ConnectComponent {
  
  connectEventHandlers: ConnectEventHandlers = {
    onDone: (event: ConnectDoneEvent) => { console.log(event); },
    onCancel: (event: ConnectCancelEvent) => { console.log(event); },
    onError: (event: ConnectErrorEvent) => { console.log(event); },
    onRoute: (event: ConnectRouteEvent) => { console.log(event); },
    onUser: (event: any) => { console.log(event); },
    onLoad: () => { console.log('loaded'); }
  };

  connectOptions: ConnectOptions = {
    popup: true,
    popupOptions: {
      width: 600,
      height: 600,
      top: window.top.outerHeight / 2 + window.top.screenY - (600 / 2),
      left: window.top.outerWidth / 2 + window.top.screenX - (600 / 2)
    }
  };

  constructor() {
    FinicityConnect.launch(
      'CONNECT_URL',
     this.connectEventHandlers,
     this.connectOptions);
  }
}
```

## 连接事件处理器

| 事件类型 | 说明 |
| --- | --- |
| 登录 | 当连接网页被装入并准备显示时调用 |
| 已执行 | 当用户成功完成连接应用程序时调用 |
| 取消时 | 当用户取消连接应用程序时调用 |
| 错误 | 当用户使用连接时发生错误时调用 |
| 旋转 | 与用户一起调用正在浏览 Connect 应用程序的屏幕 |
| 用户 | 用户执行动作时调用 。 用户事件为用户在连接应用程序内可采取的行动提供可见度 |

关于这些活动的更详细资料: [连接事件类型](https://docs.finicity.com/connect-2-0-events-types/)

## 连接选项

| 选项 | 说明 |
| --- | --- |
| 覆盖 | 更改显示连接模式的覆盖颜色( 仅针对 iframe, 默认为 rgba( 0, 0, 0, 0) ) |
| 选择器 | CSS 选择器, Connect 应当嵌入其中 。 连接会扩大以填充容器的尺寸,元素的位置不能是 `static`连接将默认显示为模式 |
| 节点 | 连接应该嵌入的元素 。 连接会扩大以填充容器的尺寸,元素的位置不能是 `static`连接将默认显示为模式 |
| 弹出 | 显示连接是否在弹出中显示( 默认为假) |
| 弹出选项 | 用于配置弹出子的宽度/ 高和定位( 上/ 左) |

## 常见问题

### @finicity/connect-web-sdk 是什么？

Finicity 连接网络 SDK

### 如何安装 @finicity/connect-web-sdk？

在项目目录运行 npm install @finicity/connect-web-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：core-js（^3\.9\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @finicity/connect-web-sdk 支持 TypeScript 吗？

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

### @finicity/connect-web-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @finicity/connect-web-sdk 可以商用吗？

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

### @finicity/connect-web-sdk 的下载量有多少？

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

### @finicity/connect-web-sdk 还在维护吗？

最新版本 1\.0\.0-rc\.4 发布于 2022/05/14（4 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/05/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。