
Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
A vanilla JavaScript image cropper that's lightweight, awesome, and has absolutely zero dependencies.
Via NPM:
npm install croppr -—save
// CommonJS
var Croppr = require('croppr');
// ES6 import
import Croppr from 'croppr';
Note: Don't forget to bundle or include croppr.css!
Via Bower:
bower install croppr
Then include via script tag below.
Via script tag:
<link href="path/to/croppr.css" rel="stylesheet"/>
<script src="path/to/croppr.js"></script>
In your HTML document:
<img src="path/to/image.jpg" id="croppr"/>
In your JavaScript file:
var cropInstance = new Croppr('#croppr', {
// ...options
});
Protip: You can also pass an Element
object directly instead of a selector.
To retrieve crop region:
var data = cropInstance.getValue();
// data = {x: 20, y: 20: width: 120, height: 120}
Constrain the crop region to an aspect ratio.
Number
null
aspectRatio: 1
(Square)Constrain the crop region to a maximum size.
[width, height, unit?]
null
maxSize: [50, 50, '%']
(A maximum size of 50% of the image size)Note: unit
accepts a value of 'px' or '%'. Defaults to 'px'.
Constrain the crop region to a minimum size.
[width, height, unit?]
null
minSize: [20, 20, 'px']
(A minimum width and height of 20px)Note: unit
accepts a value of 'px' or '%'. Defaults to 'px'.
The starting size of the crop region when it is initialized.
[width, height, unit?]
[100, 100, '%']
(A starting crop region as large as possible)startSize: [50, 50]
(A starting crop region of 50% of the image size)Note: unit
accepts a value of 'px' or '%'. Defaults to '%'.
A callback function that is called when the user starts modifying the crop region.
Function
data = {x, y, width, height}
onCropStart: function(data) {
console.log(data.x, data.y, data.width, data.height);
}
A callback function that is called when the crop region changes.
Function
data = {x, y, width, height}
onCropMove: function(data) {
console.log(data.x, data.y, data.width, data.height);
}
A callback function that is called when the user stops modifying the crop region.
Function
data = {x, y, width, height}
onCropEnd: function(data) {
console.log(data.x, data.y, data.width, data.height);
}
A callback function that is called when the Croppr instance is fully initialized.
Function
onInitialize: function(instance) {
// do things here
}
Define how the crop region should be calculated.
String
"real"
"real"
, "ratio"
or "raw"
real
returns the crop region values based on the size of the image's actual sizes. This ensures that the crop region values are the same regardless if the Croppr element is scaled or not.ratio
returns the crop region values as a ratio between 0 to 1. e.g. For example, an x, y
position at the center will be {x: 0.5, y: 0.5}
.raw
returns the crop region values as is based on the size of the Croppr element.Returns the value of the crop region. returnMode
inherits from options by default. Refer to returnMode for possible values.
var value = cropInstance.getValue();
// value = {x: 21, y: 63: width: 120, height: 120}
var ratio = cropInstance.getValue('ratio');
// value = {x: 0.1, y: 0.3: width: 0.57, height: 0.57}
Destroys the Croppr instance and restores the original img
element.
Changes the image src. Returns the Croppr instance.
Moves the crop region to the specified coordinates. Returns the Croppr instance.
Resizes the crop region to the specified size. origin
is an optional argument that specifies the origin point (in ratio) to resize from in the format of [x, y]
. Defaults to [0.5, 0.5]
(center). Returns the Croppr instance.
Scales the crop region by a factor. origin
is an optional argument that specifies the origin point (in ratio) to resize from in the format of [x, y]
. Defaults to [0.5, 0.5]
(center). Returns the Croppr instance.
Resets the crop region to its original position and size. Returns the Croppr instance.
Copyright © 2018 James Ooi. Released under the MIT License.
FAQs
A vanilla JavaScript image cropper that's lightweight, awesome, and has absolutely zero dependencies.
The npm package croppr receives a total of 0 weekly downloads. As such, croppr popularity was classified as not popular.
We found that croppr demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
Security News
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.