Docs API reference Headlesswishlist-button

wishlist-button 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.

Machine API

@grassroot/ui-headless-core/wishlist-button

Core connector and vanilla API

18 exports

View source packages/ui-headless/core/src/wishlist-button/index.ts

Install npm i @grassroot/ui-headless-core

connectWishlistButton

function

connectWishlistButtonts

declare function connectWishlistButton(service: WishlistButtonService, scope: PartScope, options?: WishlistButtonConnectOptions): WishlistButtonApi;

Name

Kind

Type

Requirement

service

parameter

WishlistButtonService

required

scope

parameter

PartScope

required

options

parameter

WishlistButtonConnectOptions

optional

return

return value

WishlistButtonApi

n/a

Name: service
Kind: parameter
Type: WishlistButtonService
Requirement: required

Name: scope
Kind: parameter
Type: PartScope
Requirement: required

Name: options
Kind: parameter
Type: WishlistButtonConnectOptions
Requirement: optional

Name: return
Kind: return value
Type: WishlistButtonApi
Requirement: n/a

mountWishlistButton

function

mountWishlistButtonts

declare function mountWishlistButton(container: HTMLElement, options?: MountWishlistButtonOptions): WishlistButtonMount;

Name

Kind

Type

Requirement

container

parameter

HTMLElement

required

options

parameter

MountWishlistButtonOptions

optional

return

return value

WishlistButtonMount

n/a

Name: container
Kind: parameter
Type: HTMLElement
Requirement: required

Name: options
Kind: parameter
Type: MountWishlistButtonOptions
Requirement: optional

Name: return
Kind: return value
Type: WishlistButtonMount
Requirement: n/a

MountWishlistButtonOptions

interface

MountWishlistButtonOptionsts

interface MountWishlistButtonOptions extends WishlistButtonInput {
  readonly ariaLabel?: string;
  readonly onPressedChange?: (detail: WishlistButtonChangeDetail) => void;
}

Name

Kind

Type

Requirement

ariaLabel

property

string

optional

onPressedChange

property

(detail: WishlistButtonChangeDetail) => void

optional

Name: ariaLabel
Kind: property
Type: string
Requirement: optional

Name: onPressedChange
Kind: property
Type: (detail: WishlistButtonChangeDetail) => void
Requirement: optional

runWishlistButtonCommand

function

runWishlistButtonCommandts

declare function runWishlistButtonCommand(command: WishlistButtonCommand, options?: WishlistButtonConnectOptions): void;

Name

Kind

Type

Requirement

command

parameter

WishlistButtonCommand

required

options

parameter

WishlistButtonConnectOptions

optional

return

return value

void

n/a

Name: command
Kind: parameter
Type: WishlistButtonCommand
Requirement: required

Name: options
Kind: parameter
Type: WishlistButtonConnectOptions
Requirement: optional

Name: return
Kind: return value
Type: void
Requirement: n/a

wishlistButtonAnatomy

value

wishlistButtonAnatomyts

export declare const wishlistButtonAnatomy: {
  readonly scope: "wishlist-button";
  readonly parts: readonly ["root"];
};

Name

Kind

Type

Requirement

parts

property

readonly ["root"]

required

scope

property

"wishlist-button"

required

Name: parts
Kind: property
Type: readonly ["root"]
Requirement: required

Name: scope
Kind: property
Type: "wishlist-button"
Requirement: required

WishlistButtonApi

interface

WishlistButtonApits

interface WishlistButtonApi {
  rootProps(): PartProps;
  readonly pressed: boolean;
  readonly disabled: boolean;
}

Name

Kind

Type

Requirement

disabled

property

boolean

required

pressed

property

boolean

required

rootProps

method

() => PartProps

required

Name: disabled
Kind: property
Type: boolean
Requirement: required

Name: pressed
Kind: property
Type: boolean
Requirement: required

Name: rootProps
Kind: method
Type: () => PartProps
Requirement: required

WishlistButtonChangeDetail

interface

WishlistButtonChangeDetailts

interface WishlistButtonChangeDetail {
  readonly pressed: boolean;
  readonly reason: "pointer" | "keyboard" | "programmatic";
}

