PHP Classes

File: vendors/gentelella/vendors/starrr/README.md

Recommend this page to a friend!
  Classes of Jorge Castro   Gentelella BladeOne   vendors/gentelella/vendors/starrr/README.md   Download  
File: vendors/gentelella/vendors/starrr/README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Gentelella BladeOne
Render templates using Bootstrap for presentation
Author: By
Last change:
Date: 3 years ago
Size: 819 bytes
 

Contents

Class file image Download

starrr

1-5 (or 1-n) star rating in < 75 lines of code.

Requirements

  • jQuery

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)
})

Developing

  • `npm install`
  • `npm install -g grunt-cli`
  • Make changes in `src/`
  • Run `grunt` to compile them

License

MIT