# StarRating Documentation

## Installation

```bash
jsrepo add ui/star-rating
```

## Components

### Root

The root component for the Star Rating. Forwards all props and behavior to bits-ui RatingGroup.Root.

#### Props

| Prop | Type | Default Value | Required | Bindable | Description |
|------|------|--------------|----------|----------|-------------|


### Star

A single star in the Star Rating component. Used internally to render each star with its state.

#### Props

| Prop | Type | Default Value | Required | Bindable | Description |
|------|------|--------------|----------|----------|-------------|
| index | number | - | false | false | The index of the star in the rating group. |
| state | "active" | "partial" | "inactive" | - | false | false | The visual state of the star: active (filled), partial (half-filled), or inactive (empty). |
| class | string | - | false | false | Additional classes to apply to the star. |