npmpackage.info

Gathering detailed insights and metrics for vue-croppie

Other packages similar to vue-croppie

@affandes/vue-croppie

1.0.1

Vue wrapper for Croppie

vue-croppie-extended

1.0.3

VueJs wrapper for Croppie

vue-elder-croppie

1.0.1

Image cropping component for vue-elder

@idecardo/vue-croppie

0.1.0

A Croppie wrapper for VueJS 2

Gathering detailed insights and metrics for vue-croppie

vue-croppie - 2.0.3 | npmpackage.info

vue-croppie

Vue wrapper for croppie

2.0.3

261

MIT

HTML

228.54 kB

2.6

Installations

npm install vue-croppie

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

20.5.1

NPM Version

9.8.0 Pull Requests

Open

4

Total

23

Closed

3

Merged

16

Issues

Open

12

Total

67

Closed

55

Releases

Unable to fetch releases

Languages

HTML

JavaScript

HTML (63.83%)

JavaScript (36.17%)

Developer

jofftiquez

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

261 Stars

136 Commits

42 Forks

7 Watchers

8 Branches

9 Contributors

Updated on Apr 28, 2025

Maintainers

View All 9 Contributors

Package Meta Information

Latest Version

2.0.3

Package Id

vue-croppie@2.0.3

Unpacked Size

228.54 kB

Size

67.80 kB

File Count

NPM Version

9.8.0

Node Version

20.5.1

Published on

May 20, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

croppie

Dev Dependencies

bili

VueCroppie

VueCroppie is a Vue 2 wrapper for Croppie a beautiful photo cropping tool for Javascript by foliotek.

If you like this project, please give it a star, and consider following the author. :)

Installation

NPM

1npm install vue-croppie --save

CDN

https://unpkg.com/vue-croppie/dist/vue-croppie.js

Usage with a bundler

TO use VueCroppie with Webpack, Parcel or other bundler

1import Vue from 'vue';
2import VueCroppie from 'vue-croppie';
3import 'croppie/croppie.css' // import the croppie css manually
4
5Vue.use(VueCroppie);

Usage in Browser directly

1<script src="https://unpkg.com/vue-croppie/dist/vue-croppie.js"></script>
2<link rel="stylesheet" href="https://unpkg.com/croppie/croppie.css">
3<body>
4  ...
5</body>
6<script>
7  const vm = new Vue({...});
8</script>

Sample

This sample below will produce this.

1<template>
2    <div>
3        <!-- Note that 'ref' is important here (value can be anything). read the description about `ref` below. -->
4        <vue-croppie 
5            ref="croppieRef" 
6            :enableOrientation="true"
7            :boundary="{ width: 300, height: 300}"
8            @result="result"
9            @update="update">
10        </vue-croppie>
11
12        <!-- the result -->
13        <img v-bind:src="cropped">
14
15        <button @click="bind()">Bind</button>
16        <!-- Rotate angle is Number -->
17        <button @click="rotate(-90)">Rotate Left</button>
18        <button @click="rotate(90)">Rotate Right</button>
19        <button @click="crop()">Crop Via Callback</button>
20        <button @click="cropViaEvent()">Crop Via Event</button>
21    </div>
22</template>
23
24<script>
25export default {
26    mounted() {
27        // Upon mounting of the component, we accessed the .bind({...})
28        // function to put an initial image on the canvas.
29        this.$refs.croppieRef.bind({
30            url: 'http://i.imgur.com/Fq2DMeH.jpg',
31        })
32    },
33    data() {
34        return {
35            cropped: null,
36            images: [
37                'http://i.imgur.com/fHNtPXX.jpg',
38                'http://i.imgur.com/ecMUngU.jpg',
39                'http://i.imgur.com/7oO6zrh.jpg',
40                'http://i.imgur.com/miVkBH2.jpg'
41            ]
42        }
43    },
44    methods: {
45        bind() {
46            // Randomize cat photos, nothing special here.
47            let url = this.images[Math.floor(Math.random() * 4)]
48
49            // Just like what we did with .bind({...}) on 
50            // the mounted() function above.
51            this.$refs.croppieRef.bind({
52                url: url,
53            });
54        },
55        // CALBACK USAGE
56        crop() {
57            // Here we are getting the result via callback function
58            // and set the result to this.cropped which is being 
59            // used to display the result above.
60            let options = {
61                format: 'jpeg', 
62                circle: true
63            }
64            this.$refs.croppieRef.result(options, (output) => {
65                this.cropped = output;
66            });
67        },
68        // EVENT USAGE
69        cropViaEvent() {
70            this.$refs.croppieRef.result(options);
71        },
72        result(output) {
73            this.cropped = output;
74        },
75        update(val) {
76            console.log(val);
77        },
78        rotate(rotationAngle) {
79            // Rotates the image
80            this.$refs.croppieRef.rotate(rotationAngle);
81        }
82    }
83}
84</script>

