createRating API
API reference for the createRating composable.
(_options?: RatingOptions) => RCreates a rating instance.
(_options?: RatingContextOptions) => ContextTrinity<R>Creates a rating context for dependency injection.
(namespace?: string) => RReturns the current rating instance from context.
number | ShallowRef<number> | undefinedInitial value or ref for v-model.
Default: 0
MaybeRefOrGetter<number> | undefinedTotal items.
Default: 5
MaybeRefOrGetter<boolean> | undefinedEnable 0.5 step increments.
Default: false
WritableComputedRef<number, number>Current rating, clamped to 0–size
booleanWhether half-steps are enabled
ComputedRef<RatingItemDescriptor[]>Array of items with computed state
Readonly<Ref<boolean, boolean>>Whether value is at minimum (0)
Readonly<Ref<boolean, boolean>>Whether value is at maximum (size)
(value: number) => voidSet rating to specific value
() => voidIncrement by step (1 or 0.5)
() => voidDecrement by step (1 or 0.5)
