- Name
service- Kind
- parameter
- Type
RatingService- Requirement
- required
DocsAPI referenceHeadlessrating
rating headless API
The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.
44 of 44
@grassroot/ui-headless-core/rating
Core connector and vanilla API
connectRating
functionconnectRatingts
declare function connectRating(service: RatingService, scope: PartScope, options?: RatingConnectOptions): RatingApi;Name
Kind
Type
Requirement
serviceparameter
RatingServicerequired
scopeparameter
PartScoperequired
optionsparameter
RatingConnectOptionsoptional
returnreturn value
RatingApin/a
- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
RatingConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
RatingApi- Requirement
- n/a
mountRating
functionmountRatingts
declare function mountRating(container: HTMLElement, options?: MountRatingOptions): RatingMount;Name
Kind
Type
Requirement
containerparameter
HTMLElementrequired
optionsparameter
MountRatingOptionsoptional
returnreturn value
RatingMountn/a
- Name
container- Kind
- parameter
- Type
HTMLElement- Requirement
- required
- Name
options- Kind
- parameter
- Type
MountRatingOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
RatingMount- Requirement
- n/a
MountRatingOptions
interfaceMountRatingOptionsts
interface MountRatingOptions extends RatingInput, Pick<RatingConnectOptions, "ariaLabel" | "messages"> { readonly onValueChange?: (detail: RatingChangeDetail) => void;}Name
Kind
Type
Requirement
onValueChangeproperty
(detail: RatingChangeDetail) => voidoptional
- Name
onValueChange- Kind
- property
- Type
(detail: RatingChangeDetail) => void- Requirement
- optional
ratingAnatomy
valueratingAnatomyts
export declare const ratingAnatomy: { readonly scope: "rating"; readonly parts: readonly ["root", "star"];};Name
Kind
Type
Requirement
partsproperty
readonly ["root", "star"]required
scopeproperty
"rating"required
- Name
parts- Kind
- property
- Type
readonly ["root", "star"]- Requirement
- required
- Name
scope- Kind
- property
- Type
"rating"- Requirement
- required
RatingApi
interfaceRatingApits
interface RatingApi { rootProps(): PartProps; starProps(index: number): PartProps; readonly value: number; readonly max: number; readonly readOnly: boolean;}Name
Kind
Type
Requirement
maxproperty
numberrequired
readOnlyproperty
booleanrequired
rootPropsmethod
() => PartPropsrequired
starPropsmethod
(index: number) => PartPropsrequired
valueproperty
numberrequired
- Name
max- Kind
- property
- Type
number- Requirement
- required
- Name
readOnly- Kind
- property
- Type
boolean- Requirement
- required
- Name
rootProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
starProps- Kind
- method
- Type
(index: number) => PartProps- Requirement
- required
- Name
value- Kind
- property
- Type
number- Requirement
- required
RatingChangeDetail
interfaceRatingChangeDetailts
interface RatingChangeDetail { readonly value: number; readonly reason: RatingReason;}Name
Kind
Type
Requirement
reasonproperty
RatingReasonrequired
valueproperty
numberrequired
- Name
reason- Kind
- property
- Type
RatingReason- Requirement
- required
- Name
value- Kind
- property
- Type
number- Requirement
- required
RatingConnectOptions
interfaceRatingConnectOptionsts
interface RatingConnectOptions { readonly ariaLabel?: string; readonly messages?: Partial<RatingMessages>; readonly onValueChange?: (detail: RatingChangeDetail) => void;}Name
Kind
Type
Requirement
ariaLabelproperty
stringoptional
messagesproperty
Partial<RatingMessages>optional
onValueChangeproperty
(detail: RatingChangeDetail) => voidoptional
- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
messages- Kind
- property
- Type
Partial<RatingMessages>- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: RatingChangeDetail) => void- Requirement
- optional
ratingMessages
valueratingMessagests
export declare const ratingMessages: RatingMessages;RatingMessages
typeRatingMessagests
type RatingMessages = Pick<MessageTable, "rootLabel" | "readOnlyLabel" | "starLabel">;RatingMount
interfaceRatingMountts
interface RatingMount { readonly service: RatingService; readonly connector: RatingApi; readonly root: HTMLElement; destroy(): void;}Name
Kind
Type
Requirement
connectorproperty
RatingApirequired
destroymethod
() => voidrequired
rootproperty
HTMLElementrequired
serviceproperty
RatingServicerequired
- Name
connector- Kind
- property
- Type
RatingApi- Requirement
- required
- Name
destroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
root- Kind
- property
- Type
HTMLElement- Requirement
- required
- Name
service- Kind
- property
- Type
RatingService- Requirement
- required
RatingPart
typeRatingPartts
type RatingPart = (typeof ratingAnatomy.parts)[number];RatingService
typeRatingServicets
type RatingService = Service<RatingInput, "ready", RatingContext, RatingEvent, RatingCommand>;runRatingCommand
functionrunRatingCommandts
declare function runRatingCommand(command: RatingCommand, options?: RatingConnectOptions): void;Name
Kind
Type
Requirement
commandparameter
RatingCommandrequired
optionsparameter
RatingConnectOptionsoptional
returnreturn value
voidn/a
- Name
command- Kind
- parameter
- Type
RatingCommand- Requirement
- required
- Name
options- Kind
- parameter
- Type
RatingConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
void- Requirement
- n/a
Framework adapters
Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.
React example follows below.
Vue example follows below.
Angular example follows below.
Svelte example follows below.
Solid example follows below.
React imports
@grassroot/ui-headless-react/ratingts
import { Root, RootProvider, Star } from "@grassroot/ui-headless-react/rating";Vue imports
@grassroot/ui-headless-vue/ratingts
<script setup lang="ts">import { Root, RootProvider, Star } from "@grassroot/ui-headless-vue/rating";</script>Angular imports
@grassroot/ui-headless-angular/ratingts
import { GrRatingRoot, GrRatingRootProvider, GrRatingStar } from "@grassroot/ui-headless-angular/rating";Svelte imports
@grassroot/ui-headless-svelte/ratingts
<script lang="ts"> import { Parts, Root, RootProvider } from "@grassroot/ui-headless-svelte/rating";</script>Solid imports
@grassroot/ui-headless-solid/ratingts
import { Root, RootProvider, Star } from "@grassroot/ui-headless-solid/rating";@grassroot/ui-headless-react/rating
React adapter
RatingRootProps
interfaceRatingRootPropsts
interface RatingRootProps extends Omit<HTMLAttributes<HTMLSpanElement>, "onChange" | "defaultValue" | "value">, RatingInput { readonly ariaLabel?: string; readonly id?: string; readonly onValueChange?: (detail: RatingChangeDetail) => void; readonly children?: ReactNode;}Name
Kind
Type
Requirement
ariaLabelproperty
stringoptional
childrenproperty
ReactNodeoptional
idproperty
stringoptional
onValueChangeproperty
(detail: RatingChangeDetail) => voidoptional
- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: RatingChangeDetail) => void- Requirement
- optional
RatingRootProviderProps
interfaceRatingRootProviderPropsts
interface RatingRootProviderProps extends Omit<HTMLAttributes<HTMLSpanElement>, "onChange"> { readonly value: UseRatingResult; readonly children?: ReactNode;}Name
Kind
Type
Requirement
childrenproperty
ReactNodeoptional
valueproperty
UseRatingResultrequired
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
value- Kind
- property
- Type
UseRatingResult- Requirement
- required
RatingStarProps
interfaceRatingStarPropsts
interface RatingStarProps extends HTMLAttributes<HTMLElement> { readonly index: number; readonly children?: ReactNode;}Name
Kind
Type
Requirement
childrenproperty
ReactNodeoptional
indexproperty
numberrequired
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
index- Kind
- property
- Type
number- Requirement
- required
Root
valueRootts
export declare const Root: import("react").ForwardRefExoticComponent<RatingRootProps & import("react").RefAttributes<HTMLSpanElement>>;Name
Kind
Type
Requirement
propsparameter
Prequired
returnreturn value
ReactNoden/a
- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
RootProvider
valueRootProviderts
export declare const RootProvider: import("react").ForwardRefExoticComponent<RatingRootProviderProps & import("react").RefAttributes<HTMLSpanElement>>;Name
Kind
Type
Requirement
propsparameter
Prequired
returnreturn value
ReactNoden/a
- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Star
valueStarts
export declare const Star: import("react").ForwardRefExoticComponent<RatingStarProps & import("react").RefAttributes<HTMLElement>>;Name
Kind
Type
Requirement
propsparameter
Prequired
returnreturn value
ReactNoden/a
- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
useRating
functionuseRatingts
declare function useRating(input: RatingInput, options?: UseRatingOptions): UseRatingResult;Name
Kind
Type
Requirement
inputparameter
RatingInputrequired
optionsparameter
UseRatingOptionsoptional
returnreturn value
UseRatingResultn/a
- Name
input- Kind
- parameter
- Type
RatingInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseRatingOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseRatingResult- Requirement
- n/a
UseRatingOptions
interfaceUseRatingOptionsts
interface UseRatingOptions { readonly id?: string; readonly ariaLabel?: string; readonly onValueChange?: (detail: RatingChangeDetail) => void;}Name
Kind
Type
Requirement
ariaLabelproperty
stringoptional
idproperty
stringoptional
onValueChangeproperty
(detail: RatingChangeDetail) => voidoptional
- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: RatingChangeDetail) => void- Requirement
- optional
UseRatingResult
interfaceUseRatingResultts
interface UseRatingResult { readonly service: RatingService; readonly connector: RatingApi; readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>; readonly snapshot: RatingSnapshot;}Name
Kind
Type
Requirement
connectorproperty
RatingApirequired
scopeproperty
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>required
serviceproperty
RatingServicerequired
snapshotproperty
RatingSnapshotrequired
- Name
connector- Kind
- property
- Type
RatingApi- Requirement
- required
- Name
scope- Kind
- property
- Type
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>- Requirement
- required
- Name
service- Kind
- property
- Type
RatingService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
RatingSnapshot- Requirement
- required
@grassroot/ui-headless-vue/rating
Vue adapter
Root
valueRootts
export declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ max: NumberConstructor; value: { type: PropType<number | undefined>; default: undefined; }; defaultValue: { type: PropType<number | undefined>; default: undefined; }; readOnly: { type: BooleanConstructor; default: boolean; }; ariaLabel: StringConstructor; id: StringConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { valueChange: (_detail: RatingChangeDetail) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ max: NumberConstructor; value: { type: PropType<number | undefined>; default: undefined; }; defaultValue: { type: PropType<number | undefined>; default: undefined; }; readOnly: { type: BooleanConstructor; default: boolean; }; ariaLabel: StringConstructor; id: StringConstructor;}>> & Readonly<{ onValueChange?: ((_detail: RatingChangeDetail) => any) | undefined;}>, { value: number | undefined; defaultValue: number | undefined; readOnly: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;RootProvider
valueRootProviderts
export declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ value: { type: PropType<UseRatingResult>; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ value: { type: PropType<UseRatingResult>; required: true; };}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;Star
valueStarts
export declare const Star: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ index: { type: NumberConstructor; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ index: { type: NumberConstructor; required: true; };}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;useRating
functionuseRatingts
declare function useRating(input: () => RatingInput, options?: () => RatingOptions): UseRatingResult;Name
Kind
Type
Requirement
inputparameter
() => RatingInputrequired
optionsparameter
() => RatingOptionsoptional
returnreturn value
UseRatingResultn/a
- Name
input- Kind
- parameter
- Type
() => RatingInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
() => RatingOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseRatingResult- Requirement
- n/a
UseRatingResult
interfaceUseRatingResultts
interface UseRatingResult { readonly service: RatingService; readonly connector: RatingApi; readonly scope: PartScope; readonly snapshot: ShallowRef<RatingSnapshot>;}Name
Kind
Type
Requirement
connectorproperty
RatingApirequired
scopeproperty
PartScoperequired
serviceproperty
RatingServicerequired
snapshotproperty
ShallowRef<RatingSnapshot>required
- Name
connector- Kind
- property
- Type
RatingApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
RatingService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<RatingSnapshot>- Requirement
- required
@grassroot/ui-headless-angular/rating
Angular adapter
createRatingStore
functioncreateRatingStorets
export declare function createRatingStore(initial: RatingInput, options?: RatingOptions): RatingStore;Name
Kind
Type
Requirement
initialparameter
RatingInputrequired
optionsparameter
RatingOptionsoptional
returnreturn value
RatingStoren/a
- Name
initial- Kind
- parameter
- Type
RatingInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
RatingOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
RatingStore- Requirement
- n/a
GrRatingRoot
classGrRatingRootts
export declare class GrRatingRoot implements OnDestroy { readonly max: import("@angular/core").InputSignal<number | undefined>; readonly value: import("@angular/core").InputSignal<number | undefined>; readonly defaultValue: import("@angular/core").InputSignal<number | undefined>; readonly readOnly: import("@angular/core").InputSignal<boolean>; readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>; readonly className: import("@angular/core").InputSignal<string | undefined>; readonly valueChange: import("@angular/core").OutputEmitterRef<RatingChangeDetail>; readonly store: RatingStore; private readonly host; private readonly listeners; private last; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrRatingRoot, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrRatingRoot, "gr-rating-root", never, { "max": { "alias": "max"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "readOnly": { "alias": "readOnly"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "className": { "alias": "class"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, ["*"], true, never>;}Name
Kind
Type
Requirement
ariaLabelproperty
import("@angular/core").InputSignal<string | undefined>required
classNameproperty
import("@angular/core").InputSignal<string | undefined>required
defaultValueproperty
import("@angular/core").InputSignal<number | undefined>required
hostproperty
anyrequired
lastproperty
anyrequired
listenersproperty
anyrequired
maxproperty
import("@angular/core").InputSignal<number | undefined>required
ngOnDestroymethod
() => voidrequired
ɵcmpproperty
i0.ɵɵComponentDeclaration<GrRatingRoot, "gr-rating-root", never, { "max": { "alias": "max"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "readOnly": { "alias": "readOnly"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "className": { "alias": "class"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, ["*"], true, never>required
ɵfacproperty
i0.ɵɵFactoryDeclaration<GrRatingRoot, never>required
readOnlyproperty
import("@angular/core").InputSignal<boolean>required
storeproperty
RatingStorerequired
valueproperty
import("@angular/core").InputSignal<number | undefined>required
valueChangeproperty
import("@angular/core").OutputEmitterRef<RatingChangeDetail>required
- Name
ariaLabel- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
className- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
defaultValue- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
last- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
max- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrRatingRoot, "gr-rating-root", never, { "max": { "alias": "max"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "defaultValue": { "alias": "defaultValue"; "required": false; "isSignal": true; }; "readOnly": { "alias": "readOnly"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "className": { "alias": "class"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrRatingRoot, never>- Requirement
- required
- Name
readOnly- Kind
- property
- Type
import("@angular/core").InputSignal<boolean>- Requirement
- required
- Name
store- Kind
- property
- Type
RatingStore- Requirement
- required
- Name
value- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
valueChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<RatingChangeDetail>- Requirement
- required
GrRatingRootProvider
classGrRatingRootProviderts
export declare class GrRatingRootProvider implements OnDestroy { private readonly store; private readonly host; private readonly listeners; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrRatingRootProvider, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrRatingRootProvider, "gr-rating-root-provider", never, {}, {}, never, ["*"], true, never>;}Name
Kind
Type
Requirement
hostproperty
anyrequired
listenersproperty
anyrequired
ngOnDestroymethod
() => voidrequired
ɵcmpproperty
i0.ɵɵComponentDeclaration<GrRatingRootProvider, "gr-rating-root-provider", never, {}, {}, never, ["*"], true, never>required
ɵfacproperty
i0.ɵɵFactoryDeclaration<GrRatingRootProvider, never>required
storeproperty
anyrequired
- Name
host- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrRatingRootProvider, "gr-rating-root-provider", never, {}, {}, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrRatingRootProvider, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrRatingStar
classGrRatingStarts
export declare class GrRatingStar implements OnDestroy { readonly index: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrRatingStar, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrRatingStar, "[grRatingStar]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}Name
Kind
Type
Requirement
consumerproperty
anyrequired
elementproperty
anyrequired
indexproperty
import("@angular/core").InputSignal<number>required
listenersproperty
anyrequired
ngOnDestroymethod
() => voidrequired
ɵdirproperty
i0.ɵɵDirectiveDeclaration<GrRatingStar, "[grRatingStar]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>required
ɵfacproperty
i0.ɵɵFactoryDeclaration<GrRatingStar, never>required
storeproperty
anyrequired
- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrRatingStar, "[grRatingStar]", never, { "index": { "alias": "index"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrRatingStar, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
RatingStore
interfaceRatingStorets
export interface RatingStore { readonly service: RatingService; readonly connector: RatingApi; readonly scope: PartScope; readonly version: WritableSignal<number>; start(): void; stop(): void; sync(input: RatingInput): void; syncOptions(options: Record<string, unknown>): void;}Name
Kind
Type
Requirement
connectorproperty
RatingApirequired
scopeproperty
PartScoperequired
serviceproperty
RatingServicerequired
startmethod
() => voidrequired
stopmethod
() => voidrequired
syncmethod
(input: RatingInput) => voidrequired
syncOptionsmethod
(options: Record<string, unknown>) => voidrequired
versionproperty
WritableSignal<number>required
- Name
connector- Kind
- property
- Type
RatingApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
RatingService- Requirement
- required
- Name
start- Kind
- method
- Type
() => void- Requirement
- required
- Name
stop- Kind
- method
- Type
() => void- Requirement
- required
- Name
sync- Kind
- method
- Type
(input: RatingInput) => void- Requirement
- required
- Name
syncOptions- Kind
- method
- Type
(options: Record<string, unknown>) => void- Requirement
- required
- Name
version- Kind
- property
- Type
WritableSignal<number>- Requirement
- required
@grassroot/ui-headless-svelte/rating
Svelte adapter
createRating
functioncreateRatingts
export declare function createRating(input: () => RatingInput, options?: UseRatingOptions): UseRatingResult;Name
Kind
Type
Requirement
inputparameter
() => RatingInputrequired
optionsparameter
UseRatingOptionsoptional
returnreturn value
UseRatingResultn/a
- Name
input- Kind
- parameter
- Type
() => RatingInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseRatingOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseRatingResult- Requirement
- n/a
Parts
valuePartsts
export declare const Parts: LegacyComponentType;Name
Kind
Type
Requirement
argsparameter
Parameters<Component<Record<string, any>>>optional
returnreturn value
ReturnType<Component<Record<string, any>, Record<string, any>>>n/a
- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
Root
valueRootts
export declare const Root: LegacyComponentType;Name
Kind
Type
Requirement
argsparameter
Parameters<Component<Record<string, any>>>optional
returnreturn value
ReturnType<Component<Record<string, any>, Record<string, any>>>n/a
- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
RootProvider
valueRootProviderts
export declare const RootProvider: LegacyComponentType;Name
Kind
Type
Requirement
argsparameter
Parameters<Component<Record<string, any>>>optional
returnreturn value
ReturnType<Component<Record<string, any>, Record<string, any>>>n/a
- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
UseRatingOptions
interfaceUseRatingOptionsts
export interface UseRatingOptions { readonly id?: string; readonly ariaLabel?: string; readonly onValueChange?: (detail: import("@grassroot/ui-headless-core/rating").RatingChangeDetail) => void;}Name
Kind
Type
Requirement
ariaLabelproperty
stringoptional
idproperty
stringoptional
onValueChangeproperty
(detail: import("@grassroot/ui-headless-core/rating").RatingChangeDetail) => voidoptional
- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: import("@grassroot/ui-headless-core/rating").RatingChangeDetail) => void- Requirement
- optional
UseRatingResult
interfaceUseRatingResultts
export interface UseRatingResult { readonly service: RatingService; readonly connector: RatingApi; readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>; readonly version: () => number;}Name
Kind
Type
Requirement
connectorproperty
RatingApirequired
scopeproperty
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>required
serviceproperty
RatingServicerequired
versionproperty
() => numberrequired
- Name
connector- Kind
- property
- Type
RatingApi- Requirement
- required
- Name
scope- Kind
- property
- Type
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>- Requirement
- required
- Name
service- Kind
- property
- Type
RatingService- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
@grassroot/ui-headless-solid/rating
Solid adapter
Root
functionRootts
export declare function Root(props: RatingRootProps): JSX.Element;Name
Kind
Type
Requirement
propsparameter
RatingRootPropsrequired
returnreturn value
JSX.Elementn/a
- Name
props- Kind
- parameter
- Type
RatingRootProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
RootProvider
functionRootProviderts
export declare function RootProvider(props: RatingRootProviderProps): JSX.Element;Name
Kind
Type
Requirement
propsparameter
RatingRootProviderPropsrequired
returnreturn value
JSX.Elementn/a
- Name
props- Kind
- parameter
- Type
RatingRootProviderProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
Star
functionStarts
export declare function Star(props: RatingStarProps): JSX.Element;Name
Kind
Type
Requirement
propsparameter
RatingStarPropsrequired
returnreturn value
JSX.Elementn/a
- Name
props- Kind
- parameter
- Type
RatingStarProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
useRating
functionuseRatingts
export declare function useRating(input: Accessor<RatingInput>, options?: UseRatingOptions): UseRatingResult;Name
Kind
Type
Requirement
inputparameter
Accessor<RatingInput>required
optionsparameter
UseRatingOptionsoptional
returnreturn value
UseRatingResultn/a
- Name
input- Kind
- parameter
- Type
Accessor<RatingInput>- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseRatingOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseRatingResult- Requirement
- n/a
UseRatingOptions
interfaceUseRatingOptionsts
export interface UseRatingOptions { readonly id?: string; readonly ariaLabel?: string; readonly onValueChange?: (detail: RatingChangeDetail) => void;}Name
Kind
Type
Requirement
ariaLabelproperty
stringoptional
idproperty
stringoptional
onValueChangeproperty
(detail: RatingChangeDetail) => voidoptional
- Name
ariaLabel- Kind
- property
- Type
string- Requirement
- optional
- Name
id- Kind
- property
- Type
string- Requirement
- optional
- Name
onValueChange- Kind
- property
- Type
(detail: RatingChangeDetail) => void- Requirement
- optional
UseRatingResult
interfaceUseRatingResultts
export interface UseRatingResult { readonly service: RatingService; readonly connector: RatingApi; readonly scope: PartScope; readonly snapshot: Accessor<RatingSnapshot>;}Name
Kind
Type
Requirement
connectorproperty
RatingApirequired
scopeproperty
PartScoperequired
serviceproperty
RatingServicerequired
snapshotproperty
Accessor<RatingSnapshot>required
- Name
connector- Kind
- property
- Type
RatingApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
RatingService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
Accessor<RatingSnapshot>- Requirement
- required