Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including ng2-bar-rating with all npm packages installed. Try it out:

require("@angular/common/package.json"); // @angular/common is a peer dependency. require("@angular/core/package.json"); // @angular/core is a peer dependency. require("@angular/forms/package.json"); // @angular/forms is a peer dependency. var ng2BarRating = require("ng2-bar-rating")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

ng2-bar-rating v1.1.50

Angular2+ Bar Rating

Angular Bar Rating

Minimal, light-weight Angular ratings.

npm npm Build Status npm


THIS IS NOT THE MODULE YOU ARE LOOKING FOR! Please use! This repository exists only for security awareness and training purposes to demonstrate the issue of typosquatting within the OWASP Juice Shop! Please check out and for more information!

Table of Contents


Install it with npm

npm install --save ng2-bar-rating


If you are using SystemJS, you should also adjust your configuration to point to the UMD bundle.

In your systemjs config file, map needs to tell the System loader where to look for ng2-bar-rating:

map: {
  'ng2-bar-rating': 'node_modules/ng2-bar-rating/bundles/ngx-bar-rating.umd.js',

Here is a working plunkr | stackblitz

Basic usage:

Import BarRatingModule in the root module

import { BarRatingModule } from "ng2-bar-rating";

  imports: [
    // ...

In your template

<bar-rating [(rate)]="rate" [max]="5"></bar-rating>

Rating options (inputs):

  • [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 max value, 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.

  • (hover): An event fired when a user is hovering over a given rating.

    Event's payload equals to the rating being hovered over.

  • (leave): An event fired when a user stops hovering over a given rating.

    Event's payload equals to the rating of the last item being hovered over.

Movie rating example

<bar-rating [(rate)]="rate" [max]="4" [theme]="'movie'" [showText]="true"
 [titles]="['Bad', 'Mediocre' , 'Good', 'Awesome']"></bar-rating>

It can be used with angular forms and reactive forms, for example:

<form #form="ngForm">
  <bar-rating name="rating" [(ngModel)]="formRating" [max]="4" required disabled></bar-rating>
<p>form is valid: {{ form.valid ? 'true' : 'false' }}</p>
<pre>{{ formRating }}</pre>

Predefined themes

Add the rating theme either in index.html

<link rel="stylesheet" href="../node_modules/ng2-bar-rating/themes/br-default-theme.css"/>

Or in the global style style.scss (recommended)

  • Pure css stars (default) [theme]="'default'"
@import '~ngx-bar-rating/themes/br-default-theme'
  • Bootstrap stars [theme]="'bootstrap'"
@import '~ngx-bar-rating/themes/br-bootstrap-theme';
  • Fontawesome stars [theme]="'fontawesome'"
@import '~ngx-bar-rating/themes/br-fontawesome-theme';
  • Fontawesome-o stars [theme]="'fontawesome-o'"
@import '~ngx-bar-rating/themes/br-fontawesome-o-theme';
  • Horizontal bars [theme]="'horizontal'"
@import '~ngx-bar-rating/themes/br-horizontal-theme';
  • Vertical bars [theme]="'vertical'"
@import '~ngx-bar-rating/themes/br-vertical-theme';
  • Custom stars [theme]="'stars'"
@import '~ngx-bar-rating/themes/br-stars-theme';
  • Movie rating [theme]="'movie'"
@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

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free