Name

Kind

Type

Requirement

pressed

property

boolean

required

reason

property

"pointer" | "keyboard" | "programmatic"

required

Name: pressed
Kind: property
Type: boolean
Requirement: required

Name: reason
Kind: property
Type: "pointer" | "keyboard" | "programmatic"
Requirement: required

WishlistButtonCommand

type

WishlistButtonCommandts

type ToggleButtonCommand = CommandObject & {
  readonly type: "PRESSED_CHANGE_REQUEST";
  readonly pressed: boolean;
  readonly reason: ToggleButtonReason;
};

Name

Kind

Type

Requirement

pressed

property

boolean

required

reason

property

ToggleButtonReason

required

type

property

string

required

Name: pressed
Kind: property
Type: boolean
Requirement: required

Name: reason
Kind: property
Type: ToggleButtonReason
Requirement: required

Name: type
Kind: property
Type: string
Requirement: required

WishlistButtonConnectOptions

interface

WishlistButtonConnectOptionsts

interface WishlistButtonConnectOptions {
  readonly onPressedChange?: (detail: WishlistButtonChangeDetail) => void;
  readonly ariaLabel?: string;
}

Name

Kind

Type

Requirement

ariaLabel

property

string

optional

onPressedChange

property

(detail: WishlistButtonChangeDetail) => void

optional

Name: ariaLabel
Kind: property
Type: string
Requirement: optional

Name: onPressedChange
Kind: property
Type: (detail: WishlistButtonChangeDetail) => void
Requirement: optional

WishlistButtonContext

type

WishlistButtonContextts

type ToggleButtonContext = {
  readonly mode: BindingMode;
  readonly pressed: boolean;
};

Name

Kind

Type

Requirement

mode

property

BindingMode

required

pressed

property

boolean

required

Name: mode
Kind: property
Type: BindingMode
Requirement: required

Name: pressed
Kind: property
Type: boolean
Requirement: required

WishlistButtonEvent

type

WishlistButtonEventts

type ToggleButtonEvent = {
  readonly type: "PRESS";
  readonly reason: ToggleButtonReason;
} | {
  readonly type: "RESET";
};

WishlistButtonInput

type

WishlistButtonInputts

type ToggleButtonInput = {
  readonly pressed?: boolean;
  readonly defaultPressed?: boolean;
  readonly disabled?: boolean;
};

Name

Kind

Type

Requirement

defaultPressed

property

boolean

optional

disabled

property

boolean

optional

pressed

property

boolean

optional

Name: defaultPressed
Kind: property
Type: boolean
Requirement: optional

Name: disabled
Kind: property
Type: boolean
Requirement: optional

Name: pressed
Kind: property
Type: boolean
Requirement: optional

wishlistButtonMachine

value

wishlistButtonMachinets

export declare const wishlistButtonMachine: Machine<ToggleButtonInput, "ready", ToggleButtonContext, ToggleButtonEvent, ToggleButtonCommand>;

WishlistButtonMount

interface

WishlistButtonMountts

interface WishlistButtonMount {
  readonly service: WishlistButtonService;
  readonly connector: WishlistButtonApi;
  readonly root: HTMLButtonElement;
  destroy(): void;
}

Name

Kind

Type

Requirement

connector

property

WishlistButtonApi

required

destroy

method

() => void

required

root

property

HTMLButtonElement

required

service

property

WishlistButtonService

required

Name: connector
Kind: property
Type: WishlistButtonApi
Requirement: required

Name: destroy
Kind: method
Type: () => void
Requirement: required

Name: root
Kind: property
Type: HTMLButtonElement
Requirement: required

Name: service
Kind: property
Type: WishlistButtonService
Requirement: required

WishlistButtonPart

type

WishlistButtonPartts

type WishlistButtonPart = (typeof wishlistButtonAnatomy.parts)[number];

wishlistButtonSelectors

value

wishlistButtonSelectorsts

export declare const wishlistButtonSelectors: {
  pressed: (snapshot: ToggleButtonSnapshot) => boolean;
};

Name

Kind

Type

