vue-image-crop-upload

A beautiful vue component for image crop and upload. （vue图片剪裁上传组件）.

Notice: This component is designed for pc, not recommended for use on the mobile side.(该组件适用于pc端，不推荐手机端使用)

中文文档在后面

Change log

@3.0.0

• Compatible vue3

Demo

Click me.

Screenshot

Brower compatibility

IE10+

Install

npm

$ npm install vue-image-crop-upload

Usage

Props

Name	Type	Default	Description
url	String	''	Server api path,like "/avatar/upload", If empty, will not be uploaded
method	String	'POST'	request http method
field	String	'upload'	Upload input filename, used for server side get the file stream.
value	Boolean	twoWay	show or not
params	Object	null	POST Params，like "{k:v}"
headers	Object	null	POST request header，like "{k:v}"
langType	String	'zh'	language type
langExt	Object		language extend
width	Number	200	width of receive image
height	Number	200	height of receive image
imgFormat	string	'png'	jpg/png, Server api receive file type.
imgBgc	string	'#fff'	background color, if the imgFormat prop is jpg
noCircle	Boolean	false	disable circle preview
noSquare	Boolean	false	disable square preview
noRotate	Boolean	true	disable rotate function
withCredentials	Boolean	false	support cross-domain

Events

Name	Description
srcFileSet	Once you've selected the file, params( fileName, fileType, fileSize )
cropSuccess	image crop success, params( imageDataUrl, field )
cropUploadSuccess	upload success, params( jsonData, field )
cropUploadFail	upload fail, params( status, field )

Language package

view details.

Example vue@3

<divid="app"><aclass="btn" @click="toggleShow">set avatar</a><my-uploadfield="img"
@crop-success="cropSuccess"
@crop-upload-success="cropUploadSuccess"
@crop-upload-fail="cropUploadFail"
v-model="show"
:width="300"
:height="300"
url="/upload"
:params="params"
:headers="headers"
img-format="png"></my-upload><img:src="imgDataUrl"></div><script>import'babel-polyfill';// es6 shimimportVuefrom'vue';importmyUploadfrom'vue-image-crop-upload';newVue({el: '#app',data: {show: true,params: {token: '123456798',name: 'avatar'},headers: {smail: '*_~'},imgDataUrl: ''// the datebase64 url of created image},components: {'my-upload': myUpload},methods: {toggleShow(){this.show=!this.show;},/** * crop success * * [param] imgDataUrl * [param] field */cropSuccess(imgDataUrl,field){console.log('-------- crop success --------');this.imgDataUrl=imgDataUrl;},/** * upload success * * [param] jsonData server api return data, already json encode * [param] field */cropUploadSuccess(jsonData,field){console.log('-------- upload success --------');console.log(jsonData);console.log('field: '+field);},/** * upload fail * * [param] status server api return error status, like 500 * [param] field */cropUploadFail(status,field){console.log('-------- upload fail --------');console.log(status);console.log('field: '+field);}}});</script>

Example vue@2

<divid="app"><aclass="btn" @click="toggleShow">set avatar</a><my-uploadfield="img"
@crop-success="cropSuccess"
@crop-upload-success="cropUploadSuccess"
@crop-upload-fail="cropUploadFail"
v-model="show"
:width="300"
:height="300"
url="/upload"
:params="params"
:headers="headers"
img-format="png"></my-upload><img:src="imgDataUrl"></div><script>import'babel-polyfill';// es6 shimimportVuefrom'vue';importmyUploadfrom'vue-image-crop-upload/upload-2.vue';newVue({el: '#app',data: {show: true,params: {token: '123456798',name: 'avatar'},headers: {smail: '*_~'},imgDataUrl: ''// the datebase64 url of created image},components: {'my-upload': myUpload},methods: {toggleShow(){this.show=!this.show;},/** * crop success * * [param] imgDataUrl * [param] field */cropSuccess(imgDataUrl,field){console.log('-------- crop success --------');this.imgDataUrl=imgDataUrl;},/** * upload success * * [param] jsonData server api return data, already json encode * [param] field */cropUploadSuccess(jsonData,field){console.log('-------- upload success --------');console.log(jsonData);console.log('field: '+field);},/** * upload fail * * [param] status server api return error status, like 500 * [param] field */cropUploadFail(status,field){console.log('-------- upload fail --------');console.log(status);console.log('field: '+field);}}});</script>

