# @fayegram-ai/faye-ui/controls/rating

Public exports and dependency-resolved component properties, with usage and rendering guidance.

## Import

```tsx
import { Rating } from '@fayegram-ai/faye-ui/controls/rating';
```

[Usage and behavior guide](/docs/numeric/) · [API JSON](/api/packages/controls/rating.json)

This entry declares a client boundary. Follow the rendering guide for framework integration.

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `Rating` | value | `(input: RatingProps) => import("react").JSX.Element` |
| `RatingProps` | type | `RatingProps` |

## Rating

Public component; use the linked family guide for complete composition and behavior.

Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.

### Properties

| Property | Required | Type | Meaning |
|---|---|---|---|
| `clearable` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `clearLabel` | No | `string \| undefined` | See the usage contract and declaration. |
| `defaultValue` | No | `number \| undefined` | See the usage contract and declaration. |
| `disabled` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `emptyIcon` | No | `ReactNode` | See the usage contract and declaration. |
| `form` | No | `string \| undefined` | See the usage contract and declaration. |
| `getValueLabel` | No | `((value: number, max: number) => string) \| undefined` | See the usage contract and declaration. |
| `icon` | No | `ReactNode` | Decorative artwork. Supply matching empty/filled geometry; native rating semantics stay intact. |
| `label` | Yes | `string` | See the usage contract and declaration. |
| `max` | No | `number \| undefined` | See the usage contract and declaration. |
| `name` | No | `string \| undefined` | See the usage contract and declaration. |
| `onPreviewChange` | No | `((value: number \| null) => void) \| undefined` | Pointer preview does not change the selected or submitted value; null means no preview. |
| `onValueChange` | No | `((value: number) => void) \| undefined` | See the usage contract and declaration. |
| `precision` | No | `number \| undefined` | See the usage contract and declaration. |
| `readOnly` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `value` | No | `number \| undefined` | See the usage contract and declaration. |



## Defaults and customization

Descriptor defaults: ``. Parts: `root`, `item`. Explicit instance props take precedence over configured defaults.

Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.

## State, events and accessibility

For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.

## Declaration authority

Generated from `packages/faye-ui/dist/controls/rating.d.ts` after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. [React DOM attributes](https://react.dev/reference/react-dom/components/common) and [Base UI component contracts](https://base-ui.com/react/overview/quick-start) describe the inherited foundations.