@epam/ai-dial-resact-pdf-高亮点
AI DIAL 反应 PDF Highlighter是一个用于PDF取景和要闻的React组件库. 它建立在顶端 @ epam/pdf- highlighter- kit 和用途 @epam/ai-dial-ui-kit (英语) 样式和组件.
部分 AI DIAL 生态系统。 。 。 .
目录
要点
- 用于 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-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 - 高亮吻合要求。 。 。 .
基本用途
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系统