# @embedpdf/plugin-shell 中文文档

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

版本：3\.2\.0
npm 元数据更新时间：2026-11-11T23:25:40.602Z
中文译文更新时间：2026-11-13T14:53:13.643Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：71.9 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-08-05T21:41:40.281Z
- 最新版本发布：2026-11-11T23:25:40.418Z
- 近 30 天下载量：65587（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 27 个）

## 中文简介

EmbedPDF的面板和菜单:跟踪哪些面板,对话框和菜单是打开的.

## 安装

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

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

## README

# @embedpdf/plugin-shell (英语)

EmbedPDF的面板和菜单:跟踪哪些面板,对话框和菜单是打开的.

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

| 框架 | 从 | 文档 |
| :-- | :-- | :-- |
| 反应 | `@embedpdf/react/shell` | [面板对话框( A)](https://www.embedpdf.com/docs/headless/react/ui/panels) |
| 阴道 | `@embedpdf/vue/shell` | [面板对话框( A)](https://www.embedpdf.com/docs/headless/vue/ui/panels) |
| 丝绒 | `@embedpdf/svelte/shell` | [面板对话框( A)](https://www.embedpdf.com/docs/headless/svelte/ui/panels) |
| 角质 | `@embedpdf/angular/shell` | [面板对话框( A)](https://www.embedpdf.com/docs/headless/angular/ui/panels) |

## 在反应中

查看器有侧边栏(t,注释,搜索),对话框和菜单. shell 插件保持跟踪 打开的,所以工具栏按钮、键盘快捷键和你自己的代码都可以打开相同的 面板,您可以记住下次的布局。 您绘制面板; 插件只持有 状态。 登记册 `shellPlugin()`数字 :

**`shell-plugin.tsx`**

```tsx
import { shellPlugin } from '@embedpdf/react/shell';

export const plugins = [/* … */ shellPlugin()];
```

然后要求一个面板的名字:

**`comments-panel.tsx`**

```tsx
import { useSurface } from '@embedpdf/react/shell';
import { CommentList } from './comment-list';

export function CommentsPanel() {
  const panel = useSurface('comments');
  if (!panel.isOpen) return null;

  return (
    <aside>
      <button onClick={panel.close}>Close</button>
      <CommentList />
    </aside>
  );
}

export function CommentsButton() {
  const panel = useSurface('comments');
  return <button onClick={() => panel.toggle({ exclusive: 'right' })}>Comments</button>;
}
```

名字是你们的: `'comments'`, (中文(简体) ), `'thumbnails'`, (中文(简体) ), `'settings'`。每个文件都保留自己的文件,所以 选项卡会记住哪些面板是打开的.

## 许可证

阿帕奇 - 2.0

## 常见问题

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

EmbedPDF的面板和菜单:跟踪哪些面板,对话框和菜单是打开的\.

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

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

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

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

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

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

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

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

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

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

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

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