ref | Ref<unknown> | null | The reference to the component instance. |
pIf | boolean | true | Whether the component should be rendered. |
style | CSSProperties | ((instance?: RatingInstance) => CSSProperties) | null | The style to apply to the component. |
className | string | ((instance?: RatingInstance) => string) | null | The class name to apply to the component. |
as | string | number | bigint | boolean | ComponentClass<any, any> | FunctionComponent<any> | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode, any, any> | ReactPortal | Promise<AwaitedReactNode> | null | The component type to render. |
asChild | boolean | false | Whether the component should be rendered as a child component. |
pt | SafeRecord<RatingPassThrough> | null | The pass-through props to pass to the component |
ptOptions | PassThroughOptions | null | The pass-through options to pass to the component |
unstyled | boolean | null | Whether the component should be rendered without classes. |
dt | unknown | null | The design token to use for the component. |
styles | StylesOptions<ComponentInstance> | null | The styles to use for the component. |
children | ReactNode | ((instance: RatingInstance) => ReactNode) | null | The children to render. |
name | string | null | Name of the element. |
invalid | boolean | false | When present, it specifies that the component should have invalid state style. |
onIcon | ReactNode | null | Icon for the on state. |
offIcon | ReactNode | null | Icon for the off state. |
modelValue | number | null | Value of the rating. |
defaultValue | number | null | The default value for the input when not controlled by `modelValue` . |
stars | number | 5 | Number of stars. |
disabled | boolean | false | When present, it specifies that the element should be disabled. |
readOnly | boolean | false | When present, it specifies that component is read-only. |
onChange | (event: useRatingChangeEvent) => void | null | Callback function that is called when the value changes. |
[key: string] | any | null | |
pt-{optionName}-* | - | null | Pass through attributes for customizing component. For more info, see Pass Through tab. |