ngx-bar-rating

Angular Bar Rating

Table of Contents

• Live Demo
• Installation
• Usage
• Options
• Themes
• Custom Style
• Author

Installation

Install it with npm

npm install --save ngx-bar-rating

SystemJS

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 ngx-bar-rating:

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

Here is a working plunkr

Basic usage:

Import BarRatingModule in the root module

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

@NgModule({
  imports: [
    // ...
    BarRatingModule
  ]
})

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.

• [readOnly]: A flag indicating if rating can be updated.

• [theme]: Theme class. default default, see available themes.

• [showText]: Display rating title if set, otherwise display rate value, default false.

• [titles]: Titles array. current rate value the title displayed each index of the array represents the rate value, 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'" [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>
</form>
<p>form is valid: {{ form.valid ? 'true' : 'false' }}</p>
<pre>{{ formRating }}</pre>

Predefined themes

Import rating theme using in the global style style.css

• pure css stars (default)

@import '~ngx-bar-rating/themes/br-default-theme';

• bootstrap stars

@import '~ngx-bar-rating/themes/br-bootstrap-theme';

• fontawesome stars

@import '~ngx-bar-rating/themes/br-fontawesome-theme';

• fontawesome-o stars

@import '~ngx-bar-rating/themes/br-fontawesome-o-theme';

• horizontal bars

@import '~ngx-bar-rating/themes/br-horizontal-theme';

• vertical bars

@import '~ngx-bar-rating/themes/br-vertical-theme';

• custom svg stars

@import '~ngx-bar-rating/themes/br-custom-stars-theme';

• movie rating

@import '~ngx-bar-rating/themes/br-movie-theme';

• square rating

@import '~ngx-bar-rating/themes/br-square-theme';

Custom Style

You can extend or create your own theme using these classes

.br {

  // rating wrapper

  .br-units {

    // units container
  }

  .br-unit {

    // units (stars)

    &.br-active{

      // hovered units (stars)
    } 
    &.br-selected {

      // selected units (stars)
    }
  }

  &.br-readonly {

    .br-active, .br-selected {
      
      // selected or active in read
    }
  }

  .br-text {
    
    // Rate text
  }
}

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, propuse your theme and I will include it in the package.

Issues

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!

Author

Murhaf Sousli

• github/murhafsousli
• twitter/murhafsousli

Changelog

0.9.0

• First release