npm package: @kvnchn/vue-advanced-cropper
Description: The advanced library to create your own croppers suited for any website design
Author: kevinchandra.kvn@gmail.com
Latest version: 0.1.0

<p align="center"><a href="https://advanced-cropper.github.io/vue-advanced-cropper/" target="_blank" rel="noopener noreferrer"><img width="133" src="https://github.com/advanced-cropper/vue-advanced-cropper/blob/master/example/readme/logo.svg?raw=true&timestamp=1608385818575" alt="Vue Advanced Cropper logo"></a></p>
<br/>
<p align="center">
  <a href="https://npmcharts.com/compare/vue-advanced-cropper?minimal=true"><img src="https://img.shields.io/npm/dm/vue-advanced-cropper.svg?sanitize=true" alt="Downloads"></a>
  <a href="https://www.npmjs.com/package/vue-advanced-cropper"><img src="https://img.shields.io/npm/v/vue-advanced-cropper/vue-3.svg?sanitize=true" alt="Version"></a>
  <a href="https://www.npmjs.com/package/vue-advanced-cropper"><img src="https://img.shields.io/npm/v/vue-advanced-cropper/vue-2.svg?sanitize=true" alt="Version"></a>
  <a href="https://www.npmjs.com/package/vue-advanced-cropper"></a>
  <br>
 	<a href="https://advanced-cropper.github.io/vue-advanced-cropper/" target="_blank" rel="noopener noreferrer">Documentation</a> /
  	<a href="https://advanced-cropper.github.io/vue-advanced-cropper/guides/recipes.html" target="_blank" rel="noopener noreferrer">Examples</a> /
    <a href="https://codesandbox.io/s/vue-advanced-cropper-vue-3-yrxou?file=/src/App.vue" target="_blank" rel="noopener noreferrer">Sandbox</a> / <a href="https://codesandbox.io/s/vue-advanced-cropper-composition-api-5z0ww0?file=/src/App.vue" target="_blank" rel="noopener noreferrer">Sandbox + Composition API</a>
</p>

<h2 align="center"> </h2>

---

:fire: **HEADS UP!** You're currently looking at the branch for Vue 2. For the Vue 3 branch, [please check out the `vue-next` branch](https://github.com/advanced-cropper/vue-advanced-cropper/tree/vue-next).

---

**Vue Advanced Cropper** is the advanced library that allows you to create custom croppers suited for any website design.
It means that you can change not only the cropper's appearance but also its behavior.

Features:

