Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/medhatdawoud/angular-rating
angular-rating is a module to help you create a rating with some cusomizable options
https://github.com/medhatdawoud/angular-rating
Last synced: about 17 hours ago
JSON representation
angular-rating is a module to help you create a rating with some cusomizable options
- Host: GitHub
- URL: https://github.com/medhatdawoud/angular-rating
- Owner: medhatdawoud
- Created: 2016-05-24T10:42:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-30T22:48:46.000Z (about 8 years ago)
- Last Synced: 2025-01-03T15:05:27.432Z (27 days ago)
- Homepage: https://goo.gl/tR3SsK
- Size: 33.2 KB
- Stars: 5
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Angular Rating
> is a module to help you create a rating with some cusomizable options
Current Version
---------------
```
3.0.3
```
Installation
------------
```
bower install angular-rating --save
```
OR
```
npm install angular-rating --save
```
Requirements
------------
- [AngularJS](http://angularjs.org) Version 1.5 at least
- [Bootstrap CSS](http://getbootstrap.com)
Usage
=====
### Setup
Just include the js file to your html
```html
```
Then, include the module in your code:
```javascript
angular.module('myModule', ['angular-rating'];
```
### Directive
This is a component, so at its most basic:
```html
```
This will render the rating contained in `foo` with maximum 5 stars, and 5 is the default if you don't provide max attribute.
`foo` should be an Integar:
```javascript
foo = 1;
foo = 3;
foo = 4;
```
### Attributes
- `value` is the only required attribute that should contain Integar as I mentioned above.
- `max` is optional and this is the whole number of stars you want to show at a time.
- `size` is optional, this option is to provide the size of stars as you want to view them and also provide its unit as well (20px is the default in case it's not provided), just like:
```html
```
- `color` is optional, this is the color of the filled stars, so you can choose a color of your choice if not it will be `#F3D82C` as default value,
the color can be a litteral color or HEX color prefixed by `#`.
```html
```
- `interactive` is optional, by default it's `true`, that means you can change the rating but if you assign it to `false` the rating will be disabled.
License
=======
MIT
Authors
=======
- Medhat Dawoud (@med7atdawoud)
- Peter Sobhy