Askr documentation
Generated API snapshot

@askrjs/ui/tooltip

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.

Tooltiptype

Tooltip: (props: TooltipProps) => import("@askrjs/askr/jsx-runtime").JSX.Element

Renders a part of tooltip.

TooltipContenttype

TooltipContent: { (props: TooltipContentProps): JSX.Element | null; (props: TooltipContentAsChildProps): JSX.Element | null; }

Renders the tooltip-content part of tooltip with role="tooltip". Supports polymorphic rendering via asChild.

TooltipContentAsChildPropstype

TooltipContentAsChildProps: BoxAsChildProps & TooltipContentOwnProps

Props for the asChild (polymorphic) rendering of Tooltip 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;

TooltipContentOwnPropstype

TooltipContentOwnProps: {
  forceMount?: boolean;
  side?: OverlaySide;
  align?: OverlayAlign;
  sideOffset?: number;
}

Own props for Tooltip Content, before merging with native element attributes.

align
align?: OverlayAlign | undefined;
forceMount
forceMount?: boolean | undefined;
side
side?: OverlaySide | undefined;
sideOffset
sideOffset?: number | undefined;

TooltipContentPropstype

TooltipContentProps: BoxProps<'div', HTMLDivElement> & TooltipContentOwnProps

Props for Tooltip 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;

TooltipOwnPropstype

TooltipOwnProps: {
  children?: unknown;
  id?: string;
  open?: boolean;
  defaultOpen?: boolean;
  onOpenChange?: (open: boolean) => void;
}

Own props for Tooltip, before merging with native element attributes.

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

TooltipPortaltype

TooltipPortal: (props: TooltipPortalProps) => JSX.Element | null

Renders a part of tooltip.

TooltipPortalPropstype

TooltipPortalProps: {
  children?: unknown;
}

Props for Tooltip Portal.

children
children?: unknown;

TooltipPropstype

TooltipProps: TooltipOwnProps

Props for Tooltip.

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

TooltipTriggertype

TooltipTrigger: { (props: TooltipTriggerProps): JSX.Element; (props: TooltipTriggerAsChildProps): JSX.Element; }

Renders the tooltip-trigger part of tooltip. Supports polymorphic rendering via asChild.

TooltipTriggerAsChildPropstype

TooltipTriggerAsChildProps: ButtonLikeAsChildProps

Props for the asChild (polymorphic) rendering of Tooltip Trigger.

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

TooltipTriggerPropstype

TooltipTriggerProps: ButtonLikeProps<'button', HTMLButtonElement>

Props for Tooltip 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;