Tooltip

#Anatomy

Import the component's parts and compose them under its root:

use base_gpui::tooltip::{
    TooltipPopup,
    TooltipPortal,
    TooltipPositioner,
    TooltipProvider,
    TooltipProvider,
    TooltipRoot,
    TooltipTrigger,
    TooltipViewport,
};

TooltipRoot::new()
    .child(
        TooltipPortal::new()
                .child(
                    TooltipPositioner::new()
                                .child(
                                    TooltipPopup::new()
                                                    .child(
                                                        TooltipViewport::new(),
                                                    ),
                                ),
                ),
    )
    .child(
        TooltipTrigger::new(),
    );

The anatomy is a structural overview. Parts with mutually exclusive modes may need separate instances; each part's section below documents its configuration.

#`TooltipRoot`

Coordinates the component's state and supplies context to its child parts.

Source

use base_gpui::tooltip::TooltipRoot;

TooltipRoot::new()
    .id("example-id")
    .default_open(true)
    .open(true)
    .on_open_change(|/* callback arguments */| { /* handle change */ })
    .on_open_change_complete(|/* callback arguments */| { /* handle change */ })
    .disabled(true)
    .disable_hoverable_popup(true)
    .track_cursor_axis(/* track_cursor_axis: TooltipTrackCursorAxis */)
    .trigger_id("example-id")
    .no_trigger_id()
    .default_trigger_id("example-id")
    .handle(/* handle: TooltipHandle<P> */)
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

Builder	Signature & description
`.new`	`pub fn new() -> Self` Creates a TooltipRoot with its default configuration.
`.child`	`pub fn child(mut self, child: impl Into<TooltipChild<P>>) -> Self` `child`: `impl Into<TooltipChild<P>>` Adds one typed child to this part.
`.children`	`pub fn children(mut self, children: impl IntoIterator<Item = impl Into<TooltipChild<P>>>,) -> Self` `children`: `impl IntoIterator<Item = impl Into<TooltipChild<P>>>` Adds multiple typed children in iteration order.
`.child_any`	`pub fn child_any(mut self, child: impl IntoElement) -> Self` `child`: `impl IntoElement` Adds one arbitrary renderable child to this part.
`.id`	`pub fn id(mut self, id: impl Into<ElementId>) -> Self` `id`: `impl Into<ElementId>` Sets the stable GPUI element identity. Use a unique value when multiple instances can appear in the same view.
`.default_open`	`pub fn default_open(mut self, default_open: bool) -> Self` `default_open`: `bool` Sets the initial open state for an uncontrolled component.
`.open`	`pub fn open(mut self, open: bool) -> Self` `open`: `bool` Controls whether the component is open.
`.on_open_change`	`pub fn on_open_change(mut self, on_open_change: impl Fn(bool, &mut TooltipOpenChangeDetails<P>, &mut Window, &mut App) + 'static,) -> Self` `on_open_change`: `impl Fn(bool, &mut TooltipOpenChangeDetails<P>, &mut Window, &mut App) + 'static` Registers a callback invoked when open change occurs.
`.on_open_change_complete`	`pub fn on_open_change_complete(mut self, on_open_change_complete: impl Fn(bool, &TooltipOpenChangeDetails<P>, &mut Window, &mut App) + 'static,) -> Self` `on_open_change_complete`: `impl Fn(bool, &TooltipOpenChangeDetails<P>, &mut Window, &mut App) + 'static` Registers a callback invoked when open change complete occurs.
`.disabled`	`pub fn disabled(mut self, disabled: bool) -> Self` `disabled`: `bool` When true, prevents user interaction with this part.
`.disable_hoverable_popup`	`pub fn disable_hoverable_popup(mut self, disable_hoverable_popup: bool) -> Self` `disable_hoverable_popup`: `bool` Controls whether disable hoverable popup behavior is enabled.
`.track_cursor_axis`	`pub fn track_cursor_axis(mut self, track_cursor_axis: TooltipTrackCursorAxis) -> Self` `track_cursor_axis`: `TooltipTrackCursorAxis` Sets the track cursor axis configuration for this part.
`.trigger_id`	`pub fn trigger_id(mut self, trigger_id: impl Into<ElementId>) -> Self` `trigger_id`: `impl Into<ElementId>` Sets the trigger id configuration for this part.
`.no_trigger_id`	`pub fn no_trigger_id(mut self) -> Self` Sets the no trigger id configuration for this part.
`.default_trigger_id`	`pub fn default_trigger_id(mut self, trigger_id: impl Into<ElementId>) -> Self` `trigger_id`: `impl Into<ElementId>` Sets the initial trigger id for uncontrolled state.
`.handle`	`pub fn handle(mut self, handle: TooltipHandle<P>) -> Self` `handle`: `TooltipHandle<P>` Sets the handle configuration for this part.
`.style_with_state`	`pub fn style_with_state(mut self, style: impl Fn(TooltipRootStyleState<P>, Div) -> Div + 'static,) -> Self` `style`: `impl Fn(TooltipRootStyleState<P>, Div) -> Div + 'static,` Styles the part from its current behavioral state while preserving separation between behavior and visual design. TooltipRoot also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#`TooltipTrigger`