Example vue@1

<divid="app"><aclass="btn" @click="toggleShow">set avatar</a><my-uploadfield="img"
:width="300"
:height="300"
url="/upload"
:params="params"
:headers="headers"
lang-type="en"
:value.sync="show"
img-format="png"></my-upload><img:src="imgDataUrl"></div><script>import'babel-polyfill';// es6 shimimportVuefrom'vue';importmyUploadfrom'vue-image-crop-upload/upload-1.vue';newVue({el: '#app',data: {show: true,params: {token: '123456798',name: 'avatar'},headers: {smail: '*_~'},imgDataUrl: ''// the datebase64 url of created image},components: {'my-upload': myUpload},methods: {toggleShow(){this.show=!this.show;}},events: {/** * crop success * * [param] imgDataUrl * [param] field */cropSuccess(imgDataUrl,field){console.log('-------- crop success --------');this.imgDataUrl=imgDataUrl;},/** * upload success * * [param] jsonData server api return data, already json encode * [param] field */cropUploadSuccess(jsonData,field){console.log('-------- upload success --------');console.log(jsonData);console.log('field: '+field);},/** * upload fail * * [param] status server api return error status, like 500 * [param] field */cropUploadFail(status,field){console.log('-------- upload fail --------');console.log(status);console.log('field: '+field);}}});</script>

---

中文文档

更新日志

@3.0.0

• 兼容vue3

示例

点我.

截图

浏览器兼容

IE10+

安装

npm

$ npm install vue-image-crop-upload

使用

Props

名称	类型	默认	说明
url	String	''	上传接口地址，如果为空，图片不会上传
method	String	'POST'	上传方法
field	String	'upload'	向服务器上传的文件名
value	Boolean	twoWay	是否显示控件，双向绑定
params	Object	null	上传附带其他数据，格式"{k:v}"
headers	Object	null	上传header设置，格式"{k:v}"
langType	String	'zh'	语言类型，默认中文
langExt	Object		语言包自行扩展
width	Number	200	最终得到的图片宽度
height	Number	200	最终得到的图片高度
imgFormat	string	'png'	jpg/png, 最终得到的图片格式
imgBgc	string	'#fff'	导出图片背景色,当imgFormat属性为jpg时生效
noCircle	Boolean	false	关闭 圆形图像预览
noSquare	Boolean	false	关闭 方形图像预览
noRotate	Boolean	true	关闭 旋转图像功能
withCredentials	Boolean	false	支持跨域

Events

名称	说明
srcFileSet	用户选取文件之后, 参数( fileName, fileType, fileSize )
cropSuccess	图片截取完成事件（上传前), 参数( imageDataUrl, field )
cropUploadSuccess	上传成功， 参数( jsonData, field )
cropUploadFail	上传失败， 参数( status, field )

自带语言包

{zh: {hint: '点击，或拖动图片至此处',loading: '正在上传……',noSupported: '浏览器不支持该功能，请使用IE10以上或其他现在浏览器！',success: '上传成功',fail: '图片上传失败',preview: '头像预览',btn: {off: '取消',close: '关闭',back: '上一步',save: '保存'},error: {onlyImg: '仅限图片格式',outOfSize: '单文件大小不能超过 ',lowestPx: '图片最低像素为（宽*高）：'}}}

使用示例 vue@1

