# `m-star-rating`

A Star rating visually represents a score or evaluation and can be used to display a rating or allow users to rate an item, such as a product or service. It serves two main purposes: collecting user feedback by enabling individuals to express their experience and providing social proof by displaying ratings from other users to assist decision-making. Rating Stars are commonly found in e-commerce, review systems, and feedback interfaces, offering a quick and intuitive way to assess quality or satisfaction.

## Props

| Name | Description | Type | Default |
|------|-------------|------|---------|
| `rating*` | The current rating value of the component. | `number` | `$bindable()` |
| `readonly` | Determines whether the rating is interactive or read-only.
When true, all user interactions (click, hover, keyboard) are disabled.
Automatically set to true when `compact`, `href`, or `information` are provided. | `boolean` |   |
| `size` | Defines the visual size of the star icons and the accompanying text. | `'s'` `'m'` `'l'` | `m` |
| `compact` | Enables a compact display mode that shows only one star instead of five.
Typically used for summaries or quick visual cues.
When enabled, the component automatically becomes read-only. | `boolean` |   |
| `appearance` | Specifies the color scheme of the stars. | `'standard'` `'accent'` | `standard` |
| `text` | Optional text displayed next to the star rating.
If provided, the component automatically becomes read-only. | `string` |   |
| `href` | URL for the link. | `string` |   |
| `target` | Where to open the link. | `'_self'` `'_blank'` `'_parent'` `'_top'` |   |

