@nick_cn/image-masker
v1.5.1
Published
  
Readme
Image Masker
一个用于图片遮罩的工具组件。支持自由绘制、矩形、椭圆等多种遮罩方式,并提供撤销、重做等功能。
安装
npm install @nick_cn/image-masker示例
完整的示例代码可以在 GitHub 查看。
API
初始化选项
| 参数 | 类型 | 必填 | 描述 | | ------------- | ---------------- | ---- | -------------------------- | | parentElement | string | 是 | 容器元素的 ID | | image | HTMLImageElement | 是 | 要处理的图片实例 | | padding | string | 否 | 容器内边距,默认为'4px' | | background | string | 否 | 容器背景颜色,默认为'#000' |
实例属性
| 属性 | 类型 | 描述 | | --------- | -------------------------- | ----------------------------------------- | | mode | 'draw' | 'erase' | 设置操作模式:涂抹或擦除 | | shape | 'free' | 'rect' | 'oval' | 设置绘制形状:自由、矩形、椭圆 | | brushSize | number | 设置画笔大小,默认为 5 | | color | string | 设置画笔颜色,默认为 'rgba(255, 0, 0, 1)' |
实例方法
| 方法 | 返回值 | 描述 | | -------------------- | --------------------- | ------------------------ | | undo() | void | 撤销上一步操作 | | redo() | void | 重做上一步操作 | | maskLayerToDataURL() | Promise<string> | 获取遮罩层的图片数据 URL | | toDataURL() | Promise<string> | 获取处理后的图片数据 URL |
浏览器支持
- Chrome
- Firefox
- Safari
- Edge
许可证
MIT © nickw_cn