- full mobile/desktop support
- support [all three main types of croppers](https://advanced-cropper.github.io/vue-advanced-cropper/introduction/types.html) right out of the box
- support both canvas and coordinates modes, minimum and maximum aspect ratios, custom size restrictions
- zoom, rotate, resize image
- auto-zoom, transitions

![](https://github.com/advanced-cropper/vue-advanced-cropper/blob/master/example/readme/example.gif?raw=true)

The codesandbox for [mobile](https://codesandbox.io/s/vue-advanced-cropper-mobile-without-theme-h33bf) / [desktop](https://codesandbox.io/s/vue-advanced-cropper-desktop-without-theme-4pp9f?file=/src/App.vue) examples above.

## Install

### Vue 3.0

```bash
npm install --save vue-advanced-cropper
```

```bash
yarn add vue-advanced-cropper
```

### Vue 2.0

```bash
npm install --save vue-advanced-cropper@vue-2
```

```bash
yarn add vue-advanced-cropper@vue-2
```

If you would like to use a CDN, please read the corresponding [documentation section](https://advanced-cropper.github.io/vue-advanced-cropper/introduction/getting-started.html#using-cdn)

## Usage

```js
import Vue from 'vue'
import { Cropper } from 'vue-advanced-cropper'
import 'vue-advanced-cropper/dist/style.css';

new Vue({
  el: '#app',
  data: {
    img: 'https://images.pexels.com/photos/226746/pexels-photo-226746.jpeg'
  },
  methods: {
    change({coordinates, canvas}) {
      console.log(coordinates, canvas)
    }
  },
  components: {
    Cropper
  }
})
```

```html
<div id="app">
  <cropper
    class="cropper"
    :src="img"
    :stencil-props="{
      aspectRatio: 10/12
    }"
    @change="change"
  ></cropper>
</div>
```

```
/*
  You may need to set the limits for the cropper sizes or container sizes,
  otherwise, a cropping image will try to fill all available space
*/
.cropper {
  height: 600px;
  background: #DDD;
}
```


## Cropper

| Prop                      | Type                 | Description                                                     			      | Default
| ------------------------- | ------------------   | ---------------------------------------------------------------------------      | ---------------
| src                       | `String`             | The cropping image (link / base64)                              			      |
| stencilComponent          | `String`, `Object`   | The stencil component                                           			      | `RectangleStencil`
| stencilProps              | `Object`             | The props for the stencil component                             			      | `{}`
| class                     | `String`             | The optional class for the root cropper block                   			      |
| imageClass                | `String`             | The optional class for the cropping image                       			      |
| boundariesClass           | `String`             | The optional class for the area.                                			      |
| backgroundClass           | `String`             | The optional class for the background under the image           			      |
| autoZoom                  | `Boolean`            | Enable / disable transitions                                     		          | `false`
| transitions               | `Boolean`            | Enable / disable auto zoom                                     			      | `true`
| stencilSize               | `Object `            | The size of the stencil in pixels                                                |
| debounce                  | `String`, `Number`   | The time before the `change` event will be emitted after changes (ms) 			      | `500`
| canvas                    | `Boolean`            | The flag that indicates if canvas should be used                			      | `true`
| minWidth                  | `String`, `Number`   | The minimum width of the stencil (percents)                     			      |
| minHeight                 | `String`, `Number`   | The minimum height of the stencil (percents)                    			      |
| maxWidth                  | `String`, `Number`   | The maximum width of the stencil (percents)                     			      |
| maxHeight                 | `String`, `Number`   | The maximum height of the stencil (percents)                    			      |
| checkOrientation          | `Boolean`            | Check if EXIF orientation should be checked                     			      | `true`
| resizeImage               | `Boolean`, `Object`  | The options for the image resizing ([details](https://advanced-cropper.github.io/vue-advanced-cropper/components/cropper.html#resizeimage)) | `true`
| moveImage                 | `Boolean`, `Object`  | The options for the image moving ([details](https://advanced-cropper.github.io/vue-advanced-cropper/components/cropper.html#moveimage)) | `true`
| imageRestriction          | `String`             | Set restrictions for image position ('fill-area' 'fit-area', 'stencil', 'none')  | `'fill-area'`
| defaultSize               | `Object`, `Function` | The function that returns the default size of the stencil or object              | `core.defaultSize`
| defaultPosition           | `Object`, `Function` | The function that returns the default position of the stencil or object          | `core.defaultPosition`
| defaultBoundaries         | `String`, `Function` | The function that determines the boundaries size or string (`'fill'`, `'fit'`)   | `'fill'`
| sizeRestrictionsAlgorithm | `Function`           | The function that returns the restrictions object                 		          |


| Event                     | Description
| ------------------------  | --------------------------------------------------------------
| change                    | Invoked on the changing of a stencil's position/size after mounting the component and on an image change
| ready                     | Invoked on the success of an image loading
| error                     | Invoked on an error of an image loading


## RectangleStencil

| Prop                      | Type                | Description                                                    | Default
| ------------------------  | ------------------- | -------------------------------------------------------------- | ---------------
| aspectRatio               | `Number`            | The aspect ratio                                               |
| minAspectRatio            | `Number`            | The minimum aspect ratio                                       |
| maxAspectRatio            | `Number`            | The maximum aspect ratio                                       |
| class                     | `String`            | The class for the root block of the stencil component              |
| previewClass              | `String`            | The class for the preview component                            |
| movingClass               | `String`            | The class applied when the user drags the stencil                   |
| resizingClass             | `String`            | The class applied when the user resizes the stencil                 |
| boundingBoxClass          | `String`            | The class for the bounding box component                       |
| handlerComponent          | `String`,`Object`   | The handler component                                          |
| handlers                  | `Object`            | The object of handlers that should be visible or hidden.       |
| handlersClasses           | `Object`            | The object of custom handler classes                           |
| handlersWrappersClasses   | `Object`            | The object of custom handler wrapper classes                   |
| lineComponent             | `String`,`Object`   | The handler component                                          |
| lines                     | `Object`            | The object of the lines that should be visible or hidden.         |
| linesClasses              | `Object`            | The object of custom line classes                              |
| linesWrappersClasses      | `Object`            | The object of custom line wrapper classes                      |

## License

The source code of this library is licensed under the MIT license, and the documentation and photos belong to their respective owners.