<divid="app"><aclass="btn" @click="toggleShow">设置头像</a><my-uploadfield="img"
:width="300"
:height="300"
url="/upload"
:params="params"
:headers="headers"
:value.sync="show"
img-format="png"></my-upload><img:src="imgDataUrl"></div><script>import'babel-polyfill';// es6 shimimportVuefrom'vue';importmyUploadfrom'vue-image-crop-upload/upload-1.vue';newVue({el: '#app',data: {show: true,params: {token: '123456798',name: 'avatar'},headers: {smail: '*_~'},imgDataUrl: ''// the datebase64 url of created image},components: {'my-upload': myUpload},methods: {toggleShow(){this.show=!this.show;}},events: {/** * crop success * * [param] imgDataUrl * [param] field */cropSuccess(imgDataUrl,field){console.log('-------- crop success --------');this.imgDataUrl=imgDataUrl;},/** * upload success * * [param] jsonData 服务器返回数据，已进行json转码 * [param] field */cropUploadSuccess(jsonData,field){console.log('-------- upload success --------');console.log(jsonData);console.log('field: '+field);},/** * upload fail * * [param] status server api return error status, like 500 * [param] field */cropUploadFail(status,field){console.log('-------- upload fail --------');console.log(status);console.log('field: '+field);}}});</script>

使用示例 vue@2

<divid="app"><aclass="btn" @click="toggleShow">设置头像</a><my-uploadfield="img"
@crop-success="cropSuccess"
@crop-upload-success="cropUploadSuccess"
@crop-upload-fail="cropUploadFail"
v-model="show"
:width="300"
:height="300"
url="/upload"
:params="params"
:headers="headers"
img-format="png"></my-upload><img:src="imgDataUrl"></div><script>import'babel-polyfill';// es6 shimimportVuefrom'vue';importmyUploadfrom'vue-image-crop-upload/upload-2.vue';newVue({el: '#app',data: {show: true,params: {token: '123456798',name: 'avatar'},headers: {smail: '*_~'},imgDataUrl: ''// the datebase64 url of created image},components: {'my-upload': myUpload},methods: {toggleShow(){this.show=!this.show;},/** * crop success * * [param] imgDataUrl * [param] field */cropSuccess(imgDataUrl,field){console.log('-------- crop success --------');this.imgDataUrl=imgDataUrl;},/** * upload success * * [param] jsonData 服务器返回数据，已进行json转码 * [param] field */cropUploadSuccess(jsonData,field){console.log('-------- upload success --------');console.log(jsonData);console.log('field: '+field);},/** * upload fail * * [param] status server api return error status, like 500 * [param] field */cropUploadFail(status,field){console.log('-------- upload fail --------');console.log(status);console.log('field: '+field);}}});</script>

使用示例 vue@3

<divid="app"><aclass="btn" @click="toggleShow">设置头像</a><my-uploadfield="img"
@crop-success="cropSuccess"
@crop-upload-success="cropUploadSuccess"
@crop-upload-fail="cropUploadFail"
v-model="show"
:width="300"
:height="300"
url="/upload"
:params="params"
:headers="headers"
img-format="png"></my-upload><img:src="imgDataUrl"></div><script>import'babel-polyfill';// es6 shimimportVuefrom'vue';importmyUploadfrom'vue-image-crop-upload';newVue({el: '#app',data: {show: true,params: {token: '123456798',name: 'avatar'},headers: {smail: '*_~'},imgDataUrl: ''// the datebase64 url of created image},components: {'my-upload': myUpload},methods: {toggleShow(){this.show=!this.show;},/** * crop success * * [param] imgDataUrl * [param] field */cropSuccess(imgDataUrl,field){console.log('-------- crop success --------');this.imgDataUrl=imgDataUrl;},/** * upload success * * [param] jsonData 服务器返回数据，已进行json转码 * [param] field */cropUploadSuccess(jsonData,field){console.log('-------- upload success --------');console.log(jsonData);console.log('field: '+field);},/** * upload fail * * [param] status server api return error status, like 500 * [param] field */cropUploadFail(status,field){console.log('-------- upload fail --------');console.log(status);console.log('field: '+field);}}});</script>