Skip to content
Overlays

Tooltip

client43.5 kB
@stellaria/nebula-webTooltipProps

Preview

Props

15
PropTypeDefault

className

string

—

closeDelay

Delay before closing on leave, which is what lets you travel from the trigger to the bubble.

number150

color

"inverted" | "neutral""neutral"

crossOffset

Offset along the perpendicular axis, in px.

number

—

defaultOpened

boolean

—

delay

Delay before opening on hover. At zero it opens on enter.

number0

disabled

Neither rendered nor announced. The trigger loses its description, so this is not the way to hide it temporarily.

booleanfalse

label

required

The bubble text. It arrives through `aria-describedby`, which **describes**: it does not replace the trigger name, so an icon-only button still needs its `aria-label`.

ReactNode

—

maw

Maximum width of the bubble. It shadows the `maw` style prop, which here would land on the trigger.

string | number

—

offset

Distance from the trigger, in px, along the `placement` axis.

number8

onOpenChange

((opened: boolean) => void)

—

opened

Passing it makes the tooltip controlled: pointer and focus stop opening it and it only emits `onOpenChange`.

boolean

—

placement

The REQUESTED placement. If it does not fit, React Aria changes it.

PopoverPlacement"top"

trigger

required

The element that triggers it. It receives the `ref` and the `aria-describedby`, so it has to forward them.

OverlayTriggerElement

—

withArrow

booleanfalse

Also accepts

On top of its own props, this component forwards these groups.

Style props · 127