cropperjs README

The project's README from github.com/fengyuanchen/cropperjs. As one markdown file: README.md.

Cropper.js

Coverage Status Downloads Version Gzip Size

JavaScript image cropper. This is the branch for v2.x. For v1.x, check out the v1 branch.

Versioning

Maintained under the Semantic Versioning guidelines.

Commit Message Guidelines

Git commits message follows the Conventional Commits guidelines.

License

MIT © Chen Fengyuan

cropperjs (fengyuanchen/cropperjs)

Searching Database…

13.9K ·GitHub
What is this?Cropper.js is a JavaScript image cropper for the web: you embed it in a page and users get an interactive way to crop images right in the browser.
Is this a finished cropping app, or a library I build with?It's a front-end library, not a standalone app — you import it into your own web page and build the cropping experience into your site with your own UI around it.
How do I add it to my project?Install the cropperjs package from npm (npm install cropperjs) and import it into your code; the README links to the project website for the full documentation.
Does it pull in a pile of dependencies?No — the package defines zero runtime dependencies, so nothing extra gets dragged into your bundle.
I saw mentions of v1 and v2 — which one am I getting?Mind the major version: this branch is the v2.x line with its own API, while the older v1.x is kept on a separate v1 branch, so tutorials for one may not match the other.
Is this something end users install, or is it for developers?It's for web developers — you integrate it into your app, and your end users only ever see the crop interface inside your page.
Can I use it with React, Vue or Angular?The core is framework-agnostic, but the README links community wrappers, including cropperjs-react-wrapper (compatible with v2), react-cropper, vue-cropperjs, angular-cropperjs, ember-cropperjs and blazor-cropperjs.
Is it free to use in commercial projects?Yes — it's MIT-licensed, so commercial use is fine as long as the copyright notice is kept.
Will it play nicely with my TypeScript setup?The library itself is written in TypeScript — GitHub lists it as the project's main language — so you work with typed APIs rather than bolting types on afterwards.
Size
17 MB
Stars
13.9K
Age
11y
Commits · 90 Days