@epam/ai-dial-react-pdf-highlighter

中文文档
0.3.3发布于 2026/11/18Apache-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 9951

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

中文使用文档
文档目录21 节
  1. 目录
  2. 要点
  3. 文档
  4. 快速启动
  5. 先决条件
  6. 安装
  7. 同伴依赖关系
  8. 基本用途
  9. 导出 API
  10. 构成部分
  11. 钩子
  12. 样式
  13. 发展
  14. 设置
  15. 质量检查
  16. 故事书
  17. 项目使用
  18. 下一个.js
  19. 捐款
  20. 警卫
  21. 许可证

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

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

部分 AI DIAL 生态系统。 。 。 .

npm version License: Apache 2.0

目录

要点

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

文档

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

npm run storybook

快速启动

先决条件

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

安装

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

同伴依赖关系

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

 pdfjs-dist 版本应满足 pdf - 高亮吻合要求。 。 。 .

基本用途

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 ,以避免在缓存中重排文件.

样式

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

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

发展

设置

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

有用命令 :

npm run dev
npm run storybook
npm run test:run
npm run test

质量检查

在打开公关前, 运行 :

npm run typecheck
npm run lint:check
npm run test:run

或者进行综合检查:

npm run verify:agent-hook

故事书

开发模式 :

npm run storybook

生产结构:

npm run build-storybook

项目使用

下一个.js

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

捐款

请读一下 贡献指南。 。 。 .

警卫

如果你发现有弱点,请读读我们 安全政策。 。 。 .

许可证

Apache 2.0 (英语) EPAM系统

版本与发布记录

@epam/ai-dial-react-pdf-highlighter 共发布 62 个版本,首次发布于 2026/04/09;过去 12 个月发布了 62 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.3latest2026/11/18今天
0.4.0-dev.6development2026/11/18今天
0.4.0-dev.42026/11/107 天前
0.3.22026/11/107 天前
0.3.12026/11/0512 天前
0.4.0-dev.32026/11/0512 天前

其他发布通道:next → 0.2.0-rc.6,development → 0.4.0-dev.6。

关于 @epam/ai-dial-react-pdf-highlighter 的常见问题

@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 和提交记录判断。