Starrr

Simple star/rating input field.

Courtesy: https://github.com/dobtco/starrr

Installation

Add this line to your application's Gemfile:

gem 'starrr'

And then execute:

$ bundle

Or install it yourself as:

$ gem install starrr

Generate starter code

$ rails g starrr core_extensions

Import javascript file

//= require starrr.js

Import css file

@import "starrr";

Usage

Create the stars

<div class='starrr'></div>

$('.starrr').starrr()

With an existing rating

$('.starrr').starrr({
  rating: 4
})

With more than 5 stars

$('.starrr').starrr({
  max: 10
})

Read-only

$('.starrr').starrr({
  readOnly: true
})

Do something with the rating...

$('.starrr').starrr({
  change: function(e, value){
    alert('new rating is ' + value)
  }
})

Or if you prefer events:

$('.starrr').on('starrr:change', function(e, value){
  alert('new rating is ' + value)
})

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sikandartariq1/starrr.

License

The gem is available as open source under the terms of the MIT License.