RatingField

Renders a numeric rating as a row of stars.

Installation

pnpm dlx shadcn@latest add @chelone/rating-field

Loading preview…

Renders a numeric rating as a row of stars.

Props

Prop	Type	Default	Description
allowHalf	boolean	—	Allow half-star granularity when value is between integers.
cellClassName	string	—	A class name to apply to the cell element when used inside `<DataTable>`.
className	string	—	A class name to apply to the root element.
countSource	SourceKey<RecordType>	—	Sibling record field rendered in parentheses (e.g. review count). A top-level key, not a path: the read is `record[countSource]`.
defaultValue	SourceValue<RecordType, SourceProp<RecordType>>	—
empty	ReactNode	—	The node to display when the field value is empty. Defaults to nothing. A string is translated; a ReactNode renders as-is.
headerClassName	string	—	A class name to apply to the header cell element when used inside `<DataTable>`.
label	ReactNode	—	Label to use as column header when using `<DataTable>` or `<SimpleShowLayout>`. Defaults to the capitalized field name. Set to `false` to disable the label.
max	number	—	Total stars rendered (filled + outlined). Default 5.
record	RecordType	—	The record to render. Defaults to the ambient `RecordContext` value.
resource	string	—	The resource name. Defaults to the ambient `ResourceContext` value.
sortable	boolean	—	Disable the header click handler when used inside `<DataTable>`.
sortBy	string	—	The field to sort by when this column head is clicked, if sortable.
sortByOrder	SortOrder	—	The order used for sorting when this column head is clicked, if sortable.
source	SourceProp<RecordType>	—	Name of the property to display (dot/bracket path).
textAlign	TextAlign	—	The text alignment for the cell content, when used inside `<DataTable>`.