# @bdfkit/viewer 中文文档

规范地址：https://npmcn.com/package/%40bdfkit/viewer/

版本：0\.2\.1
npm 元数据更新时间：2026-10-28T01:01:45.771Z
中文译文更新时间：2026-11-07T20:57:05.713Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bdfkit/viewer
原文对照：https://npmcn.com/package/%40bdfkit/viewer/?lang=original
项目主页：https://github.com/shibukawa/bdf#readme
源码仓库：https://github.com/shibukawa/bdf

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

- 包体积（解压后）：68.1 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-09-29T22:39:18.005Z
- 最新版本发布：2026-10-28T01:01:45.359Z
- 近 30 天下载量：2591（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

用于滚动、页面布局、灯盒和可选音乐视图的文档表面

## 安装

```sh
npm install @bdfkit/viewer
```

也可以使用：`pnpm add @bdfkit/viewer`、`yarn add @bdfkit/viewer`、`bun add @bdfkit/viewer`

## README

# @bdfkit/ 查看器

用于 BDF 的未打开的文档表面 . `Viewer` 拥有页面放置,滚动,懒惰渲染,以及演示文稿状态,而主机应用程序则拥有其工具栏,文件拾取器,标签和灯盒控制.

```sh
npm install @bdfkit/viewer
```

```ts
import { Viewer } from "@bdfkit/viewer";

const viewer = new Viewer(document.querySelector("#document")!, {
  mode: "embedded",       // or "lightbox"
  layout: "spread",        // single, spread, or continuous
});
await viewer.open({ kind: "url", url: "/reports/report.bdf" });
```

该软件包仅是渲染器,并期望服务器提供BDF. 要在浏览器中转换文件,请通过一个转换器 `@bdfkit/convert-pdf-epub`, (中文(简体) ), `@bdfkit/convert-office`,或 `@bdfkit/convert-all` 改为 `viewer.openFile`。 。 。 .

虽然焦点在取景器中,浏览器的查找快捷键(Cmd+F on macOS, Ctrl+F 在别处)打开取景器自己的查找栏来搜索整个取景器的文本,包括尚未绘制的页面. 过 `find: "page"` 当页面只是查看器时,或 `find: false` 将快捷键留给浏览器并呼叫 `viewer.find(query)` 从你自己的控制.

音乐分数渲染包含在普通取景器API中. 导入 `@bdfkit/viewer/music` 只有在需要钢琴-卷曲渲染或回放时,所以不使用音乐的应用程序才能从他们的捆绑中省去代码.

见 [前端集成指南](https://github.com/shibukawa/bdf/blob/main/docs/integrating-to-frontend.md) 用于CSP,捆绑器,布局和转换示例.

## 许可证

麻省理工学院. 见 [自由主义](https://npmcn.com/package/%40bdfkit/viewer/LICENSE)。 。 。 .

## 常见问题

### @bdfkit/viewer 是什么？

用于滚动、页面布局、灯盒和可选音乐视图的文档表面

### 如何安装 @bdfkit/viewer？

在项目目录运行 npm install @bdfkit/viewer，或使用 pnpm add / yarn add / bun add。

### @bdfkit/viewer 支持 TypeScript 吗？

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

### @bdfkit/viewer 支持 ESM 还是 CommonJS？

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

### @bdfkit/viewer 可以商用吗？

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

### @bdfkit/viewer 的下载量有多少？

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

### @bdfkit/viewer 还在维护吗？

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