inklayer-vue

v1.2.3

Published

10 days ago

PDF viewer and annotation SDK for Vue 3 applications, with comments, collaborative permissions, and PDF/Excel export.

⭐ 快速开始（推荐）

最快体验 InkLayer Vue 的方式：直接使用官方 Starter 🚀

git clone https://github.com/Laomai-codefee/inklayer-vue-starter.git
cd inklayer-vue-starter
npm install
npm run dev

打开：

http://localhost:5173

💡 Starter 已内置完整 PDF 批注能力示例，无需额外配置即可体验 SDK 全功能。

✨ 特性

🚀 PDF 查看器（缩略图 / 目录 / 缩放 / 搜索 / 主题）
🖍️ PDF 批注系统（高亮 / 笔迹 / 图形 / 印章 / 签名）
💬 评论与审阅流程
🔗 批注引用与跨页导航（# 引用 / 悬停预览 / 点击跳转）
🔐 协作批注权限（拥有者规则 / 管理员覆盖 / 整体只读）
💾 批注数据模型（可持久化）
📤 导出能力（PDF / Excel）
🎨 可自定义 UI（工具栏 / 侧边栏）

📣 最新动态

🔥 1.2.2

优化批注交互：Sidebar 与 PDF 仅在选中时联动，Canvas 悬停保留作者标签并移除干扰边框
修复自动缩放下的批注跳转、侧边栏编辑器遮挡，以及切换用户或权限后的菜单定位
改进 PDF / Excel 导出编号，主批注使用“作者 · #N”，Excel 使用稳定的 #N / #N.1
批注类型过滤支持本地化并保留筛选状态，完善协作权限与只读体验

🔥 1.2.1

删除批注或回复后，可在提示消失前一键恢复
修复批注选择状态与颜色选择器的返回、布局及计时交互
优化作者标签碰撞、拖拽更新和悬停预览层级

🔥 1.2.0

在批注内容和回复中使用 # 引用其他批注
悬停引用，预览目标批注、选中文字、作者、页码和回复
点击引用，在侧边栏与 PDF 批注之间快速定位，支持跨页跳转
优化批注选择、编辑器焦点和悬停交互

📦 安装

npm install inklayer-vue

🚀 基础用法

1. 插件注册（必须）

import { createApp } from 'vue'
import { inklayerVuePlugin } from 'inklayer-vue'
import App from './App.vue'

const app = createApp(App)
app.use(inklayerVuePlugin)
app.mount('#app')

2. PdfAnnotator（批注）

<script setup>
import { PdfAnnotator } from 'inklayer-vue'
import 'inklayer-vue/style'

const handleSave = (annotations) => {
  console.log('Saved annotations:', annotations)
}
</script>

<template>
  <PdfAnnotator
    title="PDF Annotator"
    url="https://example.com/sample.pdf"
    :user="{ id: 'u1', name: 'Alice' }"
    @save="handleSave"
  />
</template>

3. PdfViewer（查看器）

<script setup>
import { PdfViewer } from 'inklayer-vue'
import 'inklayer-vue/style'
</script>

<template>
  <PdfViewer
    title="PDF Viewer"
    url="https://example.com/sample.pdf"
  />
</template>

📖 API 文档

👉 https://inklayer.dev/zh-cn/docs/vue

🔐 协作批注权限

user 是调用方传入的当前业务用户。InkLayer 只使用该身份判断批注与回复的归属，不负责用户登录或身份认证，也不要求额外传入 role。启用 owner-only 后，具有有效 user.id 的当前用户可以新建批注和回复，但只有批注拥有者可移动、缩放、编辑、修改状态或删除该批注；回复也只能由其作者编辑或删除。

<PdfAnnotator
  :user="currentUser"
  :annotation-permissions="{
    mode: 'owner-only',
    // isAdmin 由你的业务系统实现
    can: ({ currentUser }) =>
      isAdmin(currentUser?.id) ? true : undefined
  }"
/>

can(request) 是可选的同步覆盖函数。返回 true 强制允许，false 强制拒绝，undefined 保留 mode 的默认结果。request 包含 action、currentUser、annotation、comment 和 defaultAllowed，因此可以接入应用自己的管理员、审批状态或文档级规则。

如果需要整个批注器只读，传入 :annotation-permissions="{ can: () => false }"。用户仍可选中和查看批注，但所有写操作都会被禁止。

这是浏览器交互权限，用于控制 InkLayer UI 和本地写入。后端 API 仍必须独立验证读写权限，不能把客户端结果当作安全边界。

🔗 相关项目

InkLayer React：https://github.com/Laomai-codefee/inklayer-react
Vue Starter：https://github.com/Laomai-codefee/inklayer-vue-starter
React Starter：https://github.com/Laomai-codefee/inklayer-react-starter

💬 社区与商业支持

InkLayer 基础 SDK 采用 MIT 协议，可以免费用于个人和商业项目。

社区支持

使用交流与功能建议：GitHub Discussions
Bug 报告：GitHub Issues
项目文档：https://inklayer.dev/zh-cn/docs/vue

社区支持按项目维护者的时间尽力提供，不承诺响应时间。

商业技术支持

如果你的项目需要以下服务，可以联系项目维护者：

React / Vue 项目接入与问题排查
批注数据持久化和业务系统对接
用户、角色及流程权限接入
功能定制和其他框架适配
私有项目的持续维护与优先响应

邮件：[email protected]

来信建议说明项目场景、技术栈、所需功能和计划时间。

🌐 运行环境

InkLayer Vue 仅支持浏览器环境，不支持 SSR（服务端渲染）。请在客户端入口或仅客户端组件中加载它。

Vue 3.5+
Vite 5+ 或 Webpack 5
ESM 与 CommonJS 包入口
npm、pnpm 等标准包管理器；项目依赖均由包自身声明

在 Nuxt 等 SSR 框架中使用时，请关闭该组件的服务端渲染，并确保样式与组件只在客户端导入。