Interactive control that opens, closes, or activates the component.

Source

use base_gpui::tooltip::TooltipTrigger;

TooltipTrigger::new()
    .id("example-id")
    .disabled(true)
    .payload(/* payload: P */)
    .handle(/* handle: TooltipHandle<P> */)
    .delay(/* delay: Duration */)
    .close_delay(/* close_delay: Duration */)
    .close_on_click(true)
    .aria_label("label")
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

Builder	Signature & description
`.new`	`pub fn new() -> Self` Creates a TooltipTrigger with its default configuration.
`.id`	`pub fn id(mut self, id: impl Into<ElementId>) -> Self` `id`: `impl Into<ElementId>` Sets the stable GPUI element identity. Use a unique value when multiple instances can appear in the same view.
`.disabled`	`pub fn disabled(mut self, disabled: bool) -> Self` `disabled`: `bool` When true, prevents user interaction with this part.
`.payload`	`pub fn payload(mut self, payload: P) -> Self` `payload`: `P` Sets the payload configuration for this part.
`.handle`	`pub fn handle(mut self, handle: TooltipHandle<P>) -> Self` `handle`: `TooltipHandle<P>` Sets the handle configuration for this part.
`.delay`	`pub fn delay(mut self, delay: Duration) -> Self` `delay`: `Duration` Sets the delay before the related transition or interaction begins.
`.close_delay`	`pub fn close_delay(mut self, close_delay: Duration) -> Self` `close_delay`: `Duration` Sets the delay before an open component closes after the closing interaction.
`.close_on_click`	`pub fn close_on_click(mut self, close_on_click: bool) -> Self` `close_on_click`: `bool` Controls whether close on click behavior is enabled.
`.aria_label`	`pub fn aria_label(mut self, label: impl Into<SharedString>) -> Self` `label`: `impl Into<SharedString>` Accessible name for the trigger. There is no derived default because trigger children are arbitrary elements, so icon-only triggers must set this. When a visible text child duplicates this label, render it with `Text::new_inaccessible(...)` instead of `text!(...)` to avoid double-announcing. Tooltip content is not an accessible description of the trigger (no `aria-describedby` relationship exists in this gpui revision), so do not rely on the popup for the trigger's name.
`.style_with_state`	`pub fn style_with_state(mut self, style: impl Fn(TooltipTriggerStyleState<P>, Div) -> Div + 'static,) -> Self` `style`: `impl Fn(TooltipTriggerStyleState<P>, Div) -> Div + 'static,` Styles the part from its current behavioral state while preserving separation between behavior and visual design. TooltipTrigger also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#`TooltipPortal`

Hosts overlay content outside the normal child layout.

Source

use base_gpui::tooltip::TooltipPortal;

