Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/MurhafSousli/ngx-bar-rating

Angular Bar Rating
https://github.com/MurhafSousli/ngx-bar-rating

angular bar bar-rating rate rating stars

Last synced: 24 days ago
JSON representation

Angular Bar Rating

Awesome Lists containing this project

README 

        


  

  
Angular Bar Rating


  
Minimal, light-weight Angular ratings.



[![npm](https://img.shields.io/badge/demo-online-ed1c46.svg)](https://ngx-bar-rating.netlify.app/)

[![npm](https://img.shields.io/badge/stackblitz-online-orange.svg)](https://stackblitz.com/edit/ngx-bar-rating)

[![npm](https://img.shields.io/npm/v/ngx-bar-rating.svg)](https://www.npmjs.com/package/ngx-bar-rating)

[![npm](https://img.shields.io/npm/l/express.svg?maxAge=2592000)](/LICENSE)



___



If you like this plugin, please give it a star ⭐.



## Table of Contents



- [Live Demo](https://ngx-bar-rating.netlify.app/)

- [Installation](#installation)

- [Usage](#usage)

- [Options](#options)

- [Themes](#themes)

- [Issues](#issues)

- [Author](#author)






## Installation



Install it with npm



```bash

npm i ngx-bar-rating

```






## Basic usage:



Import `BarRating` or `BarRatingModule` in your component imports.



```ts

@Component({

  standalone: true,

  selector: 'bars',

  template: `

    

  `,

  styleUrl: './example.component.scss',

  imports: [BarRating]

})

export class BarsComponent {

  rate: number = 4;

}

```



Import the theme in your global styles (unless you want to use custom template)



```scss

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

```






## Rating inputs and outputs:



| Name             | Description                                                          | Default |

|------------------|----------------------------------------------------------------------|---------|

| **[rate]**       | Current rating. Can be a decimal value like 3.14                     | null    |

| **[max]**        | Maximal rating that can be given using this widget                   | 5       |

| **[theme]**      | Theme class, see available [themes](#themes)                         | default |

| **[readonly]**   | A flag that indicates if rating can be changed                       | false   |

| **[showText]**   | Display rating title if available, otherwise display rating value    | false   |

| **[required]**   | A flag that indicates if rating is disabled. works only with forms   | false   |

| **[disabled]**   | A flag that indicates if rating is disabled. works only with forms   | false   |

| **[titles]**     | Titles array. array should represent all possible values including 0 | []      |

| **(rateChange)** | A stream that emits when the rating value is changed                 |         |



### Custom rating template



`BarRatingModule` provides a couple of directives to set custom rating template of your choice.



- `*ratingActive`: Set template, when a bar/star is active or hovered.

- `*ratingInactive`: Set template, when a bar/star is inactive.

- `*ratingFraction`: Set template, when a bar/star is a fraction.



Here are some example:



#### Bootstrap rating example



```html



  

  



```



#### FontAwesome rating example



```html



  

  

  



```



#### Movie rating example



```html



```



It can be used with Angular forms:



```html



  



form is valid: {{ form.valid ? 'true' : 'false' }}


{{ formRating }}


```



And reactive forms:



```html



  



form is valid: {{ form.valid ? 'true' : 'false' }}


{{ formRating }}


```



## CSS variables



- `--br-font-size` Sets the size of the step for the following themes: [`default`, `square`, `stars`].

- `--br-width` Sets the width of the step for the following themes: [`stars`, `square`, `movie`, `vertical`, `horizontal`].

- `--br-height` Sets the height of the step for the following themes: [`stars`, `square`, `movie`, `vertical`, `horizontal`].

- `--br-gap` Sets the gap between the stars.

- `--br-active-color` Sets active color.

- `--br-inactive-color` Sets inactive color.






## Predefined themes



> If you want to use a custom rating template, you don't need to import any CSS theme.



If you want to use one of the predefined themes, you will need to import it in the global style `style.scss`



- Pure CSS stars (default) `theme="default"`



```css

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

```



- Horizontal bars `theme="horizontal"`



```css

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

```



- Vertical bars `theme="vertical"`



```css

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

```



- Custom stars `theme="stars"`



```css

@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"`



```css

@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`






## Issues



If you identify any errors in this component, or have an idea for an improvement, please open

an [issue](https://github.com/MurhafSousli/ngx-bar-rating/issues). I am excited to see what the community thinks of this

project, and I would love your input!






## Author



**Murhaf Sousli**



- [github/murhafsousli](https://github.com/MurhafSousli)

- [twitter/murhafsousli](https://twitter.com/MurhafSousli)