Askr documentation
Generated API snapshot

@askrjs/ui/hover-card

Exports from the declarations published in @askrjs/ui. Signatures reflect the published artifact.

Exports

This entrypoint publishes 12 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

HoverCardtype

HoverCard: (props: HoverCardProps) => JSX.Element

Renders a part of `hover-card`.

HoverCardAsChildPropstype

HoverCardAsChildProps: HoverCardOwnProps & {
  asChild: true;
  children: JSX.Element;
}

Props for the `asChild` (polymorphic) rendering of Hover Card.

asChild
asChild: true;
children
children: JSX.Element;
closeDelay
closeDelay?: number | undefined;
defaultOpen
defaultOpen?: boolean | undefined;
id
id?: string | undefined;
onOpenChange
onOpenChange?: ((open: boolean) => void) | undefined;
open
open?: boolean | undefined;
openDelay
openDelay?: number | undefined;

HoverCardContenttype

HoverCardContent: { (props: HoverCardContentProps): JSX.Element | null; (props: HoverCardContentAsChildProps): JSX.Element | null; }

Renders the `hover-card-content` part of `hover-card` with `role="dialog"`. Supports polymorphic rendering via `asChild`.

HoverCardContentAsChildPropstype

HoverCardContentAsChildProps: BoxAsChildProps & HoverCardContentOwnProps

Props for the `asChild` (polymorphic) rendering of Hover Card Content.

align
align?: OverlayAlign | undefined;
asChild
asChild: true;
children
children: JSXElement;
forceMount
forceMount?: boolean | undefined;
ref
ref?: Ref<Element>;
side
side?: OverlaySide | undefined;
sideOffset
sideOffset?: number | undefined;

HoverCardContentPropstype

HoverCardContentProps: BoxProps<'div', HTMLDivElement> & HoverCardContentOwnProps

Props for Hover Card Content.

align
align?: OverlayAlign | undefined;
asChild
asChild?: false | undefined;
children
children?: unknown;
forceMount
forceMount?: boolean | undefined;
ref
ref?: Ref<HTMLDivElement>;
side
side?: OverlaySide | undefined;
sideOffset
sideOffset?: number | undefined;

HoverCardOwnPropstype

HoverCardOwnProps: {
  children?: unknown;
  id?: string;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
  openDelay?: number;
  closeDelay?: number;
}

Own props for Hover Card, before merging with native element attributes.

children
children?: unknown;
closeDelay
closeDelay?: number | undefined;
defaultOpen
defaultOpen?: boolean | undefined;
id
id?: string | undefined;
onOpenChange
onOpenChange?: ((open: boolean) => void) | undefined;
open
open?: boolean | undefined;
openDelay
openDelay?: number | undefined;

HoverCardPortaltype

HoverCardPortal: (props: HoverCardPortalProps) => JSX.Element | null

Renders a part of `hover-card`.

HoverCardPortalPropstype

HoverCardPortalProps: {
  children?: unknown;
}

Props for Hover Card Portal.

children
children?: unknown;

HoverCardPropstype

HoverCardProps: HoverCardOwnProps

Props for Hover Card.

children
children?: unknown;
closeDelay
closeDelay?: number | undefined;
defaultOpen
defaultOpen?: boolean | undefined;
id
id?: string | undefined;
onOpenChange
onOpenChange?: ((open: boolean) => void) | undefined;
open
open?: boolean | undefined;
openDelay
openDelay?: number | undefined;

HoverCardTriggertype

HoverCardTrigger: { (props: HoverCardTriggerProps): JSX.Element; (props: HoverCardTriggerAsChildProps): JSX.Element; }

Renders the `hover-card-trigger` part of `hover-card`. Supports polymorphic rendering via `asChild`.

HoverCardTriggerAsChildPropstype

HoverCardTriggerAsChildProps: ButtonLikeAsChildProps

Props for the `asChild` (polymorphic) rendering of Hover Card Trigger.

asChild
asChild: true;
children
children: JSXElement;
disabled
disabled?: boolean | undefined;
onPress
onPress?: ((event: PressEvent) => void) | undefined;
ref
ref?: Ref<Element>;
type
type?: undefined;

HoverCardTriggerPropstype

HoverCardTriggerProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Hover Card Trigger.

asChild
asChild?: false | undefined;
children
children?: unknown;
disabled
disabled?: boolean | undefined;
onPress
onPress?: ((event: PressEvent) => void) | undefined;
ref
ref?: Ref<HTMLButtonElement>;
type
type?: "button" | "submit" | "reset" | undefined;