# vue-cropp

**Repository Path**: sun0317tao/vue-cropp

## Basic Information

- **Project Name**: vue-cropp
- **Description**: 一款简单易用的vue图片裁剪插件，适合用于头像裁剪等功能，兼顾有vue2和vue3，但浏览器兼容做的不是很好，后续会逐步改进，欢迎使用。
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 0
- **Created**: 2023-06-04
- **Last Updated**: 2023-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vue-cropp

一款简单易用的vue图片裁剪插件，适合用于头像裁剪等功能，兼顾有vue2和vue3，但浏览器兼容做的不是很好，后续会逐步改进，欢迎使用。

## 特色

- 自定义画布大小、裁剪框大小
- 自定义背景色
- 支持缩放、拖动、裁剪框拖动大小
- 支持移动端，可适配大小，可拖动、缩放图片

## 项目地址

Github: https://github.com/sun0317tao/vue-crpp

gitee: https://gitee.com/sun0317tao/vue-cropp

(觉得还不错的，请赏一个star吧。)

## 使用方法

1、安装

```
npm install vue-cropp --save-dev # vue2
npm install vue-cropp --save-dev # vue3
```

2、将 vue-cropp 引入项目中

```
import Cropp from "vue-cropp";
export default {
        components:{
            Cropp
        },
...
}
<Cropp
		ref="croppRef"
      :croppwidth="410"
      :croppheight="600"
      :fileOrUrl="fileval"
      :backGroundColor="false"
      @moveupCropp="moveupCropp"
    />
```



## 参数说明

| 属性名           | 作用                                     | 类型           | 必填 | 默认值 |
| ---------------- | ---------------------------------------- | -------------- | ---- | :----: |
| croppwidth       | 画布宽                                   | number         | 否   |  800   |
| croppheight      | 画布高                                   | number         | 否   |  400   |
| croppBoxWidth    | 裁剪盒子宽                               | number         | 否   |  200   |
| croppBoxHeight   | 裁剪盒子高                               | number         | 否   |  200   |
| scalenum         | 放大缩小的速度（值越大放大或缩小的越快） | number         | 否   |  0.01  |
| fileOrUrl        | 图片file文件对象                         | object         | 否   |   “”   |
| backGroundColor  | 画布背景色，支持颜色值和布尔值           | Boolean/string | 否   |  #000  |
| croppfourthColor | 自定义裁剪框四个角颜色                   | string         | 否   |  #fff  |

## 钩子函数

| 属性名       | 作用                                                         | 类型     | 必填 | 返回值  |
| ------------ | ------------------------------------------------------------ | -------- | ---- | ------- |
| moveupCropp  | 裁剪框或图片移动后触发的钩子函数                             | function | 否   | Base64  |
| clearCanvas  | 清除画布的方法，使用ref调用；示例：croppRef.value.clearCanvas() | function | 否   | 无      |
| confirmImage | 使用ref调用该方法，传入confirm,返回promise 的 file文件对象；示例：croppRef.value.confirmImage('confirm') | function | 否   | promise |



## 更新日志

**1.0.0**

- 第一版开发完成。

**1.1.2**

- 去除项目中的log，优化移动端第一次在裁剪框中拖动和缩放不了图片的问题

**1.1.3**

- 优化图片清晰度问题，但是裁剪出来的图片为了保持清晰度图片的默认像素会放大当前设备屏幕的像素比
- 增加可自定义裁剪框四个角颜色

**1.1.4**

- 优化页面盒子外部使用transform、margin，等样式后裁剪盒子移动错位的bug。

**1.1.5**

- 修改上级元素有 text-align: center; 等对canvas的影响

**1.1.6**

- 取消画布下方的确认和取消按钮，改为使用ref调用的钩子函数，clearCanvas（）方法清除画布；confirmImage('confirm')方法返回promise得到文件对象

**1.1.7**

- 修复清楚画布之后再次移动会出现上一次图片的bug

**1.1.8**

- 修复在火狐浏览器按下裁剪框的时候 取值event.offsetX 和 event.offsetY 有bug，具体原因还不太清楚，查资料也说的很模糊，但是采用为 layerX 和 layerY 就好了。