# Rating Group
Rating Group allows users to rate something

```svelte
// Error loading file, please report this issue.
```

## Allow Half

```svelte
// Error loading file, please report this issue.
```

## Custom Icons

```svelte
// Error loading file, please report this issue.
```

## Label

```svelte
// Error loading file, please report this issue.
```

## Disabled

```svelte
// Error loading file, please report this issue.
```

## Direction

```svelte
// Error loading file, please report this issue.
```

## API Reference

### RatingGroupRoot

| Property | Type | Description |
| --- | --- | --- |
| `ids` | Partial<{ root: string; label: string; hiddenInput: string; control: string; item: (id: string) => string; }>, undefined | The ids of the elements in the rating. Useful for composition. |
| `translations` | IntlTranslations, undefined | Specifies the localized strings that identifies the accessibility elements and their states |
| `count` | number, undefined | The total number of ratings. Default: 5 |
| `name` | string, undefined | The name attribute of the rating element (used in forms). |
| `form` | string, undefined | The associate form of the underlying input element. |
| `value` | number, undefined | The controlled value of the rating |
| `defaultValue` | number, undefined | The initial value of the rating when rendered. Use when you don't need to control the value of the rating. |
| `readOnly` | boolean, undefined | Whether the rating is readonly. |
| `disabled` | boolean, undefined | Whether the rating is disabled. |
| `required` | boolean, undefined | Whether the rating is required. |
| `allowHalf` | boolean, undefined | Whether to allow half stars. |
| `autoFocus` | boolean, undefined | Whether to autofocus the rating. |
| `onValueChange` | ((details: ValueChangeDetails) => void), undefined | Function to be called when the rating value changes. |
| `onHoverChange` | ((details: HoverChangeDetails) => void), undefined | Function to be called when the rating value is hovered. |
| `dir` | "ltr", "rtl", undefined | The document's text/writing direction. Default: "ltr" |
| `getRootNode` | (() => ShadowRoot, Node, Document), undefined | A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron. |
| `element` | Snippet<[HTMLAttributes<"div">]>, undefined | Render the element yourself |

### RatingGroupRootProvider

| Property | Type | Description |
| --- | --- | --- |
| `value`* | () => RatingGroupApi<PropTypes> |  |
| `element` | Snippet<[HTMLAttributes<"div">]>, undefined | Render the element yourself |

### RatingGroupRootContext

| Property | Type | Description |
| --- | --- | --- |
| `children`* | Snippet<[() => RatingGroupApi<PropTypes>]> |  |

### RatingGroupLabel

| Property | Type | Description |
| --- | --- | --- |
| `element` | Snippet<[HTMLAttributes<"label">]>, undefined | Render the element yourself |

### RatingGroupControl

| Property | Type | Description |
| --- | --- | --- |
| `element` | Snippet<[HTMLAttributes<"div">]>, undefined | Render the element yourself |

### RatingGroupItem

| Property | Type | Description |
| --- | --- | --- |
| `empty` | Snippet<[]>, undefined | The content to render when the item is in the empty state. Default: StarEmpty (SVG) |
| `half` | Snippet<[]>, undefined | The content to render when the item is in the half state. Default: StarHalf (SVG) |
| `full` | Snippet<[]>, undefined | The content to render when the item is in the full state. Default: StarFull (SVG) |
| `index`* | number |  |
| `element` | Snippet<[HTMLAttributes<"span">]>, undefined | Render the element yourself |

### RatingGroupHiddenInput

| Property | Type | Description |
| --- | --- | --- |
| `element` | Snippet<[HTMLAttributes<"input">]>, undefined | Render the element yourself |