Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 2.04 KB

README.md

File metadata and controls

53 lines (40 loc) · 2.04 KB
Raw

angular-area-select

Only 7kb (compared to 16kb for jCrop) with NO jQuery dependency!

A more lightweight (less feature rich) version of jCrop. Can also be used for non-images as well (generic area select).

Select an area (image or otherwise) with mouse or touch, i.e. for crop. Can set aspect ratio.

Demo

http://jackrabbitsgroup.github.io/angular-area-select/

Dependencies

  • optional
    • lesshat

See bower.json and index.html in the gh-pages branch for a full list / more details

Install

  1. download the files
    1. Bower
      1. add "angular-area-select": "latest" to your bower.json file then run bower install OR run bower install angular-area-select
  2. include the files in your app
    1. area-select.min.js
    2. area-select.less OR area-select.min.css OR area-select.css
  3. include the module in angular (i.e. in app.js) - jackrabbitsgroup.angular-area-select

See the gh-pages branch, files bower.json and index.html for a full example.

Documentation

See the area-select.js file top comments for usage examples and documentation https://github.com/jackrabbitsgroup/angular-area-select/blob/master/area-select.js

Development

  1. git checkout gh-pages
    1. run npm install && bower install
    2. write your code then run grunt
    3. git commit your changes
  2. copy over core files (.js and .css/.less for directives) to master branch
    1. git checkout master
    2. git checkout gh-pages area-select.js area-select.min.js area-select.less area-select.css area-select.min.css
  3. update README, CHANGELOG, bower.json, and do any other final polishing to prepare for publishing
    1. git commit changes
    2. git tag with the version number, i.e. git tag v1.0.0
  4. create github repo and push
    1. [if remote does not already exist or is incorrect] git remote add origin [github url]
    2. git push origin master --tags (want to push master branch first so it is the default on github)
    3. git checkout gh-pages
    4. git push origin gh-pages
  5. (optional) register bower component
    1. bower register angular-area-select [git repo url]