TooltipPortal::new()
    .keep_mounted(true)
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

Builder	Signature & description
`.new`	`pub fn new() -> Self` Creates a TooltipPortal with its default configuration.
`.child`	`pub fn child(mut self, child: impl Into<TooltipPortalChild<P>>) -> Self` `child`: `impl Into<TooltipPortalChild<P>>` Adds one typed child to this part.
`.child_any`	`pub fn child_any(mut self, child: impl IntoElement) -> Self` `child`: `impl IntoElement` Adds one arbitrary renderable child to this part.
`.keep_mounted`	`pub fn keep_mounted(mut self, keep_mounted: bool) -> Self` `keep_mounted`: `bool` Keeps the part mounted when inactive or closed so child state can be preserved.
`.style_with_state`	`pub fn style_with_state(mut self, style: impl Fn(TooltipPortalStyleState, Div) -> Div + 'static,) -> Self` `style`: `impl Fn(TooltipPortalStyleState, Div) -> Div + 'static,` Styles the part from its current behavioral state while preserving separation between behavior and visual design. TooltipPortal also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#`TooltipPositioner`

Measures the anchor and positions floating content.

Source

use base_gpui::tooltip::TooltipPositioner;

TooltipPositioner::new()
    .side("example-id")
    .align(/* align: TooltipAlign */)
    .side_offset("example-id")
    .align_offset(/* align_offset: Pixels */)
    .collision_padding(/* collision_padding: Pixels */)
    .keep_mounted(true)
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

Builder	Signature & description
`.new`	`pub fn new() -> Self` Creates a TooltipPositioner with its default configuration.
`.child`	`pub fn child(mut self, child: impl Into<TooltipPositionerChild<P>>) -> Self` `child`: `impl Into<TooltipPositionerChild<P>>` Adds one typed child to this part.
`.child_any`	`pub fn child_any(mut self, child: impl IntoElement) -> Self` `child`: `impl IntoElement` Adds one arbitrary renderable child to this part.
`.side`	`pub fn side(mut self, side: TooltipSide) -> Self` `side`: `TooltipSide` Sets the preferred side of the anchor on which floating content appears.
`.align`	`pub fn align(mut self, align: TooltipAlign) -> Self` `align`: `TooltipAlign` Sets floating content alignment along the selected side.
`.side_offset`	`pub fn side_offset(mut self, side_offset: Pixels) -> Self` `side_offset`: `Pixels` Sets the distance between floating content and its anchor.
`.align_offset`	`pub fn align_offset(mut self, align_offset: Pixels) -> Self` `align_offset`: `Pixels` Offsets floating content along its alignment axis.
`.collision_padding`	`pub fn collision_padding(mut self, collision_padding: Pixels) -> Self` `collision_padding`: `Pixels` Sets the minimum space retained between floating content and viewport edges.
`.keep_mounted`	`pub fn keep_mounted(mut self, keep_mounted: bool) -> Self` `keep_mounted`: `bool` Keeps the part mounted when inactive or closed so child state can be preserved.
`.style_with_state`	`pub fn style_with_state(mut self, style: impl Fn(TooltipPositionerStyleState, Div) -> Div + 'static,) -> Self` `style`: `impl Fn(TooltipPositionerStyleState, Div) -> Div + 'static,` Styles the part from its current behavioral state while preserving separation between behavior and visual design. TooltipPositioner also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#`TooltipPopup`

Contains the floating interactive content.

Source

use base_gpui::tooltip::TooltipPopup;

TooltipPopup::new()
    .id("example-id")
    .side("example-id")
    .align(/* align: TooltipAlign */)
    .keep_mounted(true)
    .payload_content(|/* callback arguments */| { /* handle change */ })
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

