王创世 455b5af0d2 | ||
---|---|---|
.. | ||
components | ||
static | ||
changelog.md | ||
package.json | ||
readme.md |
readme.md
Clipper 图片裁剪
平台兼容
H5 | 微信小程序 | 支付宝小程序 | 百度小程序 | 头条小程序 | QQ 小程序 | App |
---|---|---|---|---|---|---|
√ | √ | √ | 未测 | √ | √ | √ |
安装
在市场导入**图片剪刀uni_modules**版本的即可,无需import
代码演示
基本用法
@success
事件点击 👉 确定 后会返回生成的图片信息,包含 url
、width
、height
<image :src="url" v-if="url" mode="widthFix"></image>
<l-clipper v-if="show" @success="url = $event.url; show = false" @cancel="show = false" />
<button @tap="show = true">裁剪</button>
export default {
data() {
return {
show: false,
url: '',
}
}
}
传入图片
image-url
可传入相对路径、临时路径、本地路径、网络图片
- 当为网络地址时
- H5:👉 需要解决跨域问题。
- 小程序:👉 需要配置 downloadFile 域名
<image :src="url" v-if="url" mode="widthFix"></image>
<l-clipper v-if="show" :image-url="imageUrl" @success="url = $event.url; show = false" @cancel="show = false" />
<button @tap="show = true">裁剪</button>
export default {
data() {
return {
imageUrl: 'https://img12.360buyimg.com/pop/s1180x940_jfs/t1/97205/26/1142/87801/5dbac55aEf795d962/48a4d7a63ff80b8b.jpg',
show: false,
url: '',
}
}
}
确定按钮颜色
样式变量名:--clipper_confirm_color
, nvue
无效, nvue
需要通过挂载全局样式表实现。
可放到全局样式的 page
里或节点的 style
<l-clipper class="clipper" style="--clipper_confirm_color: linear-gradient(to right, #ff6034, #ee0a24)" />
// css 中为组件设置 CSS 变量
.clipper {
--clipper_confirm_color: linear-gradient(to right, #ff6034, #ee0a24)
}
// 全局
page {
--clipper_confirm_color: linear-gradient(to right, #ff6034, #ee0a24)
}
使用插槽
共五个插槽 cancel
取消按钮、 photo
选择图片按钮、 rotate
旋转按钮、 confirm
确定按钮和默认插槽。
<image :src="url" v-if="url" mode="widthFix"></image>
<l-clipper
v-if="show"
:isLockWidth="isLockWidth"
:isLockHeight="isLockHeight"
:isLockRatio="isLockRatio"
:isLimitMove="isLimitMove"
:isDisableScale="isDisableScale"
:isDisableRotate="isDisableRotate"
:isShowCancelBtn="isShowCancelBtn"
:isShowPhotoBtn="isShowPhotoBtn"
:isShowRotateBtn="isShowRotateBtn"
:isShowConfirmBtn="isShowConfirmBtn"
@success="url = $event.url; show = false"
@cancel="show = false" >
<!-- 四个基本按钮插槽 -->
<view slot="cancel">取消</view>
<view slot="photo">选择图片</view>
<view slot="rotate">旋转</view>
<view slot="confirm">确定</view>
<!-- 默认插槽 -->
<view class="tools">
<view>显示取消按钮
<switch :checked="isShowCancelBtn" @change="isShowCancelBtn = $event.target.value" />
</view>
<view>显示选择图片按钮
<switch :checked="isShowPhotoBtn" @change="isShowPhotoBtn = $event.target.value" />
</view>
<view>显示旋转按钮
<switch :checked="isShowRotateBtn" @change="isShowRotateBtn = $event.target.value" />
</view>
<view>显示确定按钮
<switch :checked="isShowConfirmBtn" @change="isShowConfirmBtn = $event.target.value" />
</view>
<view>锁定裁剪框宽度
<switch :checked="isLockWidth" @change="isLockWidth = $event.target.value" />
</view>
<view>锁定裁剪框高度
<switch :checked="isLockHeight" @change="isLockHeight = $event.target.value" />
</view>
<view>锁定裁剪框比例
<switch :checked="isLockRatio" @change="isLockRatio = $event.target.value" />
</view>
<view>限制移动范围
<switch :checked="isLimitMove" @change="isLimitMove = $event.target.value" />
</view>
<view>禁止缩放
<switch :checked="isDisableScale" @change="isDisableScale = $event.target.value" />
</view>
<view>禁止旋转
<switch :checked="isDisableRotate" @change="isDisableRotate = $event.target.value" />
</view>
</view>
</l-clipper>
<button @tap="show = true">裁剪</button>
export default {
data() {
return {
show: false,
url: '',
isLockWidth: false,
isLockHeight: false,
isLockRatio: true,
isLimitMove: false,
isDisableScale: false,
isDisableRotate: false,
isShowCancelBtn: true,
isShowPhotoBtn: true,
isShowRotateBtn: true,
isShowConfirmBtn: true
}
}
}
查看示例
- 导入后直接使用这个标签查看演示效果
<!-- // 代码位于 uni_modules/lime-clipper/compoents/lime-clipper -->
<lime-clipper />
插件标签
- 默认 l-clipper 为 component
- 默认 lime-clipper 为 demo
API
Props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
image-url | 图片路径 | string | |
quality | 图片的质量,取值范围为 [0, 1],不在范围内时当作1处理 | number | 1 |
source | {album: '从相册中选择'} key为图片来源类型,value为选项说明 |
Object | |
width | 裁剪框宽度,单位为 rpx |
number | 400 |
height | 裁剪框高度 | number | 400 |
min-width | 裁剪框最小宽度 | number | 200 |
min-height | 裁剪框最小高度 | number | 200 |
max-width | 裁剪框最大宽度 | number | 600 |
max-height | 裁剪框最大宽度 | number | 600 |
min-ratio | 图片最小缩放比 | number | 0.5 |
max-ratio | 图片最大缩放比 | number | 2 |
rotate-angle | 旋转按钮每次旋转的角度 | number | 90 |
scale-ratio | 生成图片相对于裁剪框的比例, 比例越高生成图片越清晰 | number | 1 |
is-lock-width | 是否锁定裁剪框宽度 | boolean | false |
is-lock-height | 是否锁定裁剪框高度上 | boolean | false |
is-lock-ratio | 是否锁定裁剪框比例 | boolean | true |
is-disable-scale | 是否禁止缩放 | boolean | false |
is-disable-rotate | 是否禁止旋转 | boolean | false |
is-limit-move | 是否限制移动范围 | boolean | false |
is-show-photo-btn | 是否显示选择图片按钮 | boolean | true |
is-show-rotate-btn | 是否显示转按钮 | boolean | true |
is-show-confirm-btn | 是否显示确定按钮 | boolean | true |
is-show-cancel-btn | 是否显示关闭按钮 | boolean | true |
事件 Events
事件名 | 说明 | 回调 |
---|---|---|
success | 生成图片成功 | {width , height , url } |
fail | 生成图片失败 | error |
cancel | 关闭 | false |
ready | 图片加载完成 | {width , height , path , orientation , type } |
change | 图片大小改变时触发 | {width , height } |
rotate | 图片旋转时触发 | angle |
常见问题
- 1、H5端使用网络图片需要解决跨域问题。
- 2、小程序使用网络图片需要去公众平台增加下载白名单!二级域名也需要配!
- 3、H5端生成图片是base64,有时显示只有一半可以使用原生标签
<IMG/>
- 4、IOS APP 请勿使用HBX2.9.3.20201014的版本!这个版本无法生成图片。
- 5、APP端无成功反馈、也无失败反馈时,请更新基座和HBX。