1.0.0 • Published 1 year ago

zyong-utils v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

zyong-utils组件库(说明)

仅支持vue3,typescript

  • 直接npm install zyong-utils@latest --save或者yarn add zyong-utils@latest --save

GitHub package.json version

一、电子签名组件

组件电子签名感谢大神原作者JaimeCheng提供源码支持:

点击此处查看原作出处

功能

  1. 兼容 PC 和 Mobile;
  2. 画布自适应屏幕大小变化(窗口缩放、屏幕旋转时画布无需重置,自动校正坐标);
  3. 自定义画布尺寸(导出图尺寸),画笔粗细、颜色,画布背景色;
  4. 支持裁剪 (针对需求:有的签字需要裁剪掉四周空白)。
  5. 导出图片格式为 base64

安装

npm install zyong-utils --save

使用

  1. 全局使用 、局部
//全局
import { createApp } from 'vue'
import App from './App.vue'
import Utils from 'zyong-utils'
const app = createApp(App)
app.use(Utils)
// 局部
import {ViteSign} from 'zyong-utils'
components: { ViteSign }
  1. 页面中使用 设置 ref ,用来调用组件的两个内置方法 reset()generate()

    无需给组件设置 style 的宽高,如果画布的 width属性值没超出父元素的样式宽度,则该组件的样式宽度就是画布宽度,超出的话,组件样式宽度则是父元素的100%; 所以只需设置好父元素的宽度即可;

<vue-esign ref="esign" :width="800" :height="300" :isCrop="isCrop" :lineWidth="lineWidth" :lineColor="lineColor" v-model:bgColor="bgColor" />

<button @click="handleReset">清空画板</button>
<button @click="handleGenerate">生成图片</button>
const lineWidth = ref(6);
const lineColor = ref("#000000");
const bgColor = ref("");
const resultImg = ref("");
const isCrop = ref(false);
const sign = ref();
const handleReset = () => {
  sign?.value.reset();
};
const handleGenerate = () => {
  sign.value
    .generate()
    .then((res: string) => {
      resultImg.value = res;
    })
    .catch((err: any) => {
      console.warn(err);
    });
};
  1. 说明
属性类型默认值说明
widthNumber800画布宽度,即导出图片的宽度
heightNumber300画布高度,即导出图片的高度
lineWidth4Number画笔粗细
lineColorString#000000画笔颜色
bgColorString画布背景色,为空时画布背景透明,支持多种格式 '#ccc','#E5A1A1','rgb(229, 161, 161)','rgba(0,0,0,.6)','red'
isCropBooleanfalse是否裁剪,在画布设定尺寸基础上裁掉四周空白部分
isClearBgColorBooleantrue清空画布时(reset)是否同时清空设置的背景色(bgColor)
formatStringimage/png生成图片格式 image/jpeg(jpg格式下生成的图片透明背景会变黑色请慎用或指定背景色)、 image/webp
qualityNumber1生成图片质量;在指定图片格式为 image/jpeg 或 image/webp的情况下,可以从 0 到 1 的区间内选择图片的质量。如果超出取值范围,将会使用默认值 0.92。其他参数会被忽略。

两个内置方法,通过给组件设置 ref 调用:

清空画布

sign.value?.reset()

生成图片

// 可选配置参数 ,在未设置format或quality属性时可在生成图片时配置 例如: {format:'image/jpeg', quality: 0.5}
// this.$refs.esign.generate({format:'image/jpeg', quality: 0.5})

sign.value?.generate().then(res => {
  console.log(res) // base64图片
}).catch(err => {
  console.warn(err) // 画布没有签字时会执行这里 'Not Signned'
})

二、其他组件持续更新中...