Builder	Signature & description
`.new`	`pub fn new() -> Self` Creates a TooltipPopup with its default configuration.
`.id`	`pub fn id(mut self, id: impl Into<ElementId>) -> Self` `id`: `impl Into<ElementId>` Sets the stable GPUI element identity. Use a unique value when multiple instances can appear in the same view.
`.child`	`pub fn child(mut self, child: impl Into<TooltipPopupChild<P>>) -> Self` `child`: `impl Into<TooltipPopupChild<P>>` Adds one typed child to this part.
`.child_any`	`pub fn child_any(mut self, child: impl IntoElement) -> Self` `child`: `impl IntoElement` Adds one arbitrary renderable child to this part.
`.side`	`pub fn side(mut self, side: TooltipSide) -> Self` `side`: `TooltipSide` Sets the preferred side of the anchor on which floating content appears.
`.align`	`pub fn align(mut self, align: TooltipAlign) -> Self` `align`: `TooltipAlign` Sets floating content alignment along the selected side.
`.keep_mounted`	`pub fn keep_mounted(mut self, keep_mounted: bool) -> Self` `keep_mounted`: `bool` Keeps the part mounted when inactive or closed so child state can be preserved.
`.payload_content`	`pub fn payload_content(mut self, content: impl Fn(Option<&P>, &mut Window, &mut App) -> gpui::AnyElement + 'static,) -> Self` `content`: `impl Fn(Option<&P>, &mut Window, &mut App) -> gpui::AnyElement + 'static,` Sets the payload content configuration for this part.
`.style_with_state`	`pub fn style_with_state(mut self, style: impl Fn(TooltipPopupStyleState, Div) -> Div + 'static,) -> Self` `style`: `impl Fn(TooltipPopupStyleState, Div) -> Div + 'static,` Styles the part from its current behavioral state while preserving separation between behavior and visual design. TooltipPopup also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#`TooltipProvider`

Public renderable part of the Tooltip Provider component.

Source

use base_gpui::tooltip::TooltipProvider;

TooltipProvider::new()
    .id("example-id")
    .delay(/* delay: Duration */)
    .close_delay(/* close_delay: Duration */)
    .timeout(/* timeout: Duration */)
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

Builder	Signature & description
`.new`	`pub fn new() -> Self` Creates a TooltipProvider with its default configuration.
`.id`	`pub fn id(mut self, id: impl Into<ElementId>) -> Self` `id`: `impl Into<ElementId>` Sets the stable GPUI element identity. Use a unique value when multiple instances can appear in the same view.
`.child`	`pub fn child(mut self, child: impl Into<TooltipProviderChild<P>>) -> Self` `child`: `impl Into<TooltipProviderChild<P>>` Adds one typed child to this part.
`.child_any`	`pub fn child_any(mut self, child: impl IntoElement) -> Self` `child`: `impl IntoElement` Adds one arbitrary renderable child to this part.
`.delay`	`pub fn delay(mut self, delay: Duration) -> Self` `delay`: `Duration` Sets the delay before the related transition or interaction begins.
`.close_delay`	`pub fn close_delay(mut self, close_delay: Duration) -> Self` `close_delay`: `Duration` Sets the delay before an open component closes after the closing interaction.
`.timeout`	`pub fn timeout(mut self, timeout: Duration) -> Self` `timeout`: `Duration` Sets the duration before the component automatically performs its timeout behavior.
`.style_with_state`	`pub fn style_with_state(mut self, style: impl Fn(TooltipProviderStyleState, Div) -> Div + 'static,) -> Self` `style`: `impl Fn(TooltipProviderStyleState, Div) -> Div + 'static,` Styles the part from its current behavioral state while preserving separation between behavior and visual design. TooltipProvider also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#`TooltipProvider`

Public renderable part of the Tooltip Provider component.

Source

use base_gpui::tooltip::TooltipProvider;

TooltipProvider::new()
    .id("example-id")
    .delay(/* delay: Duration */)
    .close_delay(/* close_delay: Duration */)
    .timeout(/* timeout: Duration */)
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

