Angular Bar Rating
Minimal, light-weight Angular ratings.
Install it with npm
npm i ngx-bar-rating
Import
BarRatingModulein the root module
import { BarRatingModule } from "ngx-bar-rating";@NgModule({ imports: [ // ... BarRatingModule ] })
In your template
[rate]: Current rating. Can be a decimal value like 3.14, default
undefined.
[max]: Maximal rating that can be given using this widget, default
5
[readOnly]: A flag indicating if rating can be updated, default
false
[theme]: Theme class. default
default, see available themes.
[showText]: Display rating title if set, otherwise display rating value, default
false.
[titles]: Titles array. array length should be equal to the
maxvalue, each index represents the rating title, default
[].
[required]: A flag indicating if rating is required for form validation. default
false.
[disabled]: A flag indicating if rating is disabled. works only with forms, default
false.
(rateChange): An event fired when a user selects a new rating.
Event's payload equals to the newly selected rating.
Event's payload equals to the rating being hovered over.
Event's payload equals to the rating of the last item being hovered over.
It can be used with angular forms and reactive forms, for example:
form is valid: {{ form.valid ? 'true' : 'false' }}
{{ formRating }}
Add the rating theme either in
index.html
Or in the global style
style.scss(recommended)
[theme]="'default'"
@import '~ngx-bar-rating/themes/br-default-theme'
[theme]="'bootstrap'"
@import '~ngx-bar-rating/themes/br-bootstrap-theme';
[theme]="'fontawesome'"
@import '~ngx-bar-rating/themes/br-fontawesome-theme';
[theme]="'fontawesome-o'"
@import '~ngx-bar-rating/themes/br-fontawesome-o-theme';
[theme]="'horizontal'"
@import '~ngx-bar-rating/themes/br-horizontal-theme';
[theme]="'vertical'"
@import '~ngx-bar-rating/themes/br-vertical-theme';
[theme]="'stars'"
@import '~ngx-bar-rating/themes/br-stars-theme';
Movie rating
[theme]="'movie'"
css @import '~ngx-bar-rating/themes/br-movie-theme';
Square rating
[theme]="'square'"
@import '~ngx-bar-rating/themes/br-square-theme';
Rating style can be easily customized, check the classes used in any theme and add your own css.
You can also do the same for forms classes such as
untouched, touched, dirty, invalid, valid ...etc
If you have a nice rating style you would like to share, prupose your theme and I will include it in the package.
If you identify any errors in this component, or have an idea for an improvement, please open an issue. I am excited to see what the community thinks of this project, and I would love your input!
Murhaf Sousli