{"_id":"z-board","_rev":"4-f091589729f93206c78da1cec845d05a","name":"z-board","dist-tags":{"latest":"0.0.94"},"versions":{"0.0.9":{"name":"z-board","version":"0.0.9","keywords":["whiteboard","screenshot"],"author":{"name":"Z"},"license":"MIT","_id":"z-board@0.0.9","maintainers":[{"name":"zenitsu99z","email":"2022095028@qq.com"}],"dist":{"shasum":"79ac7867b41933cd42b008fc7ff93150a6f0ad0c","tarball":"https://registry.npmjs.org/z-board/-/z-board-0.0.9.tgz","fileCount":7,"integrity":"sha512-+KAhwGaAiCl68tJYL0l5vgNc/dGtdp3zK+REKK08PMsikMSr5R3p5jd+4dX2TnLzGsuLFdVS7fbS+AH75EygEw==","signatures":[{"sig":"MEUCIQCeF1yfdaVtNg0bbK0hYxu5tjiNBGK+qLH9dHKK3KiJaAIgOW6MGi+IzXqAhwOqFuQGK6NlqSNahgoVtrJuhGaSE/s=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1891611},"main":"lib/z-board.cjs.js","type":"module","style":"lib/style.css","types":"lib/index.d.ts","module":"lib/z-board.es.js","exports":{".":{"import":{"types":"lib/index.d.ts","default":"lib/z-board.es.js"},"require":{"types":"lib/index.d.ts","default":"lib/z-board.cjs.js"}}},"gitHead":"d4d783a704b7857beb9ceb88fd00457dbc3c23d0","scripts":{"dev":"vite --host","build":"vite --config vite.lib.config.js build","preview":"vite preview","build:demo":"vite build"},"_npmUser":{"name":"zenitsu99z","email":"2022095028@qq.com"},"_npmVersion":"11.9.0","directories":{},"_nodeVersion":"24.14.0","dependencies":{"msg-alert":"^1.0.0-beta.3","typescript":"^5.4.5","js-web-screen-shot":"^1.9.9-rc.7"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^4.1.0","vite-plugin-dts":"^5.0.2"},"_npmOperationalInternal":{"tmp":"tmp/z-board_0.0.9_1780328421056_0.11773601030446379","host":"s3://npm-registry-packages-npm-production"}},"0.0.91":{"name":"z-board","version":"0.0.91","keywords":["whiteboard","screenshot"],"author":{"name":"Z"},"license":"MIT","_id":"z-board@0.0.91","maintainers":[{"name":"zenitsu99z","email":"2022095028@qq.com"}],"dist":{"shasum":"d9843ac0a2733f103412cd3a8c09d2170f83e211","tarball":"https://registry.npmjs.org/z-board/-/z-board-0.0.91.tgz","fileCount":24,"integrity":"sha512-jIGHeEabHtvmXd9CoclRzMws0ikabpVtwnl+2HxlYkt3ffhFz9YzCvi9SIK4V+7KZeWa0O4Xydywj0XrQMa7Sg==","signatures":[{"sig":"MEYCIQCpKcEu1d6Blc3ngvlsQLkrfSzS+mSQ8vdjFoUV/HANegIhAJYwFQKb9W8TT8N/YzbIg3EWhH3XNcpD+inN7T8eZEbP","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1906490},"main":"lib/z-board.cjs.js","type":"module","style":"lib/style.css","types":"lib/index.d.ts","module":"lib/z-board.es.js","exports":{".":{"import":{"types":"lib/index.d.ts","default":"lib/z-board.es.js"},"require":{"types":"lib/index.d.ts","default":"lib/z-board.cjs.js"}},"./style.css":"./lib/style.css","./lib/style.css":"./lib/style.css"},"gitHead":"d4d783a704b7857beb9ceb88fd00457dbc3c23d0","scripts":{"dev":"vite --host","build":"vite --config vite.lib.config.js build","preview":"vite preview","build:demo":"vite build"},"_npmUser":{"name":"zenitsu99z","email":"2022095028@qq.com"},"_npmVersion":"11.9.0","directories":{},"_nodeVersion":"24.14.0","dependencies":{"z-board":"^0.0.9","msg-alert":"^1.0.0-beta.3","typescript":"^5.4.5","js-web-screen-shot":"^1.9.9-rc.7"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^4.1.0","vite-plugin-dts":"^5.0.2"},"_npmOperationalInternal":{"tmp":"tmp/z-board_0.0.91_1780328684877_0.2390541660087675","host":"s3://npm-registry-packages-npm-production"}},"0.0.93":{"name":"z-board","version":"0.0.93","keywords":["whiteboard","screenshot"],"author":{"name":"Z"},"license":"MIT","_id":"z-board@0.0.93","maintainers":[{"name":"zenitsu99z","email":"2022095028@qq.com"}],"dist":{"shasum":"b95f2378b0d8d9119a5c6c091618462089181c3e","tarball":"https://registry.npmjs.org/z-board/-/z-board-0.0.93.tgz","fileCount":22,"integrity":"sha512-ltUTGTF26CGiiLMQndTNGx+8k6dtgJw9KPZ8n2jIDpr3XJU5xLmJryZL7zod9xxFcOgwfEK0mTUt4J5JCHSSSQ==","signatures":[{"sig":"MEYCIQD85jxs5gJcLn2TY4oEuMyG/31rz9JmEc3sjnrLfyg7KgIhAMlNpq5BacALyBifZSVX6Ydm0xqlfsP33rfXHOfA+f5l","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":648455},"main":"lib/z-board.cjs.js","type":"module","style":"lib/style.css","types":"lib/index.d.ts","module":"lib/z-board.es.js","exports":{".":{"import":{"types":"lib/index.d.ts","default":"lib/z-board.es.js"},"require":{"types":"lib/index.d.ts","default":"lib/z-board.cjs.js"}},"./style.css":"./lib/style.css","./lib/style.css":"./lib/style.css"},"gitHead":"d4d783a704b7857beb9ceb88fd00457dbc3c23d0","scripts":{"dev":"vite --host","build":"vite --config vite.lib.config.js build","preview":"vite preview","build:demo":"vite build"},"_npmUser":{"name":"zenitsu99z","email":"2022095028@qq.com"},"_npmVersion":"11.9.0","description":"一个轻量级、零依赖的网页画板与截图工具库，支持白板绘制和屏幕截图两大核心功能。","directories":{},"_nodeVersion":"24.14.0","dependencies":{"msg-alert":"^1.0.0-beta.3","typescript":"^5.4.5","js-web-screen-shot":"^1.9.9-rc.7"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^4.1.0","vite-plugin-dts":"^5.0.2"},"_npmOperationalInternal":{"tmp":"tmp/z-board_0.0.93_1780332179623_0.12174083877678243","host":"s3://npm-registry-packages-npm-production"}},"0.0.94":{"name":"z-board","version":"0.0.94","license":"MIT","author":{"name":"Z"},"type":"module","main":"lib/z-board.cjs.js","module":"lib/z-board.es.js","types":"lib/index.d.ts","style":"lib/style.css","exports":{".":{"import":{"types":"lib/index.d.ts","default":"lib/z-board.es.js"},"require":{"types":"lib/index.d.ts","default":"lib/z-board.cjs.js"}},"./lib/style.css":"./lib/style.css","./style.css":"./lib/style.css"},"scripts":{"dev":"vite --host","build":"vite --config vite.lib.config.js build","build:demo":"vitepress build docs && vite build --config docs/.vitepress/vite.demo.config.ts","preview":"vite preview","docs:dev":"vitepress dev docs","docs:build":"vitepress build docs && vite build --config docs/.vitepress/vite.demo.config.ts","docs:preview":"vitepress preview docs"},"keywords":["whiteboard","screenshot"],"dependencies":{"js-web-screen-shot":"^1.9.9-rc.7","msg-alert":"^1.0.0-beta.3","typescript":"^5.4.5","z-board":"^0.0.93"},"devDependencies":{"vite":"^4.1.0","vite-plugin-dts":"^5.0.2","vitepress":"^1.0.0"},"gitHead":"6b07a42e60f0fbc0cf8e3032bb2f6c4bab0f995c","_id":"z-board@0.0.94","description":"一个轻量级、零依赖的网页画板与截图工具库，支持白板绘制和屏幕截图两大核心功能。","_nodeVersion":"24.14.0","_npmVersion":"11.9.0","dist":{"integrity":"sha512-4qHv9qgAFkRHwgG5bxUGPzc4MxJEgVplEAaFUxVJO+M/T23m8lKZLeyT7kIMFEeHQ/HpuWKp9ut8n1OT25W64g==","shasum":"4c970f17a7ba6428fb3e3e431ddd7c3b91e3fcd5","tarball":"https://registry.npmjs.org/z-board/-/z-board-0.0.94.tgz","fileCount":22,"unpackedSize":650934,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIC2DBs3BC1kHrLZREuGcWX8rB2RZp6jxtD5IycJ1YUGpAiAqDsUJtgMAoHyX7/3d0eTep6Uvxyu+lo7RYqcGA9ieLQ=="}]},"_npmUser":{"name":"zenitsu99z","email":"2022095028@qq.com"},"directories":{},"maintainers":[{"name":"zenitsu99z","email":"2022095028@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/z-board_0.0.94_1782545272051_0.31712532909976665"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-01T15:40:20.980Z","modified":"2026-06-27T07:27:52.362Z","0.0.9":"2026-06-01T15:40:21.247Z","0.0.91":"2026-06-01T15:44:45.067Z","0.0.93":"2026-06-01T16:42:59.824Z","0.0.94":"2026-06-27T07:27:52.252Z"},"author":{"name":"Z"},"license":"MIT","keywords":["whiteboard","screenshot"],"description":"一个轻量级、零依赖的网页画板与截图工具库，支持白板绘制和屏幕截图两大核心功能。","maintainers":[{"name":"zenitsu99z","email":"2022095028@qq.com"}],"readme":"# 📋 Z-Board\r\n\r\n一个轻量级、零依赖的网页画板与截图工具库，支持白板绘制和屏幕截图两大核心功能。\r\n\r\n---\r\n\r\n## ✨ 特性\r\n\r\n- 🎨 **白板功能** - 支持画笔、文本框、橡皮擦、指针等多种绘图工具\r\n- 📸 **截图功能** - 灵活的屏幕截图能力\r\n- 📦 **零依赖** - 仅依赖原生 JavaScript，无额外捆绑\r\n- 🔰 **易于使用** - 简洁的 API 设计，快速集成\r\n- 🛡️ **类型安全** - 完整的 TypeScript 类型定义\r\n- 🌳 **轻量紧凑** - 打包体积小，性能优异\r\n\r\n---\r\n\r\n## 📦 安装\r\n\r\n```bash\r\nnpm install z-board\r\n```\r\n\r\n---\r\n\r\n## 🚀 快速开始\r\n\r\n### 方式一：ES Module（推荐）\r\n\r\n```typescript\r\nimport { initWhiteBoard, initScreenShot } from 'z-board'\r\nimport 'z-board/style.css'\r\n\r\n// 初始化白板\r\nconst whiteBoard = initWhiteBoard(document.getElementById('app'), {\r\n  addCanvasHistoryHandler: (data) => {\r\n    console.log('画板数据:', data)\r\n  }\r\n})\r\n\r\n// 或初始化截图\r\nconst screenShot = initScreenShot(document.getElementById('app'), {\r\n  successHandler: (base64) => {\r\n    console.log('截图成功:', base64)\r\n  }\r\n})\r\n```\r\n\r\n### 方式二：CommonJS\r\n\r\n```javascript\r\nconst { initWhiteBoard, initScreenShot } = require('z-board')\r\nrequire('z-board/style.css')\r\n```\r\n\r\n### 方式三：浏览器直接引入\r\n\r\n```html\r\n<script src=\"https://unpkg.com/z-board/lib/z-board.umd.cjs\"></script>\r\n<link rel=\"stylesheet\" href=\"https://unpkg.com/z-board/lib/style.css\">\r\n\r\n<script>\r\n  ZBoard.initWhiteBoard(document.getElementById('app'), {})\r\n</script>\r\n```\r\n\r\n---\r\n\r\n## 📖 API 文档\r\n\r\n### initWhiteBoard\r\n\r\n初始化白板功能。\r\n\r\n```typescript\r\ninitWhiteBoard(container: HTMLElement, options?: WhiteBoardOptions): WhiteBoardInstance\r\n```\r\n\r\n#### WhiteBoardOptions\r\n\r\n| 属性 | 类型 | 说明 |\r\n|------|------|------|\r\n| `addCanvasHistoryHandler` | `(data: CanvasHistoryItem) => void` | 画布历史变化回调 |\r\n\r\n#### 返回值\r\n\r\n返回白板实例，包含 `unmount()` 方法用于卸载。\r\n\r\n---\r\n\r\n### initScreenShot\r\n\r\n初始化截图功能。\r\n\r\n```typescript\r\ninitScreenShot(container: HTMLElement, options?: ScreenShotOptions): ScreenShotInstance\r\n```\r\n\r\n#### ScreenShotOptions\r\n\r\n| 属性 | 类型 | 说明 |\r\n|------|------|------|\r\n| `successHandler` | `(base64: string) => void` | 截图成功回调 |\r\n| `exitHandler` | `() => void` | 退出截图回调 |\r\n\r\n#### 返回值\r\n\r\n返回截图实例，包含 `unmount()` 方法用于卸载。\r\n\r\n---\r\n\r\n## 🛠️ 白板工具\r\n\r\n白板提供以下绘图工具：\r\n\r\n| 工具 | 说明 |\r\n|------|------|\r\n| ✏️ **画笔** | 自由绘制线条 |\r\n| 🔤 **文本** | 添加文本框 |\r\n| 🧹 **橡皮擦** | 擦除内容 |\r\n| 👆 **指针** | 选择和移动元素 |\r\n| ⬆️ **置顶** | 将选中元素移到最上层 |\r\n| ⬇️ **置底** | 将选中元素移到最后层 |\r\n| 💾 **导出** | 保存画板为图片 |\r\n\r\n---\r\n\r\n## 🔧 卸载\r\n\r\n```typescript\r\nimport { initWhiteBoard, initScreenShot, unmountWhiteBoard, unmountScreenShot } from 'z-board'\r\n\r\n// 方式一：通过实例卸载\r\nconst instance = initWhiteBoard(container, {})\r\ninstance.unmount()\r\n\r\n// 方式二：通过函数卸载\r\nunmountWhiteBoard()\r\nunmountScreenShot()\r\n```\r\n\r\n---\r\n\r\n## 📂 目录结构\r\n\r\n```\r\nz-board/\r\n├── lib/                    # 打包产物\r\n│   ├── z-board.es.js      # ES Module 格式\r\n│   ├── z-board.cjs.js     # CommonJS 格式\r\n│   ├── z-board.umd.cjs    # UMD 格式\r\n│   ├── index.d.ts         # 类型声明\r\n│   └── style.css          # 样式文件\r\n├── src/\r\n│   ├── modules/\r\n│   │   ├── common/        # 公共模块\r\n│   │   ├── screenshot/    # 截图功能\r\n│   │   └── whiteboard/     # 白板功能\r\n│   └── index.ts           # 入口文件\r\n└── CHANGELOG.md           # 更新日志\r\n```\r\n\r\n---\r\n\r\n## 📄 许可证\r\n\r\n[MIT License](LICENSE)\r\n","readmeFilename":"README.md"}