Elements

Reference

Rating Group

RatingGroup, dressed in the paper-and-ink system: a row of quiet seals whose glyphs take the primary pigment as they light up. The parts — Root, Label, Control, Item, HiddenInput (plus the Context and ItemContext render helpers).

Root · Label · Item · Control

#Control

A styled part — no props of its own; it takes the anatomy's shared styling.

#HiddenInput

A styled part — no props of its own; it takes the anatomy's shared styling.

#ItemContext

A styled part — no props of its own; it takes the anatomy's shared styling.

#Item

PropTypeDefaultDescription
indexnumber—

#Label

A styled part — no props of its own; it takes the anatomy's shared styling.

#Root

PropTypeDefaultDescription
sizeString as PropType<"sm" | "md" | "lg">"md"One rung of the control-height ladder every seal stands on.
allowHalfbooleanWhether to allow half stars.
autoFocusbooleanWhether to autofocus the rating.
countnumber5The total number of ratings.
defaultValuenumberThe initial value of the rating when rendered. Use when you don't need to control the value of the rating.
disabledbooleanWhether the rating is disabled.
formstringThe associate form of the underlying input element.
idstringThe unique identifier of the machine.
idsPartial<{ root: string; label: string; hiddenInput: string; control: string; item(id: string): string; }>The ids of the elements in the rating. Useful for composition.
modelValuenumberThe v-model value of the rating group
namestringThe name attribute of the rating element (used in forms).
readOnlybooleanWhether the rating is readonly.
requiredbooleanWhether the rating is required.
translationsratingGroup.IntlTranslationsSpecifies the localized strings that identifies the accessibility elements and their states
EventPayload
valueChangedetails: ValueChangeDetails
update:modelValuevalue: number
hoverChangedetails: HoverChangeDetails