File Upload Sample

You can upload file instead of using direct image link. Usage In your form add a file input along with vue-croppie component.

1<template>
2  <input type="file" @change="croppie"/>
3  <vue-croppie ref="croppieRef" :enableOrientation="true" :boundary="{ width: 450, height: 300}" :viewport="{ width:400, height:250, 'type':'square' }">
4  </vue-croppie>
5  <!-- the result -->
6  <img :src="cropped">
7  <button @click="crop">Crop</button>
8</template>
9
10<script>
11export default {
12  data() {
13    return {
14      croppieImage: '',
15      cropped: null
16    };
17  },
18  methods: {
19    croppie (e) {
20      var files = e.target.files || e.dataTransfer.files;
21      if (!files.length) return;
22
23      var reader = new FileReader();
24      reader.onload = e => {
25        this.$refs.croppieRef.bind({
26          url: e.target.result
27        });
28      };
29
30    reader.readAsDataURL(files[0]);
31    },
32    crop() {
33      // Options can be updated.
34      // Current option will return a base64 version of the uploaded image with a size of 600px X 450px.
35      let options = {
36        type: 'base64',
37        size: { width: 600, height: 450 },
38        format: 'jpeg'
39      };
40      this.$refs.croppieRef.result(options, output => {
41        this.cropped = this.croppieImage = output;
42          console.log(this.croppieImage);
43        });
44      }
45  }
46};

Using Options

All Croppie options were converted to props to be able use them in the vue-croppie component.

Usage

1<vue-croppie
2    ref=croppieRef
3    :enableOrientation="true"
4    :mouseWheelZoom="false"
5    :viewport="{ width: 200, height: 200, type: 'circle' }"
6    @result="fn"
7>
8</vue-croppie>

API

All of the properties and methods are based on Croppie documentation. All property and method names are "===" the same if you know what I mean.

Except for these few things below.

Option	Type	Default	Description
`ref` (required)	`Object`	`none`	`ref` is used to create a reference to the child component, in order to have access to it's methods and properties. Specific example is to access the `result()` function of `vue-croppie` from outside the component.
`resultType`	`String`	`base64`	The image encoding of the cropped image via `result()`. Also available in Croppie Documentation.
`customClass`	`String`	`none`	You can pass a custom class or classes to the `props` `customClass` like `customClass="class1 class2 class3"`

Events

Option	Type	Usage	Description
`update`	function	`@update="fn"`	Gets triggered when the croppie element has been zoomed, dragged or cropped
`result`	function	`@result="fn"`	Gets triggered when the image has been cropped. Returns the cropped image.
`croppieInitialized`	function	`@croppieInitialized="fn"`	Gets triggered when the croppie gets initialized.

Note:

@result event is only available if NO callback function was passed to this.$refs.croppieRef.result({}). See here

FAQ

How to clear/destroy coppie?

I added a new method called refresh() and can be used as this.$refs.croppieRef.refresh(), but the croppie instance is now being refreshed automatically after every crop() invocation.

Helpful links #358 - Official croppie page.

Updates

1.3.0 - Aug 16, 2017

Added webpack build
Fixes #5
Fixes #14

1.2.5 - Aug 12, 2017

Cropped image output can now be retrieve via vue event.
Added result event.
Added updated event.

1.2.3

Added automatic refreshing of croppie instance after every crop() invocation.
New method refresh() which destroys and re-create the croppie instance.

1.2.x

Result options are now being passed through the this.$refs.croppieRef.result(options, callback).

License

MIT

Use and abuse at your own risk.

</p> with ❤️ by Jofferson Ramirez Tiquez

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More