# @coastpay/embedded-widget-sdk 中文文档

规范地址：https://npmcn.com/package/%40coastpay/embedded-widget-sdk/

版本：0\.8\.3
npm 元数据更新时间：2026-08-11T13:53:21.235Z
中文译文更新时间：2026-11-10T04:53:06.795Z
软件包许可：SEE LICENSE IN LICENSE\.md

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

原始 npm 页面：https://www.npmjs.com/package/%40coastpay/embedded-widget-sdk
原文对照：https://npmcn.com/package/%40coastpay/embedded-widget-sdk/?lang=original
项目主页：https://coastpay.com/

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

- 包体积（解压后）：22.2 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2026-04-06T17:34:35.811Z
- 最新版本发布：2026-08-11T13:53:20.962Z
- 近 30 天下载量：13419（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

海岸嵌入部件 SDK

## 安装

```sh
npm install @coastpay/embedded-widget-sdk
```

也可以使用：`pnpm add @coastpay/embedded-widget-sdk`、`yarn add @coastpay/embedded-widget-sdk`、`bun add @coastpay/embedded-widget-sdk`

## README

# 海岸部件 SDK

在您的网络应用程序中嵌入海岸 .

## 开始

```bash
npm install @coastpay/embedded-widget-sdk
```

装入 SDK并初始化 :

```typescript
import { loadCoast } from '@coastpay/embedded-widget-sdk';

const coast = await loadCoast();

const widget = coast.initialize({
  container: 'coast-container', // element id or HTMLElement
  embedToken,
  onReady: () => {
    // the embedded app has finished loading and is ready to be used
    console.log('Coast widget is ready');
  },
  onError: (error) => {
    console.error('Coast widget error:', error);
  },
});
```

* * *

## API 密码

### `coast.initialize(options)`

将部件 iframe 挂入容器元素并返回 a `CoastWidget` 举个例子.

> **单倍限 :** 一次只有一个部件可以活动 。 通话 `initialize()` 当一个部件已经存在时,会自动销毁上一个部件.

| 选项 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `container` | `string | HTMLElement` | 对 | 元素 `id` 或直接 `HTMLElement` 参考文献 |
| `embedToken` | `string` | 对 | 从您的后端嵌入的 Token API 呼叫中生成的不透明会话符号 |
| `onReady` | `() => void` | 没有 | 当嵌入式应用程序装入完成并准备使用时调用 |
| `onError` | `(error: Error) => void` | 没有 | 在初始化失败或嵌入式应用程序在30秒内无法装入时调用 |
| `onLogin` | `() => void` | 没有 | 一旦用户在嵌入式应用程序中被认证, 就会被调用 。 恢复会话的起火也可能会不止一次地为同一个用户起火——使您的处理器具有一能性. 只有客户端通知——在录制状态前确认服务器端 |
| `onLogout` | `() => void` | 没有 | 当用户从嵌入的应用程序中日志出时( 如会话过期) 调用 |

* * *

### `widget.logout()`

通知宿主用户已登录的嵌入式应用程序. 当您自己的会话结束时,请打电话.

### `widget.destroy()`

删除 Iframe 并清理所有事件听众.

## 常见问题

### @coastpay/embedded-widget-sdk 是什么？

海岸嵌入部件 SDK

### 如何安装 @coastpay/embedded-widget-sdk？

在项目目录运行 npm install @coastpay/embedded-widget-sdk，或使用 pnpm add / yarn add / bun add。

### @coastpay/embedded-widget-sdk 支持 TypeScript 吗？

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

### @coastpay/embedded-widget-sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @coastpay/embedded-widget-sdk 需要什么版本的 Node\.js？

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

### @coastpay/embedded-widget-sdk 可以商用吗？

@coastpay/embedded-widget-sdk 使用 SEE LICENSE IN LICENSE\.md 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @coastpay/embedded-widget-sdk 的下载量有多少？

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

### @coastpay/embedded-widget-sdk 还在维护吗？

最新版本 0\.8\.3 发布于 2026/08/11（2 个月前）；至今共发布 5 个版本，其中过去 12 个月发布了 5 个；首次发布于 2026/04/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。