# @epam/ai-dial-react-pdf-highlighter 中文文档

规范地址：https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/

版本：0\.3\.3
npm 元数据更新时间：2026-11-17T19:39:52.313Z
中文译文更新时间：2026-11-17T19:41:07.513Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40epam/ai-dial-react-pdf-highlighter
原文对照：https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/?lang=original
项目主页：https://github.com/epam/ai-dial-react-pdf-highlighter#readme
源码仓库：https://github.com/epam/ai-dial-react-pdf-highlighter

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

- 包体积（解压后）：76.3 kB，21 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.2\.0
- 运行依赖：0 个
- peer 依赖：react \>=19\.2\.5，react-dom \>=19\.2\.5，pdfjs-dist ^6\.2\.108，@tabler/icons-react ^3\.44\.0，@epam/ai-dial-ui-kit \>=0\.15\.0-0 \|\| \>=0\.16\.0-0，@epam/pdf-highlighter-kit ^0\.0\.23
- 首次发布：2026-04-09T14:25:59.372Z
- 最新版本发布：2026-11-17T19:39:51.990Z
- 近 30 天下载量：9951（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：62（近 12 个月 62 个）

## 中文简介

以 @epam/pdf- highlighter- kit 为基础的 PDF 查看和突出显示的响应组件

## 安装

```sh
npm install @epam/ai-dial-react-pdf-highlighter
```

也可以使用：`pnpm add @epam/ai-dial-react-pdf-highlighter`、`yarn add @epam/ai-dial-react-pdf-highlighter`、`bun add @epam/ai-dial-react-pdf-highlighter`

## README

# @epam/ai-dial-resact-pdf-高亮点

