1.0.4 • Published 1 year ago

clipper-image v1.0.4

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

裁剪图片

clipperjs是一款非常强大却又简单的图片裁剪工具,它可以进行非常灵活的配置,支持手机端使用(关键是使用方法简单,几行代码就可以搞定)

演示示例

演示地址

PC端演示

npm.io

手机端演示

npm.io

特色功能

  • 同时对移动端pc端的支持
  • 支持commonjs、esmoudle和cdn的方式引入
  • 使用简单、傻瓜式操作

快速开始

安装

npm install clipper-image --save

引入

 import Clipper from 'clipper-image'

提示:也支持<script src="clipper-image.iife.js"></script>的方式引入

用法

添加1html容器

注意: 容器需要设置宽度和高度,容器的宽度作为滑块验证码的宽度

<div class="clipper" style="width: 800px; height: 480px;"></div>

创建控件

pc端推荐配置

const clipper = new Clipper({
	el: '.clipper'
})

clipper.setImgFile(file)

> 移动端推荐配置
```js
const clipper = new Clipper({
	el: '.clipper',
	clipRect: {
		size: [0.8, 0.8],
		position: 'center',
		visible: true,
		isCanHidden: false, // 是否支持隐藏
		isCanResize: false, // 是否可以更改尺寸大小
		isCanPosition: false // 是否可以改变位置
	}
})

clipper.setImgFile(file)

配置项

名称类型默认值必传说明
elstring | element控件容器
onChangefunction当裁剪位置(大小)发生变化时的回调 (参数1:裁剪图片的blob对象)
clipRect.sizeArray0.5, 0.5裁剪区域初始化时默认大小;0.5, 0.1 横向宽度为父元素的1/2, 纵向宽度为父元素的 1/10; '50px', '60px' 横向宽度为50像素, 纵向宽度为 60像素;
clipRect.visiblebooleanfalse裁剪区域初始化时是否隐藏
clipRect.positionArray | 'center''center'裁剪区域初始化时默认位置;0.5, 0.1 距离左边1/2, 距离顶部 1/10; '50px', '60px' 距离左边50像素, 距离顶部 60像素; center 自动计算后居中
clipRect.isCanHiddenbooleantrue裁剪区域是否可以隐藏
clipRect.isCanResizebooleantrue裁剪区域是否可以自定义设置大小
clipRect.isCanPositionbooleantrue裁剪区域是否可以改变位置

方法

方法名返回值示例描述
setImgFilePromisesetImgFile.reset(blob)设置要裁剪的图片; blob为图片对象
getClipImagePromiseclipper.getClipImage()获取裁剪区域的blob对象
initclipper.init()销毁控件后可以调用init方法重新显示裁剪画布
destoryclipper.destory()销毁控件