Requirement

pressed

property

(snapshot: ToggleButtonSnapshot) => boolean

required

Name: pressed
Kind: property
Type: (snapshot: ToggleButtonSnapshot) => boolean
Requirement: required

WishlistButtonService

type

WishlistButtonServicets

type WishlistButtonService = Service<WishlistButtonInput, "ready", WishlistButtonContext, WishlistButtonEvent, WishlistButtonCommand>;

WishlistButtonSnapshot

type

WishlistButtonSnapshotts

type ToggleButtonSnapshot = Snapshot<"ready", ToggleButtonContext>;

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 imports

@grassroot/ui-headless-react/wishlist-buttonts

import { Root, RootProvider } from "@grassroot/ui-headless-react/wishlist-button";

Vue imports

@grassroot/ui-headless-vue/wishlist-buttonts

<script setup lang="ts">
import { Root, RootProvider, WishlistButtonRoot, WishlistButtonRootProvider } from "@grassroot/ui-headless-vue/wishlist-button";
</script>

Angular imports

@grassroot/ui-headless-angular/wishlist-buttonts

import { GrWishlistButtonRoot, GrWishlistButtonRootProvider } from "@grassroot/ui-headless-angular/wishlist-button";

Svelte imports

@grassroot/ui-headless-svelte/wishlist-buttonts

<script lang="ts">
  import { Root, RootProvider } from "@grassroot/ui-headless-svelte/wishlist-button";
</script>

Solid imports

@grassroot/ui-headless-solid/wishlist-buttonts

import { Root, RootProvider } from "@grassroot/ui-headless-solid/wishlist-button";

@grassroot/ui-headless-react/wishlist-button

React adapter

7 exports

View source packages/ui-headless/react/src/wishlist-button/index.ts

Install npm i @grassroot/ui-headless-react

Root

value

Rootts

export declare const Root: import("react").ForwardRefExoticComponent<WishlistButtonRootProps & import("react").RefAttributes<HTMLButtonElement>>;

Name

Kind

Type

Requirement

props

parameter

P

required

return

return value

ReactNode

n/a

Name: props
Kind: parameter
Type: P
Requirement: required

Name: return
Kind: return value
Type: ReactNode
Requirement: n/a

RootProvider

value

RootProviderts

export declare const RootProvider: import("react").ForwardRefExoticComponent<WishlistButtonRootProviderProps & import("react").RefAttributes<HTMLButtonElement>>;

Name

Kind

Type

Requirement

props

parameter

P

required

return

return value

ReactNode

n/a

Name: props
Kind: parameter
Type: P
Requirement: required

Name: return
Kind: return value
Type: ReactNode
Requirement: n/a

useWishlistButton

function

useWishlistButtonts

declare function useWishlistButton(input: WishlistButtonInput, options?: UseWishlistButtonOptions): UseWishlistButtonResult;

Name

Kind

Type

Requirement

input

parameter

WishlistButtonInput

required

options

parameter

UseWishlistButtonOptions

optional

return

return value

UseWishlistButtonResult

n/a

Name: input
Kind: parameter
Type: WishlistButtonInput
Requirement: required

Name: options
Kind: parameter
Type: UseWishlistButtonOptions
Requirement: optional

Name: return
Kind: return value
Type: UseWishlistButtonResult
Requirement: n/a

UseWishlistButtonOptions

interface

UseWishlistButtonOptionsts

interface UseWishlistButtonOptions extends WishlistButtonConnectOptions {
  readonly id?: string;
  readonly onPressedChange?: (detail: WishlistButtonChangeDetail) => void;
}

Name

Kind

Type

Requirement

id

property

string

optional

onPressedChange

property

(detail: WishlistButtonChangeDetail) => void

optional

Name: id
Kind: property
Type: string
Requirement: optional

Name: onPressedChange
Kind: property
Type: (detail: WishlistButtonChangeDetail) => void
Requirement: optional

UseWishlistButtonResult

interface

UseWishlistButtonResultts

interface UseWishlistButtonResult {
  readonly service: WishlistButtonService;
  readonly connector: WishlistButtonApi;
  readonly scope: PartScope;
  readonly snapshot: WishlistButtonSnapshot;
}