AI DIAL 反应 PDF Highlighter是一个用于PDF取景和要闻的React组件库. 它建立在顶端 [@ epam/pdf- highlighter- kit](https://github.com/epam/pdf-highlighter-kit) 和用途 [@epam/ai-dial-ui-kit (英语)](https://github.com/epam/ai-dial-ui-kit) 样式和组件.

部分 [AI DIAL 生态系统](https://github.com/epam/ai-dial)。 。 。 .

[![npm version](https://badge.fury.io/js/@epam%2Fai-dial-react-pdf-highlighter.svg)](https://badge.fury.io/js/@epam%2Fai-dial-react-pdf-highlighter) [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

## 目录

-   [要点](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-highlights)
-   [文档](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-documentation)
-   [快速启动](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-quick-start)
    -   [先决条件](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-prerequisites)
    -   [安装](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-installation)
    -   [同伴依赖关系](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-peer-dependencies)
    -   [基本用途](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-basic-usage)
-   [导出 API](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-exported-api)
-   [样式](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-styles)
-   [发展](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-development)
    -   [设置](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-setup)
    -   [质量检查](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-quality-checks)
-   [故事书](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-storybook)
-   [项目使用](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-usage-in-projects)
    -   [下一个.js](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-nextjs)
-   [捐款](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-contributing)
-   [警卫](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-security)
-   [许可证](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/#readme-license)

## 要点

-   用于 PDF 查看、缩略图和亮点的反应组件
-   高级API 超过 pdf- highlighter- kit
-   以类型脚本和严格打字方式建造
-   故事本 + Vitest 测试设置
-   准备作为 npm 软件包发布和消费

## 文档

您可以在本地开发期间探索故事书中的组件.

```bash
npm run storybook
```

## 快速启动

### 先决条件

-   节点.js >= 22.2.0
-   时间:

### 安装

```bash
npm install @epam/ai-dial-react-pdf-highlighter
```

### 同伴依赖关系

| 类型 | 软件包 | 无 | 雅伦 |
| --- | --- | --- | --- |
| 需求 | `react`, (中文(简体) ), `react-dom`, (中文(简体) ), `@epam/pdf-highlighter-kit`, (中文(简体) ), `@epam/ai-dial-ui-kit`, (中文(简体) ), `pdfjs-dist` | `npm install react react-dom @epam/pdf-highlighter-kit @epam/ai-dial-ui-kit pdfjs-dist` | `yarn add react react-dom @epam/pdf-highlighter-kit @epam/ai-dial-ui-kit pdfjs-dist` |
| 可选(适用于 `DocumentPreview`(中文(简体) ) | `@tabler/icons-react` | `npm install @tabler/icons-react` | `yarn add @tabler/icons-react` |

 `pdfjs-dist` 版本应满足 [pdf - 高亮吻合要求](https://github.com/epam/pdf-highlighter-kit?tab=readme-ov-file#requirements)。 。 。 .

### 基本用途

```tsx
import {
  DocumentPreview,
  DocumentPreviewCacheProvider,
} from '@epam/ai-dial-react-pdf-highlighter';
import '@epam/ai-dial-ui-kit/styles.css';
import '@epam/ai-dial-react-pdf-highlighter/styles.css';

function App() {
  return (
    <DocumentPreviewCacheProvider>
      <DocumentPreview
        fileUrl="https://example.com/document.pdf"
        loadFileCb={(url) => fetch(url).then((response) => response.blob())}
        highlights={[]}
      />
    </DocumentPreviewCacheProvider>
  );
}
```

## 导出 API

### 构成部分

| 名称 | 说明 |
| --- | --- |
| `PDFViewer` | 低级 PDF 查看器组件包 `@epam/pdf-highlighter-kit`接受 `PdfViewerProps`。 。 。 . |
| `DocumentPreview` | 带有内置加载,缩放,突出导航,缩略图支持的高层次文档预览. 接受 `DocumentPreviewProps`。 。 。 . |
| `DocumentPreviewCacheProvider` | 允许跨组件共享已装入的 PDF blobs 的上下文提供者 。 将您的应用( 或子树) 围起来, 以避免重勾相同的文件 . |
| `PdfPreviewLoader` | 内部使用的独立加载/错误状态覆盖 `DocumentPreview`接受 `PdfPreviewLoaderProps`。 。 。 . |
| `PageThumbnail` | 将一个 PDF 单页作为缩略图图像 。 接受 `PageThumbnailProps`。 。 。 . |

### 钩子

#### `useDocumentPreview(options: UseDocumentPreviewOptions): UseDocumentPreviewResult`

包含文档预览的全部逻辑:文件取取(带有可选缓存集成),突起-索引导航,缩放状态,和缩略图生成. 使用它来构建一个完全自定义的预览 UI, 而无需接受 `DocumentPreview`默认布局 .

#### `useDocumentPreviewCache(): DocumentPreviewCacheContext | null`

返回提供的文档预览缓存上下文 `DocumentPreviewCacheProvider`. 回归 `null` 当召出供养者之外。 内部使用 `useDocumentPreview` ,以避免在缓存中重排文件.

## 样式

导入应用程序条目中的两个样式表 :

```ts
import '@epam/ai-dial-ui-kit/styles.css';
import '@epam/ai-dial-react-pdf-highlighter/styles.css';
```

## 发展

### 设置

```bash
git clone https://github.com/epam/ai-dial-react-pdf-highlighter.git
cd ai-dial-react-pdf-highlighter
npm install
```

有用命令 :

```bash
npm run dev
npm run storybook
npm run test:run
npm run test
```

### 质量检查

在打开公关前, 运行 :

```bash
npm run typecheck
npm run lint:check
npm run test:run
```

或者进行综合检查:

```bash
npm run verify:agent-hook
```

## 故事书

开发模式 :

```bash
npm run storybook
```

生产结构:

```bash
npm run build-storybook
```

## 项目使用

### 下一个.js

在某些情况下,与PDF相關的UI只在客户端有动态导入. 如果您碰到了 SSR 问题, 请加载查看器组件 `next/dynamic` 财务报告和审定财务报表 `ssr: false`。 。 。 .

## 捐款

请读一下 [贡献指南](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/CONTRIBUTING.md)。 。 。 .

## 警卫

如果你发现有弱点,请读读我们 [安全政策](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/SECURITY.md)。 。 。 .

## 许可证

[Apache 2.0 (英语)](https://npmcn.com/package/%40epam/ai-dial-react-pdf-highlighter/LICENSE) EPAM系统

## 常见问题

### @epam/ai-dial-react-pdf-highlighter 是什么？

以 @epam/pdf- highlighter- kit 为基础的 PDF 查看和突出显示的响应组件

### 如何安装 @epam/ai-dial-react-pdf-highlighter？

在项目目录运行 npm install @epam/ai-dial-react-pdf-highlighter，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19\.2\.5）、react-dom（\>=19\.2\.5）、pdfjs-dist（^6\.2\.108）、@epam/ai-dial-ui-kit（\>=0\.15\.0-0 \|\| \>=0\.16\.0-0）、@epam/pdf-highlighter-kit（^0\.0\.23）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @epam/ai-dial-react-pdf-highlighter 支持 TypeScript 吗？

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

### @epam/ai-dial-react-pdf-highlighter 支持 ESM 还是 CommonJS？

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

### @epam/ai-dial-react-pdf-highlighter 需要什么版本的 Node\.js？

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

### @epam/ai-dial-react-pdf-highlighter 可以商用吗？

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

### @epam/ai-dial-react-pdf-highlighter 的下载量有多少？

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

### @epam/ai-dial-react-pdf-highlighter 还在维护吗？

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

