@hognevevle/vue-avatar-cropper

<h1 align="center">Vue Avatar Cropper</h1> <p align="center"> :girl: A simple and elegant component to crop and upload avatars.</p> ![image](https://user-images.githubusercontent.com/1472352/28398207-b32907b0-6d38-11e7-998a-32d34362b341.png) [![Edit test-project](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/vue-avatar-cropper-demo-dptno) [![Sponsor me](https://github.com/overtrue/overtrue/blob/master/sponsor-me-button-s.svg?raw=true)](https://github.com/sponsors/overtrue) ## Basic usage ```html <button @click="() => { trigger = true }">Pick avatar</button> <avatar-cropper v-model="trigger" upload-url="/files/upload" @uploaded="handleUploaded" /> ``` ## Installing ### Browsers 1. Include the link to AvatarCropper in `<head>` alongside [Vue.js](https://www.npmjs.com/package/vue), [Cropper.js](https://www.npmjs.com/package/cropperjs) and [Mime](https://www.npmjs.com/package/mime): ```html <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/cropperjs/dist/cropper.min.css"> <script src="https://cdn.jsdelivr.net/npm/cropperjs"></script> <script src="https://cdn.jsdelivr.net/npm/vue"></script> <script src="https://cdn.jsdelivr.net/npm/vue-avatar-cropper"></script> <script src="https://wzrd.in/standalone/mime%2flite@latest"></script> ``` 2. AvatarCropper will auto-install upon detecting the global Vue instance. You can use it right away. ### Node environment 1. Install the AvatarCropper package: ```sh npm install vue-avatar-cropper # or yarn add vue-avatar-cropper ``` 2. Register it as you usually would: ```js import AvatarCropper from 'vue-avatar-cropper' // or const AvatarCropper = require('vue-avatar-cropper'); Vue.component('AvatarCropper', AvatarCropper); // or Vue.use(AvatarCropper); // or new Vue({ components: { AvatarCropper }, // ... }); ``` ### Props Property Name | Type | Description --- | --- | --- `trigger` | Boolean | Set to true to trigger the avatar cropper, this prop is used for `v-model`. Default: `false` `file` | File | [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) to use instead of prompting the user to upload one `upload-url` | String | URL to upload the file to `upload-file-field` | String | [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) field to use for the file. Default: `'file'` `upload-file-name` | String/Function | File name to use for the [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) field. Can be `String` or `Function({ filename, mime, extension }) => String`. Default: Automatically determined from the uploaded [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File)'s `name` property and the extension of the output MIME. `upload-form-data` | FormData | Additional [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData). Default: `new FormData()` `upload-handler` | Function | Handler to replace default upload handler, the argument is [cropperJS](https://github.com/fengyuanchen/cropperjs) instance. `request-options` | Object | Options passed to the `init` parameter of the [Request()](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request) constructor. Use this to set the method, headers, etc. Default: `{ method: 'POST' }` `cropper-options` | Object | Options passed to the [cropperJS](https://github.com/fengyuanchen/cropperjs#options) instance. <br>Default: `{` | | |     `aspectRatio: 1,` | | |     `autoCropArea: 1,` | | |     `viewMode: 1,` | | |     `movable: false,` | | |     `zoomable: false` | | | `}` `output-options` | Object | Options passed to the [cropper.getCroppedCanvas()](https://github.com/fengyuanchen/cropperjs#getcroppedcanvasoptions) method. <br>Default: `{}`. Recommended use-case is specifying an output size, for instance: `{ width: 512, height: 512 }` `output-mime` | String | The resulting avatar image MIME type, if invalid `image/png` will be used. Default: `null` `output-quality` | Number | The resulting avatar image quality [0 - 1]. Default: `0.9`<br>(if the output-mime property is `'image/jpeg'` or `'image/webp'`) `mimes` | String | Allowed image formats. Default: <br>`'image/png, image/gif, image/jpeg, image/bmp, image/x-icon'` `capture` | String | Capture attribute for the file input. Forces mobile users to take a new picture with the back(Use value `'environment'`) or front(Use value `'user'`) camera `labels` | Object | Label for buttons. Default: `{ submit: 'Ok', cancel: 'Cancel' }` `inline` | Boolean | If true component will be displayed as inline elemenet. Default: `false` ### Events - **triggered** `trigger` prop changed, used for `v-model`, parameter: - `value` boolean. - **changed** user picked a file, parameter is an object containing: - `file` object, [File](https://developer.mozilla.org/zh-CN/docs/Web/API/File) object. - `reader` object, [FileReader](https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader) - **submit** right after a click on the submit button - **cancel** when user decides to cancel the upload - **uploading** before submit upload request, parameter is an object containing: - `form` object, [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) instance. - `request` object, [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) instance. - `response` object, [Promise](https://developer.mozilla.org/en-US/docs/Web/API/Promise) which resolves to a [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) instance. - **uploaded** after request is successful, parameter is an object containing: - `form` object, [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) instance. - `request` object, [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) instance. - `response` object, [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) instance. - **completed** after request has completed, parameter is an object containing: - `form` object, [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) instance. - `request` object, [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) instance. - `response` object, [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) instance. - **error** something went wrong, parameter is an object containing: - `message` error message. - `type` error type, example: `'load'`/`'upload'`/`'user'`. - `context` context data. You can listen for these events like this: ```html <avatar-cropper v-model="trigger" upload-url="/files/upload" @uploading="handleUploading" @uploaded="handleUploaded" @completed="handleCompleted" @error="handleError" /> ``` ```js export default { //... methods: { ... handleUploading({ form, request, response }) { // show a loader }, handleUploaded({ form, request, response }) { // update user avatar attribute }, handleCompleted({ form, request, response }) { // close the loader }, handleError({ message, type, context}) { if (type === 'upload') { const { request, response } = context } } }, } ``` :rocket: There is an online demo: [![Edit test-project](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/vue-avatar-cropper-demo-dptno) ## :heart: Sponsor me [![Sponsor me](https://github.com/overtrue/overtrue/blob/master/sponsor-me.svg?raw=true)](https://github.com/sponsors/overtrue) 如果你喜欢我的项目并想支持它，[点击这里 :heart:](https://github.com/sponsors/overtrue) ## Project supported by JetBrains Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects. [![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/overtrue) ## License MIT