{"id":18321634,"url":"https://github.com/bryanadamss/drawing-board","last_synced_at":"2025-04-05T22:32:27.343Z","repository":{"id":47972696,"uuid":"206568948","full_name":"BryanAdamss/drawing-board","owner":"BryanAdamss","description":"🎨 Javascript drawing board based on canvas","archived":false,"fork":false,"pushed_at":"2023-01-04T09:03:07.000Z","size":2053,"stargazers_count":15,"open_issues_count":17,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-17T20:56:27.402Z","etag":null,"topics":["canvas","draw","drawing-board","drawing-tablet"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BryanAdamss.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-05T13:20:12.000Z","updated_at":"2024-02-03T23:29:37.000Z","dependencies_parsed_at":"2023-02-02T06:16:26.897Z","dependency_job_id":null,"html_url":"https://github.com/BryanAdamss/drawing-board","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BryanAdamss%2Fdrawing-board","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BryanAdamss%2Fdrawing-board/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BryanAdamss%2Fdrawing-board/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BryanAdamss%2Fdrawing-board/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BryanAdamss","download_url":"https://codeload.github.com/BryanAdamss/drawing-board/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411234,"owners_count":20934650,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["canvas","draw","drawing-board","drawing-tablet"],"created_at":"2024-11-05T18:20:33.053Z","updated_at":"2025-04-05T22:32:26.744Z","avatar_url":"https://github.com/BryanAdamss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# drawing-board\n\n\u003e 🎨 Javascript drawing board based on canvas\n\n---\n\n![NPM](https://img.shields.io/npm/l/@bryanadamss/drawing-board)\n[![GitHub issues](https://img.shields.io/github/issues/BryanAdamss/drawing-board)](https://github.com/BryanAdamss/drawing-board/issues)\n\n## Links\n\n[https://github.com/BryanAdamss/drawing-board](https://github.com/BryanAdamss/drawing-board)\n\n## Install\n\n```javascript\nnpm i @bryanadamss/drawing-board\n```\n\nor\n\n```javascript\n\u003cscript src=\"https://unpkg.com/@bryanadamss/drawing-board@latest/dist/drawing-board.umd.js\"\u003e\u003c/script\u003e\n```\n\n## Example\n\n```html\n\u003cdiv id=\"board\"\u003e\u003c/div\u003e\n```\n\n```javascript\nimport DrawingBoard from '@bryanadamss/drawing-board'\n\nconst options = {\n  size: [400, 300],\n  penWidth: 10,\n}\n\nconst board = new DrawingBoard('#board', options)\n\nconst base64 = board.getDataUrl()\n\nboard.rotate()\nboard.download()\n```\n\n## Demos\n\n- https://github.com/BryanAdamss/drawing-board/tree/master/examples\n\nor\n\n- `clone` this `repo`\n- `npm i`\n- `npm run dev`\n- open `localhost:8080`\n\n## API\n\n`new DrawingBoard(selector,options)`\n\n- `selector` is **required**\n- `options`\n\n```javascript\n// 默认参数\ndefaultOptions = {\n  size: [], // canvas尺寸，默认[300,150]\n  className: '', // 自定义样式类\n\n  manualMount: false, // 手动挂载\n\n  maxRevokeSteps: 10, // 最大回退步数\n\n  interactiveMode: 'mouse', // 交互模式 enum:['mouse','touch','both'] ,both将同时绑定mouse、touch事件(PointerEvent存在兼容性问题，放弃使用)\n\n  penMode: 'empty', // 'paint' | 'drag' | 'empty' 画笔模式\n\n  penColor: 'red', // 画笔颜色\n  penWidth: 6, // 画笔粗细\n\n  bgImgURL: '', // 背景图url或base64\n  bgImgRotate: 0, // 背景图旋转角度\n  bgColor: '#fff', // 背景色\n\n  onRevokeStackChange: null, // 撤销栈改变时的回调\n  onPaintEnd: null, // 绘制一笔结束的回调\n\n  minScale: 1, // 最小缩放比例\n  maxScale: 3, // 最大缩放比例\n\n  initialScale: 1, // 初始缩放比例\n\n  scaleTransition: true, // 是否开启缩放动画\n  scaleStep: 0.1, // 缩放步进值\n}\n```\n\n- `methods`\n\n```typescript\n\n\n  /**\n   * 设置画笔样式(粗细、颜色)\n   *\n   * @param {PenStyle} { color, width } 样式\n   * @memberof DrawingBoard\n   */\n  setPenStyle({ color, width }: PenStyle): void {}\n\n  /**\n   * 设置canvas尺寸\n   *\n   * @param {number[]} [width, height] 宽高数组\n   * @memberof DrawingBoard\n   */\n  setSize([width, height]: number[]): void {}\n\n  /**\n   * 设置样式名\n   *\n   * @param {string} name 样式类字符串\n   * @memberof DrawingBoard\n   */\n  setClassName(name: string): void {}\n\n  /**\n   * 设置画笔模式为绘制模式\n   *\n   * @memberof DrawingBoard\n   */\n  setPenModePaint(): void {}\n\n  /**\n   * 设置画笔模式为拖拽模式\n   *\n   * @memberof DrawingBoard\n   */\n  setPenModeDrag(): void {}\n\n  /**\n   * 重置画笔模式为空\n   *\n   * @memberof DrawingBoard\n   */\n  setPenModeEmpty(): void {}\n\n  /**\n   * 设置缩放比例\n   *\n   * @param {*} scale 缩放比例\n   * @memberof DrawingBoard\n   */\n  setScale(scale: any): void {}\n\n  /**\n   * 挂载\n   * @returns void\n   */\n  mount(): void {}\n\n  /**\n   * 销毁\n   *\n   * @memberof DrawingBoard\n   */\n  destory(): void {}\n\n  /**\n   * 清空绘制\n   * @returns void\n   */\n  clear(): void {}\n\n  /**\n   * 旋转\n   *\n   * @param {number} [direction=1] 方向 1顺时针 -1逆时针\n   * @memberof DrawingBoard\n   */\n  rotate(direction = 1): void {}\n\n  /**\n   * 撤销\n   * @returns void\n   */\n  revoke(): void {}\n\n  /**\n   * 设置背景\n   *\n   * @param {(CanvasImageSource | string)} urlOrObject 需要绘制的图像对象(HTMLImageElement、SVGImageElement、HTMLVideoElement、HTMLCanvasElement、ImageBitmap、OffscreenCanvas)或图像url\n   * @param {number} originalWidth 原图像宽度。当无法从urlOrObject直接获取原始尺寸时需要手动提供原始尺寸\n   * @param {number} originalHeight 原图像高度\n   * @memberof DrawingBoard\n   */\n  setBgImg(\n    urlOrObject: CanvasImageSource | string,\n    originalWidth: number,\n    originalHeight: number\n  ): void {}\n\n  /**\n   * scale + scaleStep\n   *\n   * @memberof DrawingBoard\n   */\n  makeScaleAdd(): void {}\n\n  /**\n   * scale - scaleStep\n   *\n   * @memberof DrawingBoard\n   */\n  makeScaleSubtract(): void {}\n\n  /**\n   * 重置缩放比例、位置\n   *\n   * @memberof DrawingBoard\n   */\n  reset(): void {}\n\n  /**\n   * 获取当前画面的绘制次数\n   *\n   * @returns {number} 绘制次数\n   * @memberof DrawingBoard\n   */\n  getPaintCount(): number {}\n\n  /**\n   * 获取dataURL\n   *\n   * @param {IMG_TYPE} [type='png'] 图片类型\n   * @param {number} [compressRate=1] 压缩比率\n   * @returns dataURL\n   * @memberof DrawingBoard\n   */\n  getDataUrl(type: IMG_TYPE = 'png', compressRate = 1): string {}\n\n  /**\n   * 获取Blob\n   *\n   * @param {IMG_TYPE} [type='png'] 图片类型\n   * @param {number} [compressRate=1] 压缩比率\n   * @returns {Promise\u003cBlob\u003e} 返回blob\n   * @memberof DrawingBoard\n   */\n  getBlob(type: IMG_TYPE = 'png', compressRate = 1): Promise\u003cBlob\u003e {}\n\n  /**\n   * 获取File\n   *\n   * @param {string} [name='drawingBoard'] 图片名称\n   * @param {IMG_TYPE} [type='png'] 图片类型\n   * @param {number} [compressRate=1] 压缩比率\n   * @returns {(Promise\u003cFile | IeCompatibleBlob\u003e)} 返回FIle或IeCompatibleBlob\n   * @memberof DrawingBoard\n   */\n  getFile(\n    name = 'drawingBoard',\n    type: IMG_TYPE = 'png',\n    compressRate = 1\n  ): Promise\u003cFile | IeCompatibleBlob\u003e {}\n\n  /**\n   * 下载图片\n   *\n   * @param {IMG_TYPE} [type='png'] 图片类型\n   * @param {number} [compressRate=1] 压缩比率，默认原图输出\n   * @param {string} [name='drawing-board'] 图片名称\n   * @memberof DrawingBoard\n   */\n  download(\n    type: IMG_TYPE = 'png',\n    compressRate = 1,\n    name = 'drawing-board'\n  ): void {}\n```\n\n## Changelog\n\n[changelog](https://github.com/BryanAdamss/drawing-board/blob/master/CHANGELOG.md)\n\nDetailed changes for each release are documented in the [release notes](https://github.com/BryanAdamss/drawing-board/releases).\n\n## License\n\n[MIT](https://opensource.org/licenses/MIT)\n\nCopyright (c) 2019-present, bryanadamss GuangHui.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryanadamss%2Fdrawing-board","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryanadamss%2Fdrawing-board","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryanadamss%2Fdrawing-board/lists"}