useTooltip

useTooltip(opts?): object

Defined in: react/components/overlay/tooltip.tsx:83

State helper for Tooltip: shows the tip after a hover delay and hides it on leave. Attach ref + spread triggerProps on the trigger, and spread props on <Tooltip>.

Parameters

opts?

delay?

number

Returns

open

open: boolean

props

props: object

Spread on <Tooltip>: open + anchorRef.

props.anchorRef

anchorRef: RefObject<Widget | null>

props.open

open: boolean

ref

ref: RefObject<Widget | null>

Ref to attach to the trigger widget.

triggerProps

triggerProps: object

Spread on the trigger: hover handlers + hover-interest opt-in.

triggerProps.hoverInterest

hoverInterest: true

triggerProps.onMouseEnter

onMouseEnter: () => void

Returns

void

triggerProps.onMouseLeave

onMouseLeave: () => void

Returns

void