Name

Kind

Type

Requirement

connector

property

WishlistButtonApi

required

scope

property

PartScope

required

service

property

WishlistButtonService

required

snapshot

property

WishlistButtonSnapshot

required

Name: connector
Kind: property
Type: WishlistButtonApi
Requirement: required

Name: scope
Kind: property
Type: PartScope
Requirement: required

Name: service
Kind: property
Type: WishlistButtonService
Requirement: required

Name: snapshot
Kind: property
Type: WishlistButtonSnapshot
Requirement: required

WishlistButtonRootProps

interface

WishlistButtonRootPropsts

interface WishlistButtonRootProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, "defaultValue" | "onChange" | "disabled">, WishlistButtonInput {
  readonly ariaLabel?: string;
  readonly id?: string;
  readonly onPressedChange?: (detail: WishlistButtonChangeDetail) => void;
  readonly children?: ReactNode;
}

Name

Kind

Type

Requirement

ariaLabel

property

string

optional

children

property

ReactNode

optional

id

property

string

optional

onPressedChange

property

(detail: WishlistButtonChangeDetail) => void

optional

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: onPressedChange
Kind: property
Type: (detail: WishlistButtonChangeDetail) => void
Requirement: optional

WishlistButtonRootProviderProps

interface

WishlistButtonRootProviderPropsts

interface WishlistButtonRootProviderProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, "defaultValue" | "onChange" | "value"> {
  readonly value: UseWishlistButtonResult;
  readonly children?: ReactNode;
}

Name

Kind

Type

Requirement

children

property

ReactNode

optional

value

property

UseWishlistButtonResult

required

Name: children
Kind: property
Type: ReactNode
Requirement: optional

Name: value
Kind: property
Type: UseWishlistButtonResult
Requirement: required

@grassroot/ui-headless-vue/wishlist-button

Vue adapter

6 exports

View source packages/ui-headless/vue/src/wishlist-button/index.ts

Install npm i @grassroot/ui-headless-vue

Root

value

Rootts

export declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  pressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultPressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  disabled: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  ariaLabel: StringConstructor;
  id: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  pressedChange: (_detail: WishlistButtonChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  pressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultPressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  disabled: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  ariaLabel: StringConstructor;
  id: StringConstructor;
}>> & Readonly<{
  onPressedChange?: ((_detail: WishlistButtonChangeDetail) => any) | undefined;
}>, {
  asChild: boolean;
  pressed: boolean | undefined;
  defaultPressed: boolean | undefined;
  disabled: boolean | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

RootProvider

value

RootProviderts

export declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  pressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultPressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  disabled: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  ariaLabel: StringConstructor;
  id: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  pressedChange: (_detail: WishlistButtonChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  pressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultPressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  disabled: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  ariaLabel: StringConstructor;
  id: StringConstructor;
}>> & Readonly<{
  onPressedChange?: ((_detail: WishlistButtonChangeDetail) => any) | undefined;
}>, {
  asChild: boolean;
  pressed: boolean | undefined;
  defaultPressed: boolean | undefined;
  disabled: boolean | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

useWishlistButton

function

useWishlistButtonts

declare function useWishlistButton(input: () => WishlistButtonInput, options?: () => WishlistButtonOptions): UseWishlistButtonResult;

Name

Kind

Type

Requirement

input

parameter

() => WishlistButtonInput

required

options

parameter

() => WishlistButtonOptions

optional

return

return value

UseWishlistButtonResult

n/a

Name: input
Kind: parameter
Type: () => WishlistButtonInput
Requirement: required

Name: options
Kind: parameter
Type: () => WishlistButtonOptions
Requirement: optional

Name: return
Kind: return value
Type: UseWishlistButtonResult
Requirement: n/a

UseWishlistButtonResult

interface

UseWishlistButtonResultts

interface UseWishlistButtonResult {
  readonly service: WishlistButtonService;
  readonly connector: WishlistButtonApi;
  readonly scope: PartScope;
  readonly snapshot: ShallowRef<WishlistButtonSnapshot>;
}

Name

Kind

Type

Requirement

connector

property

WishlistButtonApi

required

scope

property

PartScope

required

service

property

WishlistButtonService

required

snapshot

property

ShallowRef<WishlistButtonSnapshot>

required

Name: connector
Kind: property
Type: WishlistButtonApi
Requirement: required

Name: scope
Kind: property
Type: PartScope
Requirement: required

Name: service
Kind: property
Type: WishlistButtonService
Requirement: required

Name: snapshot
Kind: property
Type: ShallowRef<WishlistButtonSnapshot>
Requirement: required

WishlistButtonRoot

value

WishlistButtonRootts

export declare const WishlistButtonRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  pressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultPressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  disabled: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  ariaLabel: StringConstructor;
  id: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  pressedChange: (_detail: WishlistButtonChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  pressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultPressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  disabled: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  ariaLabel: StringConstructor;
  id: StringConstructor;
}>> & Readonly<{
  onPressedChange?: ((_detail: WishlistButtonChangeDetail) => any) | undefined;
}>, {
  asChild: boolean;
  pressed: boolean | undefined;
  defaultPressed: boolean | undefined;
  disabled: boolean | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

WishlistButtonRootProvider

value

WishlistButtonRootProviderts

export declare const WishlistButtonRootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  pressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultPressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  disabled: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  ariaLabel: StringConstructor;
  id: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  pressedChange: (_detail: WishlistButtonChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  pressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  defaultPressed: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  disabled: {
    type: PropType<boolean | undefined>;
    default: undefined;
  };
  ariaLabel: StringConstructor;
  id: StringConstructor;
}>> & Readonly<{
  onPressedChange?: ((_detail: WishlistButtonChangeDetail) => any) | undefined;
}>, {
  asChild: boolean;
  pressed: boolean | undefined;
  defaultPressed: boolean | undefined;
  disabled: boolean | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

@grassroot/ui-headless-angular/wishlist-button

Angular adapter

5 exports

View source packages/ui-headless/angular/src/wishlist-button/index.ts

Install npm i @grassroot/ui-headless-angular

createWishlistButtonStore

function

createWishlistButtonStorets

export declare function createWishlistButtonStore(initial: WishlistButtonInput, options?: CreateWishlistButtonStoreOptions): WishlistButtonStore;

Name

Kind

Type

Requirement

initial

parameter

WishlistButtonInput

required

options

parameter

CreateWishlistButtonStoreOptions

optional

return

return value

WishlistButtonStore

n/a

Name: initial
Kind: parameter
Type: WishlistButtonInput
Requirement: required

Name: options
Kind: parameter
Type: CreateWishlistButtonStoreOptions
Requirement: optional

Name: return
Kind: return value
Type: WishlistButtonStore
Requirement: n/a

CreateWishlistButtonStoreOptions

interface

CreateWishlistButtonStoreOptionsts

export interface CreateWishlistButtonStoreOptions {
    readonly ariaLabel?: string;
    readonly onPressedChange?: (detail: WishlistButtonChangeDetail) => void;
    readonly onCommit?: () => void;
}

Name

Kind

Type

Requirement

ariaLabel

property

string

optional

onCommit

property

() => void

optional

onPressedChange

property

(detail: WishlistButtonChangeDetail) => void

optional

Name: ariaLabel
Kind: property
Type: string
Requirement: optional

Name: onCommit
Kind: property
Type: () => void
Requirement: optional

Name: onPressedChange
Kind: property
Type: (detail: WishlistButtonChangeDetail) => void
Requirement: optional

GrWishlistButtonRoot

class

GrWishlistButtonRootts

export declare class GrWishlistButtonRoot implements OnDestroy {
    readonly pressed: import("@angular/core").InputSignal<boolean | undefined>;
    readonly defaultPressed: import("@angular/core").InputSignal<boolean | undefined>;
    readonly disabled: import("@angular/core").InputSignal<boolean | undefined>;
    readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
    readonly pressedChange: import("@angular/core").OutputEmitterRef<WishlistButtonChangeDetail>;
    readonly store: WishlistButtonStore;
    private readonly host;
    private readonly listeners;
    private last;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrWishlistButtonRoot, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<GrWishlistButtonRoot, "gr-wishlist-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>;
}

Name

Kind

Type

Requirement

ariaLabel

property

import("@angular/core").InputSignal<string | undefined>

required

defaultPressed

property

import("@angular/core").InputSignal<boolean | undefined>

required

disabled

property

import("@angular/core").InputSignal<boolean | undefined>

required

host

property

any

required

last

property

any

required

listeners

property

any

required

ngOnDestroy

method

() => void

required

ɵcmp

property

i0.ɵɵComponentDeclaration<GrWishlistButtonRoot, "gr-wishlist-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>

required

ɵfac

property

i0.ɵɵFactoryDeclaration<GrWishlistButtonRoot, never>

required

pressed

property

import("@angular/core").InputSignal<boolean | undefined>

required

pressedChange

property

import("@angular/core").OutputEmitterRef<WishlistButtonChangeDetail>

required

store

property

WishlistButtonStore

required

Name: ariaLabel
Kind: property
Type: import("@angular/core").InputSignal<string | undefined>
Requirement: required

Name: defaultPressed
Kind: property
Type: import("@angular/core").InputSignal<boolean | undefined>
Requirement: required

Name: disabled
Kind: property
Type: import("@angular/core").InputSignal<boolean | 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: ngOnDestroy
Kind: method
Type: () => void
Requirement: required

Name: ɵcmp
Kind: property
Type: i0.ɵɵComponentDeclaration<GrWishlistButtonRoot, "gr-wishlist-button-root", never, { "pressed": { "alias": "pressed"; "required": false; "isSignal": true; }; "defaultPressed": { "alias": "defaultPressed"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "pressedChange": "pressedChange"; }, never, ["*"], true, never>
Requirement: required

Name: ɵfac
Kind: property
Type: i0.ɵɵFactoryDeclaration<GrWishlistButtonRoot, never>
Requirement: required

Name: pressed
Kind: property
Type: import("@angular/core").InputSignal<boolean | undefined>
Requirement: required

Name: pressedChange
Kind: property
Type: import("@angular/core").OutputEmitterRef<WishlistButtonChangeDetail>
Requirement: required

Name: store
Kind: property
Type: WishlistButtonStore
Requirement: required

GrWishlistButtonRootProvider

class

GrWishlistButtonRootProviderts

export declare class GrWishlistButtonRootProvider implements OnDestroy {
    private readonly store;
    private readonly host;
    private readonly listeners;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrWishlistButtonRootProvider, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<GrWishlistButtonRootProvider, "gr-wishlist-button-root-provider", never, {}, {}, never, ["*"], true, never>;
}

Name

Kind

Type

Requirement

host

property

any

required

listeners

property

any

required

ngOnDestroy

method

() => void

required

ɵcmp

property

i0.ɵɵComponentDeclaration<GrWishlistButtonRootProvider, "gr-wishlist-button-root-provider", never, {}, {}, never, ["*"], true, never>

required

ɵfac

property

i0.ɵɵFactoryDeclaration<GrWishlistButtonRootProvider, never>

required

store

property

any

required

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<GrWishlistButtonRootProvider, "gr-wishlist-button-root-provider", never, {}, {}, never, ["*"], true, never>
Requirement: required

Name: ɵfac
Kind: property
Type: i0.ɵɵFactoryDeclaration<GrWishlistButtonRootProvider, never>
Requirement: required

Name: store
Kind: property
Type: any
Requirement: required

WishlistButtonStore

interface

WishlistButtonStorets

export interface WishlistButtonStore {
    readonly service: WishlistButtonService;
    readonly connector: WishlistButtonApi;
    readonly scope: PartScope;
    readonly version: WritableSignal<number>;
    start(): void;
    stop(): void;
    sync(input: WishlistButtonInput): void;
}

Name

Kind

Type

Requirement

connector

property

WishlistButtonApi

required

scope

property

PartScope

required

service

property

WishlistButtonService

required

start

method

() => void

required

stop

method

() => void

required

sync

method

(input: WishlistButtonInput) => void

required

version

property

WritableSignal<number>

required

Name: connector
Kind: property
Type: WishlistButtonApi
Requirement: required

Name: scope
Kind: property
Type: PartScope
Requirement: required

Name: service
Kind: property
Type: WishlistButtonService
Requirement: required

Name: start
Kind: method
Type: () => void
Requirement: required

Name: stop
Kind: method
Type: () => void
Requirement: required

Name: sync
Kind: method
Type: (input: WishlistButtonInput) => void
Requirement: required

Name: version
Kind: property
Type: WritableSignal<number>
Requirement: required

@grassroot/ui-headless-svelte/wishlist-button

Svelte adapter

5 exports

View source packages/ui-headless/svelte/src/wishlist-button/index.ts

Install npm i @grassroot/ui-headless-svelte

createWishlistButton

function

createWishlistButtonts

export declare function createWishlistButton(input: () => WishlistButtonInput, options?: UseWishlistButtonOptions): UseWishlistButtonResult;

Name

Kind

Type

Requirement

input

parameter

() => WishlistButtonInput

required

options

parameter

UseWishlistButtonOptions

optional

return

return value

UseWishlistButtonResult

n/a

Name: input
Kind: parameter
Type: () => WishlistButtonInput
Requirement: required

Name: options
Kind: parameter
Type: UseWishlistButtonOptions
Requirement: optional

Name: return
Kind: return value
Type: UseWishlistButtonResult
Requirement: n/a

Root

value

Rootts

export declare const Root: LegacyComponentType;

Name

Kind

Type

Requirement

args

parameter

Parameters<Component<Record<string, any>>>

optional

return

return 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

value

RootProviderts

export declare const RootProvider: LegacyComponentType;

Name

Kind

Type

Requirement

args

parameter

Parameters<Component<Record<string, any>>>

optional

return

return 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

UseWishlistButtonOptions

interface

UseWishlistButtonOptionsts

export interface UseWishlistButtonOptions {
    readonly id?: string;
    readonly ariaLabel?: string;
    readonly onPressedChange?: (detail: import("@grassroot/ui-headless-core/wishlist-button").WishlistButtonChangeDetail) => void;
}

Name

Kind

Type

Requirement

ariaLabel

property

string

optional

id

property

string

optional

onPressedChange

property

(detail: import("@grassroot/ui-headless-core/wishlist-button").WishlistButtonChangeDetail) => void

optional

Name: ariaLabel
Kind: property
Type: string
Requirement: optional

Name: id
Kind: property
Type: string
Requirement: optional

Name: onPressedChange
Kind: property
Type: (detail: import("@grassroot/ui-headless-core/wishlist-button").WishlistButtonChangeDetail) => void
Requirement: optional

UseWishlistButtonResult

interface

UseWishlistButtonResultts

export interface UseWishlistButtonResult {
    readonly service: WishlistButtonService;
    readonly connector: WishlistButtonApi;
    readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>;
    readonly version: () => number;
}

Name

Kind

Type

Requirement

connector

property

WishlistButtonApi

required

scope

property

ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>

required

service

property

WishlistButtonService

required

version

property

() => number

required

Name: connector
Kind: property
Type: WishlistButtonApi
Requirement: required

Name: scope
Kind: property
Type: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
Requirement: required

Name: service
Kind: property
Type: WishlistButtonService
Requirement: required

Name: version
Kind: property
Type: () => number
Requirement: required

@grassroot/ui-headless-solid/wishlist-button

Solid adapter

7 exports

View source packages/ui-headless/solid/src/wishlist-button/index.ts

Install npm i @grassroot/ui-headless-solid

Root

function

Rootts

export declare function Root(props: WishlistButtonRootProps): JSX.Element;

Name

Kind

Type

Requirement

props

parameter

WishlistButtonRootProps

required

return

return value

JSX.Element

n/a

Name: props
Kind: parameter
Type: WishlistButtonRootProps
Requirement: required

Name: return
Kind: return value
Type: JSX.Element
Requirement: n/a

RootProvider

function

RootProviderts

export declare function RootProvider(props: WishlistButtonRootProviderProps): JSX.Element;

Name

Kind

Type

Requirement

props

parameter

WishlistButtonRootProviderProps

required

return

return value

JSX.Element

n/a

Name: props
Kind: parameter
Type: WishlistButtonRootProviderProps
Requirement: required

Name: return
Kind: return value
Type: JSX.Element
Requirement: n/a

useWishlistButton

function

useWishlistButtonts

export declare function useWishlistButton(input: Accessor<WishlistButtonInput>, options?: UseWishlistButtonOptions): UseWishlistButtonResult;

Name

Kind

Type

Requirement

input

parameter

Accessor<WishlistButtonInput>

required

options

parameter

UseWishlistButtonOptions

optional

return

return value

UseWishlistButtonResult

n/a

Name: input
Kind: parameter
Type: Accessor<WishlistButtonInput>
Requirement: required

Name: options
Kind: parameter
Type: UseWishlistButtonOptions
Requirement: optional

Name: return
Kind: return value
Type: UseWishlistButtonResult
Requirement: n/a

UseWishlistButtonOptions

interface

UseWishlistButtonOptionsts

export interface UseWishlistButtonOptions extends WishlistButtonConnectOptions {
    readonly id?: string;
    readonly onPressedChange?: (detail: WishlistButtonChangeDetail) => void;
}

Name

Kind

Type

Requirement

id

property

string

optional

onPressedChange

property

(detail: WishlistButtonChangeDetail) => void

optional

Name: id
Kind: property
Type: string
Requirement: optional

Name: onPressedChange
Kind: property
Type: (detail: WishlistButtonChangeDetail) => void
Requirement: optional

UseWishlistButtonResult

interface

UseWishlistButtonResultts

export interface UseWishlistButtonResult {
    readonly service: WishlistButtonService;
    readonly connector: WishlistButtonApi;
    readonly scope: PartScope;
    readonly snapshot: Accessor<WishlistButtonSnapshot>;
}

Name

Kind

Type

Requirement

connector

property

WishlistButtonApi

required

scope

property

PartScope

required

service

property

WishlistButtonService

required

snapshot

property

Accessor<WishlistButtonSnapshot>

required

Name: connector
Kind: property
Type: WishlistButtonApi
Requirement: required

Name: scope
Kind: property
Type: PartScope
Requirement: required

Name: service
Kind: property
Type: WishlistButtonService
Requirement: required

Name: snapshot
Kind: property
Type: Accessor<WishlistButtonSnapshot>
Requirement: required

WishlistButtonRootProps

interface

WishlistButtonRootPropsts

export interface WishlistButtonRootProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "disabled" | "onChange">, WishlistButtonInput {
    readonly ariaLabel?: string;
    readonly id?: string;
    readonly onPressedChange?: (detail: WishlistButtonChangeDetail) => void;
    readonly children?: JSX.Element;
}

Name

Kind

Type

Requirement

ariaLabel

property

string

optional

children

property

JSX.Element

optional

id

property

string

optional

onPressedChange

property

(detail: WishlistButtonChangeDetail) => void

optional

Name: ariaLabel
Kind: property
Type: string
Requirement: optional

Name: children
Kind: property
Type: JSX.Element
Requirement: optional

Name: id
Kind: property
Type: string
Requirement: optional

Name: onPressedChange
Kind: property
Type: (detail: WishlistButtonChangeDetail) => void
Requirement: optional

WishlistButtonRootProviderProps

interface

WishlistButtonRootProviderPropsts

export interface WishlistButtonRootProviderProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "disabled" | "onChange" | "value"> {
    readonly value: UseWishlistButtonResult;
    readonly children?: JSX.Element;
}

Name

Kind

Type

Requirement

children

property

JSX.Element

optional

value

property

UseWishlistButtonResult

required

Name: children
Kind: property
Type: JSX.Element
Requirement: optional

Name: value
Kind: property
Type: UseWishlistButtonResult
Requirement: required

Framework adapters

React imports

Vue imports

Angular imports

Svelte imports

Solid imports

Related references