# @embedpdf/plugin-outline 中文文档

规范地址：https://npmcn.com/package/%40embedpdf/plugin-outline/

版本：3\.2\.0
npm 元数据更新时间：2026-11-11T23:29:48.903Z
中文译文更新时间：2026-11-13T15:13:25.275Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40embedpdf/plugin-outline
原文对照：https://npmcn.com/package/%40embedpdf/plugin-outline/?lang=original
项目主页：https://github.com/embedpdf/embed-pdf-viewer#readme
源码仓库：https://github.com/embedpdf/embed-pdf-viewer

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

- 包体积（解压后）：216 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2026-10-25T17:21:49.735Z
- 最新版本发布：2026-11-11T23:29:48.723Z
- 近 30 天下载量：8969（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

EmbedPDF的大纲:将文档的书签作为树来显示,跟随,并添加,重命名,移动和删除.

## 安装

```sh
npm install @embedpdf/plugin-outline
```

也可以使用：`pnpm add @embedpdf/plugin-outline`、`yarn add @embedpdf/plugin-outline`、`bun add @embedpdf/plugin-outline`

## README

# @embedpdf/ 插图出行

EmbedPDF的大纲:将文档的书签作为树来显示,跟随,并添加,重命名,移动和删除.

此插件与每个 EmbedPDF 框架包相伴而来 。 从您使用的那个导入 :

| 框架 | 从 | 文档 |
| :-- | :-- | :-- |
| 反应 | `@embedpdf/react/outline` | [大纲](https://www.embedpdf.com/docs/headless/react/documents/outline) |
| 阴道 | `@embedpdf/vue/outline` | [大纲](https://www.embedpdf.com/docs/headless/vue/documents/outline) |
| 丝绒 | `@embedpdf/svelte/outline` | [大纲](https://www.embedpdf.com/docs/headless/svelte/documents/outline) |
| 角质 | `@embedpdf/angular/outline` | [大纲](https://www.embedpdf.com/docs/headless/angular/documents/outline) |

## 在反应中

文件的大纲是其目录:标题:项目,嵌入,每件都到 文档。 Acrobat称物品为书签. 登记册 `outlinePlugin()` 在你的UI中显示它:

**`outline-list.tsx`**

```tsx
import { useOutline, useOutlineState } from '@embedpdf/react/outline';

export function OutlineList() {
  const outline = useOutline();
  const { rows, current } = useOutlineState();

  return (
    <ul role="tree">
      {rows.map(({ item, depth, hasChildren, expanded }) => (
        <li
          key={item.ref.objectNumber}
          role="treeitem"
          aria-level={depth + 1}
          aria-expanded={hasChildren ? expanded : undefined}
          aria-current={item.ref.objectNumber === current?.objectNumber ? 'location' : undefined}
          style={{ paddingInlineStart: depth * 16 }}
        >
          {hasChildren && (
            <button onClick={() => outline.toggle(item.ref)}>{expanded ? '▾' : '▸'}</button>
          )}
          <button onClick={() => outline.activate(item.ref)}>{item.title}</button>
        </li>
      ))}
    </ul>
  );
}
```

什麽 `useOutlineState()` 自己给您更新:在您自己修改后,并共享 文档,在别人的。 文档打开时不读: 大纲加载第一个 时间有需要,所以一个文件 没有人显示成本的概要.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @embedpdf/plugin-outline 是什么？

EmbedPDF的大纲:将文档的书签作为树来显示,跟随,并添加,重命名,移动和删除\.

### 如何安装 @embedpdf/plugin-outline？

在项目目录运行 npm install @embedpdf/plugin-outline，或使用 pnpm add / yarn add / bun add。

### @embedpdf/plugin-outline 支持 TypeScript 吗？

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

### @embedpdf/plugin-outline 支持 ESM 还是 CommonJS？

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

### @embedpdf/plugin-outline 可以商用吗？

@embedpdf/plugin-outline 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @embedpdf/plugin-outline 的下载量有多少？

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

### @embedpdf/plugin-outline 还在维护吗？

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