BetaPublic beta — Read the release notes
Solidiom
Get Started
Documentation

Tooltip

Contextual hint shown on hover/focus.

Package
@solidiom/tooltip
Version
0.0.1-next.0
Status
stable

Generated from the package's public source.

API

Contentcomponent

@solidiom/tooltip — Headless tooltip primitive with hover/focus activation and delay. Parts: Root, Trigger, Content.

                        Content(props: TooltipContentProps): Element

Props

class?
string
ref?
(el: HTMLDivElement) => void
style?
string | CSSProperties

children: Element

View source

PositioningPortinterface

Positioning adapter port injected by the consumer.

Props

update
(reference: HTMLElement, floating: HTMLElement) => void | () => void — Compute and apply position styles to the content element.

View source

Rootcomponent

@solidiom/tooltip — Headless tooltip primitive with hover/focus activation and delay. Parts: Root, Trigger, Content.

                        Root(props: TooltipRootProps): Element

Props

closeDelay?
number — Delay in ms before closing on mouseleave. Default: 300.
defaultOpen?
boolean — Default open state (uncontrolled).
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void — Called when open state change is requested.
open?
Accessor<boolean> — Controlled open state.
openDelay?
number — Delay in ms before opening on hover. Default: 700.
positioning?
PositioningPort — Positioning adapter for floating placement.

children: Element

View source

TooltipContentPropsinterface

Props for the tooltip content element.

Props

class?
string
ref?
(el: HTMLDivElement) => void
style?
string | CSSProperties

children: Element

View source

TooltipRootPropsinterface

Props for the tooltip root provider.

Props

closeDelay?
number — Delay in ms before closing on mouseleave. Default: 300.
defaultOpen?
boolean — Default open state (uncontrolled).
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void — Called when open state change is requested.
open?
Accessor<boolean> — Controlled open state.
openDelay?
number — Delay in ms before opening on hover. Default: 700.
positioning?
PositioningPort — Positioning adapter for floating placement.

children: Element

View source

TooltipTriggerPropsinterface

Props for the tooltip trigger element.

Props

ref?
(el: HTMLElement) => void

children: Element

View source

Triggercomponent

@solidiom/tooltip — Headless tooltip primitive with hover/focus activation and delay. Parts: Root, Trigger, Content.

                        Trigger(props: TooltipTriggerProps): Element

Props

ref?
(el: HTMLElement) => void

children: Element

View source