|
4 | 4 |
|
5 | 5 | ## 基本用法 |
6 | 6 |
|
7 | | -图片裁剪组件需要绑定 `v-model` 来控制组件的显示与隐藏,通过属性 `img-src` 控制展示的图片资源位,也可以通过函数 `resetImg` 来控制组件图片的初始化。进入组件后,可以对图片进行拖拽、双指缩放、旋转等操作。监听 `confirm` 事件获取选中值。 |
| 7 | +图片裁剪组件需要绑定 `v-model` 来控制组件的显示与隐藏,通过属性 `img-src` 控制展示的图片资源。进入组件后,可以对图片进行拖拽、双指缩放、旋转等操作,监听 `confirm` 事件获取裁剪结果。 |
8 | 8 |
|
9 | | -> *注意:在使用组件时,最好在一个新页面中使用图片裁剪组件,图片裁剪保持`show`为true,完成裁剪时,返回上一页。* |
| 9 | +> *注意:建议在新页面中使用图片裁剪组件,保持 `show` 为 true,完成裁剪后返回上一页。* |
10 | 10 |
|
11 | 11 | ```html |
12 | 12 | <wd-img-cropper |
@@ -55,55 +55,45 @@ function handleCancel(event) { |
55 | 55 | } |
56 | 56 | ``` |
57 | 57 |
|
58 | | -## Attributes |
59 | | - |
60 | | -| 参数 | 说明 | 类型 | 可选值 | 默认值| 最低版本 | |
61 | | -|-----|------|-----|-------|-------|--------| |
62 | | -| v-model | 打开图片裁剪组件 | boolean | - | false | - | |
63 | | -| img-src | 图片资源链接 | string | - | - | - | |
64 | | -| img-width | 截屏预览图片的初始宽度; `1、设置宽度不设置高度,按照宽度等比缩放;2、如果都不设置,预览时图片大小会根据裁剪框大小进行等比缩放,进行锁边处理;`; string 类型只支持 % 单位,number 类型时单位为 px | number / string | - | - | - | |
65 | | -| img-height | 截屏预览图片的初始高度; `1、设置高度不设置宽度,按照高度等比缩放;2、如果都不设置,预览时图片大小会根据裁剪框大小进行等比缩放,进行锁边处理;`; string 类型只支持 % 单位,number 类型时单位为 px | number / string | - | - | - | |
66 | | -| disabled-rotate | 禁止图片旋转 | boolean | - | false | - | |
67 | | -| export-scale | 设置导出图片尺寸 | number | - | 2 | - | |
68 | | -| max-scale | 最大缩放倍数 | number | - | 3 | - | |
69 | | -| cancel-button-text | 取消按钮文案 | string | - | 取消 | - | |
70 | | -| confirm-button-text | 确认按钮文案 | string | - | 完成 | - | |
71 | | -| quality | 生成的图片质量 [wx.canvasToTempFilePath属性介绍](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.canvasToTempFilePath.html#%E5%8F%82%E6%95%B0) | number | 0/1 | 1 | - | |
72 | | -| file-type | 目标文件的类型,[wx.canvasToTempFilePath属性介绍](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.canvasToTempFilePath.html#%E5%8F%82%E6%95%B0) | string | - | png | - | |
73 | | -| aspect-ratio | 裁剪框宽高比,格式为 width:height | string | - | 1:1 | $LOWEST_VERSION$ | |
| 58 | +## 自定义裁剪比例 |
74 | 59 |
|
75 | | -## Events |
| 60 | +通过 `aspect-ratio` 属性可以设置裁剪框的宽高比,格式为 `width:height`。 |
76 | 61 |
|
77 | | -| 事件名称 | 说明 | 参数 | 最低版本 | |
78 | | -|---------|-----|-----|---------| |
79 | | -| confirm | 完成截图时触发 | `{tempFilePath, width, height}` 分别为生成文件的临时路径 (本地路径)、生成图片宽、生成图片高| - | |
80 | | -| cancel | 当取消截图时触发 | - | - | |
81 | | -| imgloaderror | 当图片加载错误时触发 | `{err} `| - | |
82 | | -| imgloaded | 当图片加载完成时触发 | `{res}` | - | |
| 62 | +### 3:2 适合拍照 |
83 | 63 |
|
84 | | -## Methods |
| 64 | +```html |
| 65 | +<wd-img-cropper |
| 66 | + v-model="show" |
| 67 | + :img-src="src" |
| 68 | + aspect-ratio="3:2" |
| 69 | + @confirm="handleConfirm" |
| 70 | + @cancel="handleCancel" |
| 71 | +> |
| 72 | +</wd-img-cropper> |
| 73 | +``` |
85 | 74 |
|
86 | | -对外暴露函数 |
| 75 | +### 16:9 影视比例 |
87 | 76 |
|
88 | | -| 事件名称 | 说明 | 参数 | 最低版本 | |
89 | | -|--------|------|-----|---------| |
90 | | -| setRoate | 设置图片旋转角度 | deg (设置的旋转角度)| - | |
91 | | -| resetImg | 重置图片的角度、缩放、位置 | - | - | |
92 | | - |
93 | | -## 外部样式类 |
| 77 | +```html |
| 78 | +<wd-img-cropper |
| 79 | + v-model="show" |
| 80 | + :img-src="src" |
| 81 | + aspect-ratio="16:9" |
| 82 | + @confirm="handleConfirm" |
| 83 | + @cancel="handleCancel" |
| 84 | +> |
| 85 | +</wd-img-cropper> |
| 86 | +``` |
94 | 87 |
|
95 | | -| 类名 | 说明 | 最低版本 | |
96 | | -|-----|------|--------| |
97 | | -| custom-class | 根节点样式 | - | |
| 88 | +### 16:10 这么阔 很有型 |
98 | 89 |
|
99 | | -## 基本用法 |
| 90 | +16:10 的显示比例非常适合展示风景照片或者电影海报等宽屏内容。 |
100 | 91 |
|
101 | 92 | ```html |
102 | | -<!-- 设置3:2的裁剪框 --> |
103 | 93 | <wd-img-cropper |
104 | 94 | v-model="show" |
105 | 95 | :img-src="src" |
106 | | - aspect-ratio="3:2" |
| 96 | + aspect-ratio="16:10" |
107 | 97 | @confirm="handleConfirm" |
108 | 98 | @cancel="handleCancel" |
109 | 99 | > |
@@ -171,3 +161,44 @@ async function handleConfirmUpload(event) { |
171 | 161 | } |
172 | 162 | } |
173 | 163 | ``` |
| 164 | + |
| 165 | +## Attributes |
| 166 | + |
| 167 | +| 参数 | 说明 | 类型 | 可选值 | 默认值| 最低版本 | |
| 168 | +|-----|------|-----|-------|-------|--------| |
| 169 | +| v-model | 打开图片裁剪组件 | boolean | - | false | - | |
| 170 | +| img-src | 图片资源链接 | string | - | - | - | |
| 171 | +| img-width | 截屏预览图片的初始宽度; `1、设置宽度不设置高度,按照宽度等比缩放;2、如果都不设置,预览时图片大小会根据裁剪框大小进行等比缩放,进行锁边处理;`; string 类型只支持 % 单位,number 类型时单位为 px | number / string | - | - | - | |
| 172 | +| img-height | 截屏预览图片的初始高度; `1、设置高度不设置宽度,按照高度等比缩放;2、如果都不设置,预览时图片大小会根据裁剪框大小进行等比缩放,进行锁边处理;`; string 类型只支持 % 单位,number 类型时单位为 px | number / string | - | - | - | |
| 173 | +| disabled-rotate | 禁止图片旋转 | boolean | - | false | - | |
| 174 | +| export-scale | 设置导出图片尺寸 | number | - | 2 | - | |
| 175 | +| max-scale | 最大缩放倍数 | number | - | 3 | - | |
| 176 | +| cancel-button-text | 取消按钮文案 | string | - | 取消 | - | |
| 177 | +| confirm-button-text | 确认按钮文案 | string | - | 完成 | - | |
| 178 | +| quality | 生成的图片质量 [wx.canvasToTempFilePath属性介绍](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.canvasToTempFilePath.html#%E5%8F%82%E6%95%B0) | number | 0/1 | 1 | - | |
| 179 | +| file-type | 目标文件的类型,[wx.canvasToTempFilePath属性介绍](https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.canvasToTempFilePath.html#%E5%8F%82%E6%95%B0) | string | - | png | - | |
| 180 | +| aspect-ratio | 裁剪框宽高比,格式为 width:height | string | - | 1:1 | $LOWEST_VERSION$ | |
| 181 | + |
| 182 | +## Events |
| 183 | + |
| 184 | +| 事件名称 | 说明 | 参数 | 最低版本 | |
| 185 | +|---------|-----|-----|---------| |
| 186 | +| confirm | 完成截图时触发 | `{tempFilePath, width, height}` 分别为生成文件的临时路径 (本地路径)、生成图片宽、生成图片高| - | |
| 187 | +| cancel | 当取消截图时触发 | - | - | |
| 188 | +| imgloaderror | 当图片加载错误时触发 | `{err} `| - | |
| 189 | +| imgloaded | 当图片加载完成时触发 | `{res}` | - | |
| 190 | + |
| 191 | +## Methods |
| 192 | + |
| 193 | +对外暴露函数 |
| 194 | + |
| 195 | +| 事件名称 | 说明 | 参数 | 最低版本 | |
| 196 | +|--------|------|-----|---------| |
| 197 | +| setRoate | 设置图片旋转角度 | deg (设置的旋转角度)| - | |
| 198 | +| resetImg | 重置图片的角度、缩放、位置 | - | - | |
| 199 | + |
| 200 | +## 外部样式类 |
| 201 | + |
| 202 | +| 类名 | 说明 | 最低版本 | |
| 203 | +|-----|------|--------| |
| 204 | +| custom-class | 根节点样式 | - | |
0 commit comments