DocsAPI referenceHeadlesshover-card

hover-card 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.

@grassroot/ui-headless-core/hover-card

Core connector and vanilla API

12 exports
View source packages/ui-headless/core/src/hover-card/index.ts

Reuses Popover's non-modal activation exactly. The cast is limited to the service boundary because both machines expose the same open/closed snapshot, and Popover's layer sends only the shared CLOSE escape and outside-click reasons.

DeclarationView source
activateHoverCardLayerts
declare function activateHoverCardLayer(service: HoverCardService, scope: PartScope, document: Document): () => void;
Name
Kind
Type
Requirement
service
parameter
HoverCardService
required
scope
parameter
PartScope
required
document
parameter
Document
required
return
return value
() => void
n/a
Name
service
Kind
parameter
Type
HoverCardService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
document
Kind
parameter
Type
Document
Requirement
required
Name
return
Kind
return value
Type
() => void
Requirement
n/a

connectHoverCard

function
DeclarationView source
connectHoverCardts
declare function connectHoverCard(service: HoverCardService, scope: PartScope, _options?: HoverCardConnectOptions): HoverCardApi;
Name
Kind
Type
Requirement
service
parameter
HoverCardService
required
scope
parameter
PartScope
required
_options
parameter
HoverCardConnectOptions
optional
return
return value
HoverCardApi
n/a
Name
service
Kind
parameter
Type
HoverCardService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
_options
Kind
parameter
Type
HoverCardConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
HoverCardApi
Requirement
n/a
DeclarationView source
hoverCardAnatomyts
export declare const hoverCardAnatomy: {
readonly scope: "hover-card";
readonly parts: readonly ["root", "trigger", "content"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "trigger", "content"]
required
scope
property
"hover-card"
required
Name
parts
Kind
property
Type
readonly ["root", "trigger", "content"]
Requirement
required
Name
scope
Kind
property
Type
"hover-card"
Requirement
required

HoverCardApi

interface
DeclarationView source
HoverCardApits
interface HoverCardApi {
rootProps(): PartProps;
triggerProps(): PartProps;
contentProps(): PartProps;
readonly open: boolean;
}
Name
Kind
Type
Requirement
contentProps
method
() => PartProps
required
open
property
boolean
required
rootProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
Name
contentProps
Kind
method
Type
() => PartProps
Requirement
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
HoverCardConnectOptionsts
interface HoverCardConnectOptions {}

HoverCardMount

interface
DeclarationView source
HoverCardMountts
interface HoverCardMount {
readonly service: HoverCardService;
readonly connector: HoverCardApi;
readonly root: HTMLElement;
readonly trigger: HTMLElement;
readonly content: HTMLElement | null;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
HoverCardApi
required
content
property
HTMLElement | null
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
HoverCardService
required
trigger
property
HTMLElement
required
Name
connector
Kind
property
Type
HoverCardApi
Requirement
required
Name
content
Kind
property
Type
HTMLElement | null
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
HoverCardService
Requirement
required
Name
trigger
Kind
property
Type
HTMLElement
Requirement
required
DeclarationView source
HoverCardOpenChangeDetailts
interface HoverCardOpenChangeDetail {
readonly open: boolean;
readonly reason: HoverCardChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
HoverCardChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
HoverCardChangeReason
Requirement
required
DeclarationView source
HoverCardPartts
type HoverCardPart = (typeof hoverCardAnatomy.parts)[number];
DeclarationView source
HoverCardServicets
type HoverCardService = Service<HoverCardInput, HoverCardStateValue, HoverCardContext, HoverCardEvent, HoverCardCommand>;

mountHoverCard

function
DeclarationView source
mountHoverCardts
declare function mountHoverCard(container: HTMLElement, options?: MountHoverCardOptions): HoverCardMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountHoverCardOptions
optional
return
return value
HoverCardMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountHoverCardOptions
Requirement
optional
Name
return
Kind
return value
Type
HoverCardMount
Requirement
n/a
DeclarationView source
MountHoverCardOptionsts
interface MountHoverCardOptions extends HoverCardInput {
readonly onOpenChange?: (detail: HoverCardOpenChangeDetail) => void;
readonly scheduler?: Scheduler;
readonly renderTrigger?: (button: HTMLElement) => void;
readonly renderContent?: (panel: HTMLElement) => void;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: HoverCardOpenChangeDetail) => void
optional
renderContent
property
(panel: HTMLElement) => void
optional
renderTrigger
property
(button: HTMLElement) => void
optional
scheduler
property
Scheduler
optional
Name
onOpenChange
Kind
property
Type
(detail: HoverCardOpenChangeDetail) => void
Requirement
optional
Name
renderContent
Kind
property
Type
(panel: HTMLElement) => void
Requirement
optional
Name
renderTrigger
Kind
property
Type
(button: HTMLElement) => void
Requirement
optional
Name
scheduler
Kind
property
Type
Scheduler
Requirement
optional

Popover's command resolver is the one command-resolution seam.

DeclarationView source
runHoverCardCommandts
declare function runHoverCardCommand(command: HoverCardCommand, scope: PartScope, options?: {
readonly onOpenChange?: (detail: {
open: boolean;
reason: HoverCardChangeReason;
}) => void;
}): void;
Name
Kind
Type
Requirement
command
parameter
HoverCardCommand
required
scope
parameter
PartScope
required
options
parameter
{ readonly onOpenChange?: (detail: { open: boolean; reason: HoverCardChangeReason; }) => void; }
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
HoverCardCommand
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
{ readonly onOpenChange?: (detail: { open: boolean; reason: HoverCardChangeReason; }) => void; }
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.

React imports

@grassroot/ui-headless-react/hover-cardts
import { Content, HoverCard, Root, Trigger } from "@grassroot/ui-headless-react/hover-card";

Vue imports

@grassroot/ui-headless-vue/hover-cardts
<script setup lang="ts">
import { HoverCardContent, HoverCardRoot, HoverCardTrigger } from "@grassroot/ui-headless-vue/hover-card";
</script>

Angular imports

@grassroot/ui-headless-angular/hover-cardts
import { Component } from "@angular/core";
import { GR_HOVER_CARD_DECLARATIONS } from "@grassroot/ui-headless-angular/hover-card";
@Component({ standalone: true, imports: [GR_HOVER_CARD_DECLARATIONS], template: `<!-- compose the hover-card parts here -->` })
export class Example {}

Svelte imports

@grassroot/ui-headless-svelte/hover-cardts
<script lang="ts">
import { HoverCardContent, HoverCardRoot, HoverCardTrigger } from "@grassroot/ui-headless-svelte/hover-card";
</script>

Solid imports

@grassroot/ui-headless-solid/hover-cardts
import { HoverCardContent, HoverCardRoot, HoverCardTrigger } from "@grassroot/ui-headless-solid/hover-card";

@grassroot/ui-headless-react/hover-card

React adapter

15 exports
View source packages/ui-headless/react/src/hover-card/index.ts

Content

value
DeclarationView source
Contentts
export declare const Content: import("react").ForwardRefExoticComponent<HoverCardContentProps & import("react").RefAttributes<HTMLDivElement>>;
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

HoverCard

value
DeclarationView source
HoverCardts
export declare const HoverCard: {
Root: import("react").ForwardRefExoticComponent<HoverCardRootProps & import("react").RefAttributes<HTMLDivElement>>;
Trigger: import("react").ForwardRefExoticComponent<HoverCardTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
Content: import("react").ForwardRefExoticComponent<HoverCardContentProps & import("react").RefAttributes<HTMLDivElement>>;
};
Name
Kind
Type
Requirement
Content
property
import("react").ForwardRefExoticComponent<HoverCardContentProps & import("react").RefAttributes<HTMLDivElement>>
required
Root
property
import("react").ForwardRefExoticComponent<HoverCardRootProps & import("react").RefAttributes<HTMLDivElement>>
required
Trigger
property
import("react").ForwardRefExoticComponent<HoverCardTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
required
Name
Content
Kind
property
Type
import("react").ForwardRefExoticComponent<HoverCardContentProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Root
Kind
property
Type
import("react").ForwardRefExoticComponent<HoverCardRootProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Trigger
Kind
property
Type
import("react").ForwardRefExoticComponent<HoverCardTriggerProps & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required
DeclarationView source
HoverCardContentPropsts
interface HoverCardContentProps extends ComponentPropsWithoutRef<"div"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
HoverCardContextts
export declare const HoverCardContext: import("react").Context<HoverCardContextValue | null>;
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
DeclarationView source
HoverCardContextValuets
interface HoverCardContextValue {
readonly service: HoverCardService;
readonly connector: HoverCardApi;
readonly scope: PartScope;
}
Name
Kind
Type
Requirement
connector
property
HoverCardApi
required
scope
property
PartScope
required
service
property
HoverCardService
required
Name
connector
Kind
property
Type
HoverCardApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
HoverCardService
Requirement
required
DeclarationView source
HoverCardOpenChangeDetailts
interface HoverCardOpenChangeDetail {
readonly open: boolean;
readonly reason: HoverCardChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
HoverCardChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
HoverCardChangeReason
Requirement
required

HoverCardRootProps

interface
DeclarationView source
HoverCardRootPropsts
interface HoverCardRootProps extends Omit<ComponentPropsWithoutRef<"div">, "open" | "defaultValue"> {
readonly asChild?: boolean;
readonly open?: HoverCardInput["open"];
readonly defaultOpen?: HoverCardInput["defaultOpen"];
readonly openDelayMs?: HoverCardInput["openDelayMs"];
readonly closeDelayMs?: HoverCardInput["closeDelayMs"];
readonly side?: HoverCardInput["side"];
readonly onOpenChange?: (detail: HoverCardOpenChangeDetail) => void;
readonly scheduler?: UseHoverCardOptions["scheduler"];
readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
closeDelayMs
property
HoverCardInput["closeDelayMs"]
optional
defaultOpen
property
HoverCardInput["defaultOpen"]
optional
onOpenChange
property
(detail: HoverCardOpenChangeDetail) => void
optional
open
property
HoverCardInput["open"]
optional
openDelayMs
property
HoverCardInput["openDelayMs"]
optional
scheduler
property
UseHoverCardOptions["scheduler"]
optional
side
property
HoverCardInput["side"]
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
closeDelayMs
Kind
property
Type
HoverCardInput["closeDelayMs"]
Requirement
optional
Name
defaultOpen
Kind
property
Type
HoverCardInput["defaultOpen"]
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: HoverCardOpenChangeDetail) => void
Requirement
optional
Name
open
Kind
property
Type
HoverCardInput["open"]
Requirement
optional
Name
openDelayMs
Kind
property
Type
HoverCardInput["openDelayMs"]
Requirement
optional
Name
scheduler
Kind
property
Type
UseHoverCardOptions["scheduler"]
Requirement
optional
Name
side
Kind
property
Type
HoverCardInput["side"]
Requirement
optional
DeclarationView source
HoverCardTriggerPropsts
interface HoverCardTriggerProps extends Omit<ComponentPropsWithoutRef<"button">, "type"> {
readonly asChild?: boolean;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<HoverCardRootProps & import("react").RefAttributes<HTMLDivElement>>;
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

Trigger

value
DeclarationView source
Triggerts
export declare const Trigger: import("react").ForwardRefExoticComponent<HoverCardTriggerProps & 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

useHoverCard

function
DeclarationView source
useHoverCardts
declare function useHoverCard(input: HoverCardInput, options?: UseHoverCardOptions): UseHoverCardResult;
Name
Kind
Type
Requirement
input
parameter
HoverCardInput
required
options
parameter
UseHoverCardOptions
optional
return
return value
UseHoverCardResult
n/a
Name
input
Kind
parameter
Type
HoverCardInput
Requirement
required
Name
options
Kind
parameter
Type
UseHoverCardOptions
Requirement
optional
Name
return
Kind
return value
Type
UseHoverCardResult
Requirement
n/a
DeclarationView source
useHoverCardContextts
declare function useHoverCardContext(partName: string): HoverCardContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
HoverCardContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
HoverCardContextValue
Requirement
n/a
DeclarationView source
UseHoverCardOptionsts
interface UseHoverCardOptions {
readonly onOpenChange?: (detail: HoverCardOpenChangeDetail) => void;
readonly scheduler?: Scheduler;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: HoverCardOpenChangeDetail) => void
optional
scheduler
property
Scheduler
optional
Name
onOpenChange
Kind
property
Type
(detail: HoverCardOpenChangeDetail) => void
Requirement
optional
Name
scheduler
Kind
property
Type
Scheduler
Requirement
optional

UseHoverCardResult

interface
DeclarationView source
UseHoverCardResultts
interface UseHoverCardResult {
readonly service: HoverCardService;
readonly connector: HoverCardApi;
readonly scope: PartScope;
readonly snapshot: HoverCardSnapshot;
}
Name
Kind
Type
Requirement
connector
property
HoverCardApi
required
scope
property
PartScope
required
service
property
HoverCardService
required
snapshot
property
HoverCardSnapshot
required
Name
connector
Kind
property
Type
HoverCardApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
HoverCardService
Requirement
required
Name
snapshot
Kind
property
Type
HoverCardSnapshot
Requirement
required

Subscribes a component to a service's committed-snapshot version.

DeclarationView source
useServiceVersionts
declare function useServiceVersion<S extends Service<any, any, any, any, any, any>>(service: S): ReturnType<S["getSnapshot"]>;
Name
Kind
Type
Requirement
service
parameter
S
required
return
return value
ReturnType<S["getSnapshot"]>
n/a
Name
service
Kind
parameter
Type
S
Requirement
required
Name
return
Kind
return value
Type
ReturnType<S["getSnapshot"]>
Requirement
n/a

@grassroot/ui-headless-vue/hover-card

Vue adapter

9 exports
View source packages/ui-headless/vue/src/hover-card/index.ts
DeclarationView source
HoverCardContentts
export declare const HoverCardContent: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
HoverCardContextKeyts
export declare const HoverCardContextKey: InjectionKey<HoverCardContextValue>;
DeclarationView source
HoverCardOpenChangeDetailts
interface HoverCardOpenChangeDetail {
readonly open: boolean;
readonly reason: HoverCardChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
HoverCardChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
HoverCardChangeReason
Requirement
required
DeclarationView source
HoverCardRootts
export declare const HoverCardRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
open: {
type: PropType<HoverCardInput["open"]>;
default: undefined;
};
defaultOpen: {
type: PropType<HoverCardInput["defaultOpen"]>;
default: undefined;
};
openDelayMs: {
type: PropType<HoverCardInput["openDelayMs"]>;
default: undefined;
};
closeDelayMs: {
type: PropType<HoverCardInput["closeDelayMs"]>;
default: undefined;
};
side: {
type: PropType<HoverCardInput["side"]>;
default: undefined;
};
scheduler: {
type: PropType<UseHoverCardOptions["scheduler"]>;
default: undefined;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
openChange: (_detail: HoverCardOpenChangeDetail) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
open: {
type: PropType<HoverCardInput["open"]>;
default: undefined;
};
defaultOpen: {
type: PropType<HoverCardInput["defaultOpen"]>;
default: undefined;
};
openDelayMs: {
type: PropType<HoverCardInput["openDelayMs"]>;
default: undefined;
};
closeDelayMs: {
type: PropType<HoverCardInput["closeDelayMs"]>;
default: undefined;
};
side: {
type: PropType<HoverCardInput["side"]>;
default: undefined;
};
scheduler: {
type: PropType<UseHoverCardOptions["scheduler"]>;
default: undefined;
};
}>> & Readonly<{
onOpenChange?: ((_detail: HoverCardOpenChangeDetail) => any) | undefined;
}>, {
asChild: boolean;
open: boolean | undefined;
defaultOpen: boolean | undefined;
openDelayMs: number | undefined;
closeDelayMs: number | undefined;
side: "bottom" | "top" | undefined;
scheduler: import("@grassroot/statechart/scheduler").Scheduler | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
DeclarationView source
HoverCardTriggerts
export declare const HoverCardTrigger: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>, () => 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<{
asChild: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

useHoverCard

function
DeclarationView source
useHoverCardts
declare function useHoverCard(input: HoverCardInput | (() => HoverCardInput), options?: UseHoverCardOptions): UseHoverCardResult;
Name
Kind
Type
Requirement
input
parameter
HoverCardInput | (() => HoverCardInput)
required
options
parameter
UseHoverCardOptions
optional
return
return value
UseHoverCardResult
n/a
Name
input
Kind
parameter
Type
HoverCardInput | (() => HoverCardInput)
Requirement
required
Name
options
Kind
parameter
Type
UseHoverCardOptions
Requirement
optional
Name
return
Kind
return value
Type
UseHoverCardResult
Requirement
n/a
DeclarationView source
useHoverCardContextts
declare function useHoverCardContext(partName: string): HoverCardContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
HoverCardContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
HoverCardContextValue
Requirement
n/a
DeclarationView source
UseHoverCardOptionsts
interface UseHoverCardOptions {
readonly onOpenChange?: (detail: HoverCardOpenChangeDetail) => void;
readonly scheduler?: Scheduler;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: HoverCardOpenChangeDetail) => void
optional
scheduler
property
Scheduler
optional
Name
onOpenChange
Kind
property
Type
(detail: HoverCardOpenChangeDetail) => void
Requirement
optional
Name
scheduler
Kind
property
Type
Scheduler
Requirement
optional

UseHoverCardResult

interface
DeclarationView source
UseHoverCardResultts
interface UseHoverCardResult {
readonly service: HoverCardService;
readonly connector: HoverCardApi;
readonly scope: PartScope;
readonly snapshot: ShallowRef<HoverCardSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
HoverCardApi
required
scope
property
PartScope
required
service
property
HoverCardService
required
snapshot
property
ShallowRef<HoverCardSnapshot>
required
Name
connector
Kind
property
Type
HoverCardApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
HoverCardService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<HoverCardSnapshot>
Requirement
required

@grassroot/ui-headless-angular/hover-card

Angular adapter

12 exports
View source packages/ui-headless/angular/src/hover-card/index.ts
DeclarationView source
createHoverCardStorets
export declare function createHoverCardStore(initialInput: HoverCardInput, options?: CreateHoverCardStoreOptions): HoverCardStore;
Name
Kind
Type
Requirement
initialInput
parameter
HoverCardInput
required
options
parameter
CreateHoverCardStoreOptions
optional
return
return value
HoverCardStore
n/a
Name
initialInput
Kind
parameter
Type
HoverCardInput
Requirement
required
Name
options
Kind
parameter
Type
CreateHoverCardStoreOptions
Requirement
optional
Name
return
Kind
return value
Type
HoverCardStore
Requirement
n/a
DeclarationView source
CreateHoverCardStoreOptionsts
export interface CreateHoverCardStoreOptions {
readonly onOpenChange?: (detail: HoverCardOpenChangeDetail) => void;
readonly onCommit?: () => void;
readonly scheduler?: Scheduler;
}
Name
Kind
Type
Requirement
onCommit
property
() => void
optional
onOpenChange
property
(detail: HoverCardOpenChangeDetail) => void
optional
scheduler
property
Scheduler
optional
Name
onCommit
Kind
property
Type
() => void
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: HoverCardOpenChangeDetail) => void
Requirement
optional
Name
scheduler
Kind
property
Type
Scheduler
Requirement
optional

One re-entrancy policy for every Angular store's zoneless commit nudge.

DeclarationView source
createReentrantSafeTickts
export declare function createReentrantSafeTick(appRef: ApplicationRef): () => void;
Name
Kind
Type
Requirement
appRef
parameter
ApplicationRef
required
return
return value
() => void
n/a
Name
appRef
Kind
parameter
Type
ApplicationRef
Requirement
required
Name
return
Kind
return value
Type
() => void
Requirement
n/a
DeclarationView source
GR_HOVER_CARD_DECLARATIONSts
export declare const GR_HOVER_CARD_DECLARATIONS: readonly [];
DeclarationView source
GrHoverCardContentts
export declare class GrHoverCardContent implements OnDestroy {
private readonly store;
private readonly element;
private readonly listeners;
private readonly consumer;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrHoverCardContent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrHoverCardContent, "[grHoverCardContent]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrHoverCardContent, "[grHoverCardContent]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrHoverCardContent, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
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<GrHoverCardContent, "[grHoverCardContent]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrHoverCardContent, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
GrHoverCardOpents
export declare class GrHoverCardOpen implements OnDestroy {
private readonly store;
private readonly template;
private readonly view;
private rendered;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrHoverCardOpen, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrHoverCardOpen, "[grHoverCardOpen]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrHoverCardOpen, "[grHoverCardOpen]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrHoverCardOpen, never>
required
rendered
property
any
required
store
property
any
required
template
property
any
required
view
property
any
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrHoverCardOpen, "[grHoverCardOpen]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrHoverCardOpen, never>
Requirement
required
Name
rendered
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
Name
template
Kind
property
Type
any
Requirement
required
Name
view
Kind
property
Type
any
Requirement
required
DeclarationView source
GrHoverCardRootts
export declare class GrHoverCardRoot implements OnDestroy {
readonly open: import("@angular/core").InputSignal<boolean | undefined>;
readonly defaultOpen: import("@angular/core").InputSignal<boolean | undefined>;
readonly openDelayMs: import("@angular/core").InputSignal<number | undefined>;
readonly closeDelayMs: import("@angular/core").InputSignal<number | undefined>;
readonly side: import("@angular/core").InputSignal<"bottom" | "top" | undefined>;
readonly openChange: import("@angular/core").OutputEmitterRef<HoverCardOpenChangeDetail>;
private readonly element;
private readonly injector;
private readonly appRef;
private readonly listeners;
private last;
readonly store: HoverCardStore;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrHoverCardRoot, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<GrHoverCardRoot, "gr-hover-card-root", never, { "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "openDelayMs": { "alias": "openDelayMs"; "required": false; "isSignal": true; }; "closeDelayMs": { "alias": "closeDelayMs"; "required": false; "isSignal": true; }; "side": { "alias": "side"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; }, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
appRef
property
any
required
closeDelayMs
property
import("@angular/core").InputSignal<number | undefined>
required
defaultOpen
property
import("@angular/core").InputSignal<boolean | undefined>
required
element
property
any
required
injector
property
any
required
last
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
open
property
import("@angular/core").InputSignal<boolean | undefined>
required
openChange
property
import("@angular/core").OutputEmitterRef<HoverCardOpenChangeDetail>
required
openDelayMs
property
import("@angular/core").InputSignal<number | undefined>
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrHoverCardRoot, "gr-hover-card-root", never, { "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "openDelayMs": { "alias": "openDelayMs"; "required": false; "isSignal": true; }; "closeDelayMs": { "alias": "closeDelayMs"; "required": false; "isSignal": true; }; "side": { "alias": "side"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; }, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrHoverCardRoot, never>
required
side
property
import("@angular/core").InputSignal<"bottom" | "top" | undefined>
required
Name
appRef
Kind
property
Type
any
Requirement
required
Name
closeDelayMs
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
defaultOpen
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
injector
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
open
Kind
property
Type
import("@angular/core").InputSignal<boolean | undefined>
Requirement
required
Name
openChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<HoverCardOpenChangeDetail>
Requirement
required
Name
openDelayMs
Kind
property
Type
import("@angular/core").InputSignal<number | undefined>
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrHoverCardRoot, "gr-hover-card-root", never, { "open": { "alias": "open"; "required": false; "isSignal": true; }; "defaultOpen": { "alias": "defaultOpen"; "required": false; "isSignal": true; }; "openDelayMs": { "alias": "openDelayMs"; "required": false; "isSignal": true; }; "closeDelayMs": { "alias": "closeDelayMs"; "required": false; "isSignal": true; }; "side": { "alias": "side"; "required": false; "isSignal": true; }; }, { "openChange": "openChange"; }, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrHoverCardRoot, never>
Requirement
required
Name
side
Kind
property
Type
import("@angular/core").InputSignal<"bottom" | "top" | undefined>
Requirement
required
Name
store
Kind
property
Type
HoverCardStore
Requirement
required
DeclarationView source
GrHoverCardTriggerts
export declare class GrHoverCardTrigger implements OnDestroy {
private readonly store;
private readonly element;
private readonly listeners;
private readonly consumer;
constructor();
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<GrHoverCardTrigger, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<GrHoverCardTrigger, "[grHoverCardTrigger]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrHoverCardTrigger, "[grHoverCardTrigger]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrHoverCardTrigger, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
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<GrHoverCardTrigger, "[grHoverCardTrigger]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrHoverCardTrigger, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required
DeclarationView source
HOVER_CARD_STOREts
export declare const HOVER_CARD_STORE: InjectionToken<HoverCardStore>;
DeclarationView source
HoverCardOpenChangeDetailts
export interface HoverCardOpenChangeDetail {
readonly open: boolean;
readonly reason: HoverCardChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
HoverCardChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
HoverCardChangeReason
Requirement
required

HoverCardStore

interface
DeclarationView source
HoverCardStorets
export interface HoverCardStore {
readonly service: HoverCardService;
readonly connector: HoverCardApi;
readonly scope: PartScope;
readonly version: WritableSignal<number>;
start(): void;
stop(): void;
sync(input: HoverCardInput): void;
bindOpenChange(handler: (detail: import("./use-hover-card.js").HoverCardOpenChangeDetail) => void): void;
}
Name
Kind
Type
Requirement
bindOpenChange
method
(handler: (detail: import("./use-hover-card.js").HoverCardOpenChangeDetail) => void) => void
required
connector
property
HoverCardApi
required
scope
property
PartScope
required
service
property
HoverCardService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: HoverCardInput) => void
required
version
property
WritableSignal<number>
required
Name
bindOpenChange
Kind
method
Type
(handler: (detail: import("./use-hover-card.js").HoverCardOpenChangeDetail) => void) => void
Requirement
required
Name
connector
Kind
property
Type
HoverCardApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
HoverCardService
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: HoverCardInput) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required
DeclarationView source
provideHoverCardStorets
export declare function provideHoverCardStore(): Provider;
Name
Kind
Type
Requirement
return
return value
Provider
n/a
Name
return
Kind
return value
Type
Provider
Requirement
n/a

@grassroot/ui-headless-svelte/hover-card

Svelte adapter

9 exports
View source packages/ui-headless/svelte/src/hover-card/index.ts

createHoverCard

function
DeclarationView source
createHoverCardts
export declare function createHoverCard(inputGetter: () => HoverCardInput, options?: UseHoverCardOptions): UseHoverCardResult;
Name
Kind
Type
Requirement
inputGetter
parameter
() => HoverCardInput
required
options
parameter
UseHoverCardOptions
optional
return
return value
UseHoverCardResult
n/a
Name
inputGetter
Kind
parameter
Type
() => HoverCardInput
Requirement
required
Name
options
Kind
parameter
Type
UseHoverCardOptions
Requirement
optional
Name
return
Kind
return value
Type
UseHoverCardResult
Requirement
n/a
DeclarationView source
HoverCardContentts
export declare const HoverCardContent: 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
DeclarationView source
HoverCardOpenChangeDetailts
export interface HoverCardOpenChangeDetail {
readonly open: boolean;
readonly reason: HoverCardChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
HoverCardChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
HoverCardChangeReason
Requirement
required
DeclarationView source
HoverCardRootts
export declare const HoverCardRoot: 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
DeclarationView source
HoverCardTriggerts
export declare const HoverCardTrigger: 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
DeclarationView source
provideHoverCardContextts
export declare function provideHoverCardContext(value: HoverCardContextValue): void;
Name
Kind
Type
Requirement
value
parameter
HoverCardContextValue
required
return
return value
void
n/a
Name
value
Kind
parameter
Type
HoverCardContextValue
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a
DeclarationView source
useHoverCardContextts
export declare function useHoverCardContext(partName: string): HoverCardContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
HoverCardContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
HoverCardContextValue
Requirement
n/a
DeclarationView source
UseHoverCardOptionsts
export interface UseHoverCardOptions {
readonly onOpenChange?: (detail: HoverCardOpenChangeDetail) => void;
readonly scheduler?: Scheduler;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: HoverCardOpenChangeDetail) => void
optional
scheduler
property
Scheduler
optional
Name
onOpenChange
Kind
property
Type
(detail: HoverCardOpenChangeDetail) => void
Requirement
optional
Name
scheduler
Kind
property
Type
Scheduler
Requirement
optional

UseHoverCardResult

interface
DeclarationView source
UseHoverCardResultts
export interface UseHoverCardResult {
readonly service: HoverCardService;
readonly connector: HoverCardApi;
readonly scope: PartScope;
readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
HoverCardApi
required
scope
property
PartScope
required
service
property
HoverCardService
required
version
property
() => number
required
Name
connector
Kind
property
Type
HoverCardApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
HoverCardService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

@grassroot/ui-headless-solid/hover-card

Solid adapter

13 exports
View source packages/ui-headless/solid/src/hover-card/index.ts

HoverCardContent

function
DeclarationView source
HoverCardContentts
export declare function HoverCardContent(props: HoverCardContentProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
HoverCardContentProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
HoverCardContentProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
HoverCardContentPropsts
export interface HoverCardContentProps extends JSX.HTMLAttributes<HTMLDivElement> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional
DeclarationView source
HoverCardContextts
export declare const HoverCardContext: import("solid-js").Context<HoverCardContextValue | undefined>;
DeclarationView source
HoverCardContextValuets
export interface HoverCardContextValue {
readonly service: HoverCardService;
readonly connector: HoverCardApi;
readonly scope: PartScope;
readonly snapshot: Accessor<HoverCardSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
HoverCardApi
required
scope
property
PartScope
required
service
property
HoverCardService
required
snapshot
property
Accessor<HoverCardSnapshot>
required
Name
connector
Kind
property
Type
HoverCardApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
HoverCardService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<HoverCardSnapshot>
Requirement
required
DeclarationView source
HoverCardOpenChangeDetailts
export interface HoverCardOpenChangeDetail {
readonly open: boolean;
readonly reason: HoverCardChangeReason;
}
Name
Kind
Type
Requirement
open
property
boolean
required
reason
property
HoverCardChangeReason
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
reason
Kind
property
Type
HoverCardChangeReason
Requirement
required

HoverCardRoot

function
DeclarationView source
HoverCardRootts
export declare function HoverCardRoot(props: HoverCardRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
HoverCardRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
HoverCardRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

HoverCardRootProps

interface
DeclarationView source
HoverCardRootPropsts
export interface HoverCardRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange"> {
readonly as?: AsProp;
readonly open?: HoverCardInput["open"];
readonly defaultOpen?: HoverCardInput["defaultOpen"];
readonly openDelayMs?: HoverCardInput["openDelayMs"];
readonly closeDelayMs?: HoverCardInput["closeDelayMs"];
readonly side?: HoverCardInput["side"];
readonly onOpenChange?: (detail: HoverCardOpenChangeDetail) => void;
readonly scheduler?: UseHoverCardOptions["scheduler"];
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
closeDelayMs
property
HoverCardInput["closeDelayMs"]
optional
defaultOpen
property
HoverCardInput["defaultOpen"]
optional
onOpenChange
property
(detail: HoverCardOpenChangeDetail) => void
optional
open
property
HoverCardInput["open"]
optional
openDelayMs
property
HoverCardInput["openDelayMs"]
optional
scheduler
property
UseHoverCardOptions["scheduler"]
optional
side
property
HoverCardInput["side"]
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional
Name
closeDelayMs
Kind
property
Type
HoverCardInput["closeDelayMs"]
Requirement
optional
Name
defaultOpen
Kind
property
Type
HoverCardInput["defaultOpen"]
Requirement
optional
Name
onOpenChange
Kind
property
Type
(detail: HoverCardOpenChangeDetail) => void
Requirement
optional
Name
open
Kind
property
Type
HoverCardInput["open"]
Requirement
optional
Name
openDelayMs
Kind
property
Type
HoverCardInput["openDelayMs"]
Requirement
optional
Name
scheduler
Kind
property
Type
UseHoverCardOptions["scheduler"]
Requirement
optional
Name
side
Kind
property
Type
HoverCardInput["side"]
Requirement
optional

HoverCardTrigger

function
DeclarationView source
HoverCardTriggerts
export declare function HoverCardTrigger(props: HoverCardTriggerProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
HoverCardTriggerProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
HoverCardTriggerProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a
DeclarationView source
HoverCardTriggerPropsts
export interface HoverCardTriggerProps extends Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "type"> {
readonly as?: AsProp;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional

useHoverCard

function
DeclarationView source
useHoverCardts
export declare function useHoverCard(input: Accessor<HoverCardInput>, options?: UseHoverCardOptions): UseHoverCardResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<HoverCardInput>
required
options
parameter
UseHoverCardOptions
optional
return
return value
UseHoverCardResult
n/a
Name
input
Kind
parameter
Type
Accessor<HoverCardInput>
Requirement
required
Name
options
Kind
parameter
Type
UseHoverCardOptions
Requirement
optional
Name
return
Kind
return value
Type
UseHoverCardResult
Requirement
n/a
DeclarationView source
useHoverCardContextts
export declare function useHoverCardContext(partName: string): HoverCardContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
HoverCardContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
HoverCardContextValue
Requirement
n/a
DeclarationView source
UseHoverCardOptionsts
export interface UseHoverCardOptions {
readonly onOpenChange?: (detail: HoverCardOpenChangeDetail) => void;
readonly scheduler?: Scheduler;
}
Name
Kind
Type
Requirement
onOpenChange
property
(detail: HoverCardOpenChangeDetail) => void
optional
scheduler
property
Scheduler
optional
Name
onOpenChange
Kind
property
Type
(detail: HoverCardOpenChangeDetail) => void
Requirement
optional
Name
scheduler
Kind
property
Type
Scheduler
Requirement
optional

UseHoverCardResult

interface
DeclarationView source
UseHoverCardResultts
export interface UseHoverCardResult {
readonly service: HoverCardService;
readonly connector: HoverCardApi;
readonly scope: PartScope;
readonly snapshot: Accessor<HoverCardSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
HoverCardApi
required
scope
property
PartScope
required
service
property
HoverCardService
required
snapshot
property
Accessor<HoverCardSnapshot>
required
Name
connector
Kind
property
Type
HoverCardApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
HoverCardService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<HoverCardSnapshot>
Requirement
required