Rating API · Needless UI

Import

import-rating.ts

import { NuiRating } from '@needless-ui/angular/rating';

A radio group of stars, or a read-only picture of a rating.

NuiRating: Properties
Name	Type	Default	Description
`value`Two-way	`number \| null`	`null`	The rating, or `null`. Also works with forms.
`max`Input	`number`	`5`	Number of stars.
`readonly`Input	`boolean`	`false`	Shows the value, to any fraction, instead of asking for one.
`disabled`Input	`boolean`	`false`	Disables every star.
`clearable`Input	`boolean`	`false`	Choosing the current star again clears the rating.
`name`Input	`string`		Name shared by the radio buttons. Generated by default.
`starLabel`Input	`(value: number) => string`		Accessible name of each star, as a function of its value.
`readonlyLabel`Input	`(value: number, max: number) => string`		Accessible name in read-only mode.