Builder	Signature & description
`.new`	`pub fn new() -> Self` Creates a TooltipProvider with its default configuration.
`.id`	`pub fn id(mut self, id: impl Into<ElementId>) -> Self` `id`: `impl Into<ElementId>` Sets the stable GPUI element identity. Use a unique value when multiple instances can appear in the same view.
`.child`	`pub fn child(mut self, child: impl Into<TooltipProviderChild<P>>) -> Self` `child`: `impl Into<TooltipProviderChild<P>>` Adds one typed child to this part.
`.child_any`	`pub fn child_any(mut self, child: impl IntoElement) -> Self` `child`: `impl IntoElement` Adds one arbitrary renderable child to this part.
`.delay`	`pub fn delay(mut self, delay: Duration) -> Self` `delay`: `Duration` Sets the delay before the related transition or interaction begins.
`.close_delay`	`pub fn close_delay(mut self, close_delay: Duration) -> Self` `close_delay`: `Duration` Sets the delay before an open component closes after the closing interaction.
`.timeout`	`pub fn timeout(mut self, timeout: Duration) -> Self` `timeout`: `Duration` Sets the duration before the component automatically performs its timeout behavior.
`.style_with_state`	`pub fn style_with_state(mut self, style: impl Fn(TooltipProviderStyleState, Div) -> Div + 'static,) -> Self` `style`: `impl Fn(TooltipProviderStyleState, Div) -> Div + 'static,` Styles the part from its current behavioral state while preserving separation between behavior and visual design. TooltipProvider also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#`TooltipViewport`

Defines the viewport used to lay out or constrain overlay content.

Source

use base_gpui::tooltip::TooltipViewport;

TooltipViewport::new()
    .payload_content(|/* callback arguments */| { /* handle change */ })
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

Builder	Signature & description
`.new`	`pub fn new() -> Self` Creates a TooltipViewport with its default configuration.
`.payload_content`	`pub fn payload_content(mut self, content: impl Fn(Option<&P>, &mut Window, &mut App) -> AnyElement + 'static,) -> Self` `content`: `impl Fn(Option<&P>, &mut Window, &mut App) -> AnyElement + 'static,` Sets the payload content configuration for this part.
`.style_with_state`	`pub fn style_with_state(mut self, style: impl Fn(TooltipViewportStyleState, Div) -> Div + 'static,) -> Self` `style`: `impl Fn(TooltipViewportStyleState, Div) -> Div + 'static,` Styles the part from its current behavioral state while preserving separation between behavior and visual design. TooltipViewport also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#Accessibility

Keyboard interaction and accessibility semantics are implemented by the component, independently of visual styling. Known limitations caused by missing GPUI accessibility primitives are documented in the module source and are not silently approximated.

Accessibility: the trigger is exposed as Role::Button (with an optional TooltipTrigger::aria_label) and the open popup as Role::Tooltip; all other layers stay out of the accessibility tree, matching Base UI's ARIA-light tooltip. Known gaps in the pinned gpui revision: - disabled: no .aria_disabled(...) builder exists, so AT cannot see a disabled trigger state. Disabled triggers are removed from tab order and omit the Click a11y action instead; blocked pending an upstream gpui set_disabled addition. - aria-describedby trigger→popup relationship: no relationship builders exist. Base UI does not emit this for Tooltip either; tooltip content is not an accessible description or name for the trigger. - Live-region announcements of tooltip content on open: no announcement API exists, so tooltips remain sighted-user visual hints.

#Stability

Base GPUI is pre-1.0. Builder names and state types may evolve as GPUI and this port mature.

#Anatomy

#TooltipRoot

#Builders

#TooltipTrigger

#Builders

#TooltipPortal

#Builders

#TooltipPositioner

#Builders

#TooltipPopup

#Builders

#TooltipProvider

#Builders

#TooltipProvider

#Builders

#TooltipViewport

#Builders

#Accessibility

#Stability

#`TooltipRoot`

#`TooltipTrigger`

#`TooltipPortal`

#`TooltipPositioner`

#`TooltipPopup`

#`TooltipProvider`

#`TooltipProvider`

#`TooltipViewport`