# Getting started

# Package installation

To use the library you should install it with npm or yarn

Notice!

To install the Vue 3 version, use npm install -S vue-advanced-cropper@next instead

npm install -S vue-advanced-cropper
yarn add vue-advanced-cropper

Then import the Cropper component:

import { Cropper } from 'vue-advanced-cropper'
import 'vue-advanced-cropper/dist/style.css';

After that register (opens new window) the component locally or globally.

# Minimal working example

The following example shows the usage of the cropper in a custom component:

import { Cropper } from 'vue-advanced-cropper';
import 'vue-advanced-cropper/dist/style.css';

export default {
	components: {
		Cropper,
	},
	data: {
		img: 'https://images.unsplash.com/photo-1600984575359-310ae7b6bdf2?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=700&q=80'
	},
	methods: {
		change({ coordinates, canvas }) {
			console.log(coordinates, canvas)
		}
	},
}
<cropper
	class="cropper"
	:src="img"
	:stencil-props="{
		aspectRatio: 10/12
	}"
	@change="change"
/>
/*
	It may be necessary to set limits on the size of the cropper, otherwise the cropper image will try to fill all the available space.
*/
.cropper {
	height: 600px;
	width: 600px;
	background: #DDD;
}

If you need to change the behavior of the cropper (for example, you want to create a fixed one for mobile devices), please read this detailed article about the different variants of croppers.

# Using CDN

# Vue 2

If you want to use the cropper without using, (for example, different build systems), you should add the code below to your page.

::: Tip Notice! Currently support for this method is limited. :::

<script src="https://unpkg.com/vue-advanced-cropper@^1.0.0/dist/index.umd.js" />
<link rel="stylesheet" href="https://unpkg.com/vue-advanced-cropper@^1.0.0/dist/style.css" />

You can use globally registered components: cropper, circle-stencil, rectangle-stencil, simple-handler, simple-line.

# Vue 3

The links for the next Vue version is slightly different:

<script src="https://unpkg.com/vue-advanced-cropper@^2.0.0/dist/index.umd.js" />
<link rel="stylesheet" href="https://unpkg.com/vue-advanced-cropper@^2.0.0/dist/style.css" />

To get access to components you should use the global object VueAdvancedCropper.