CraydelImageCropper

Installation

Get the latest version by NPM:

1$ npm i @craydel/craydel-image-cropper

Register Plugin

If you use the plugin API, the component will be registered as a global component just like when including it with the script tag, but you won't need to re-register it through the components property in your own components.

Create the plugin file e.g craydel-components.js file.

1// craydel-components.js
2import Vue from 'vue'
3import CraydelImageCropper from '@craydel/craydel-image-cropper/src/CraydelImageCropper.vue'
4
5const Components = {
6  CraydelImageCropper,
7};
8
9Object.keys(Components).forEach(name => {
10  Vue.component(name, Components[name]);
11});
12
13export default Components;

Next reference the plugin file in your nuxt.config.js

1// Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
2plugins: [
3  '~/plugins/craydel-components.js'
4]

Props

Name	Type	Default	Description
id	string	random ID	Sets the DOM id on the component.
src	string	undefined	Sets the initial image URL.
max-width	number | string	350	Sets the maximum width for the cropper canvas in pixels.
stencil-width	number | string	280	Sets the width of the stencil in pixels.
stencil-height	number | string	280	Sets the height of the stencil in pixels.

 

Usage

An example showing an image cropper.

1<craydel-image-cropper
2        stencil-width="132"
3        stencil-height="170"
4></craydel-image-cropper>