InkLayer 文档
InkLayer 是基于 PDF.js 构建的 PDF 批注 SDK，提供 React 和 Vue 双框架支持。文档覆盖从快速开始到 API 深度参考的全部内容，帮助你快速构建文档审阅、批注编辑与评论系统。
适合谁使用
InkLayer 适合你，如果你：
- 需要在 React 或 Vue 项目中集成 PDF 批注功能
- 希望跳过 PDF.js 底层细节，直接获得可用的批注能力
- 正在构建文档审阅、工程图纸标注、在线教育等需要 PDF 交互的产品
如果你正在从零构建 PDF 渲染引擎，或需要完全自定义的渲染管线，InkLayer 可能不适合你。
文档模块
| 模块 | 说明 |
|---|---|
| 快速开始 | 5 分钟快速上手，搭建第一个 PDF 批注应用。 |
| React 组件 | PdfAnnotator / PdfViewer 完整 Props、事件与用法示例。 |
| Vue 组件 | PdfAnnotator / PdfViewer Props、Events、Slots 与 Composables。 |
| 批注系统 | 14 种批注类型、数据模型、坐标系统与存储格式深入解析。 |
| Core API 参考 | Annotation Core、Adapter 接口、Integration 层完整 API 参考。 |
| 架构设计 | 分层架构、Adapter 模式、数据流与双框架共享核心的设计思路。 |
| 常见问题 | 安装、使用、性能优化等常见问题与排错指南。 |
版本信息
| 包名 | 版本 | 框架 | 底层引擎 |
|---|---|---|---|
inklayer-react | 1.0.2 | React 18+ | PDF.js 4.3+ / Konva 9.0 |
inklayer-vue | 1.0.2 | Vue 3.5+ | PDF.js 4.3+ / Konva 9.0 |
准备工作
开始使用 InkLayer 之前，确认你的环境满足以下条件：
- React 项目：React 18+、Node.js 18+
- Vue 项目：Vue 3.5+、Node.js 18+
- 了解 PDF.js 基础知识有助于理解内部渲染机制，但不是必需的。
准备好了？从「快速开始」进入第一个示例。→ 快速开始