Struct Tooltip

pub struct Tooltip<Msg: Clone> {
    pub message: String,
    pub anchor_id: WidgetId,
    pub max_width: u32,
    pub bg: Option<Color>,
    pub fg: Option<Color>,
    pub on_dismiss: Option<Msg>,
}

Builder for an xdg-popup-backed hint anchored to a widget.

Fields

message: String

Body text rendered inside the tooltip.

anchor_id: WidgetId

Stable identifier of the widget the popup anchors to. The widget must have been built with .id( anchor_id ) so the runtime can look its rect up in the previous frame’s layout snapshot.

max_width: u32

Maximum width (logical pixels). The tooltip is single-line; long strings are clipped at the surface boundary.

bg: Option<Color>

Optional override for the tooltip background colour.

fg: Option<Color>

Optional override for the body text colour.

on_dismiss: Option<Msg>

Optional message fired when the user taps outside the popup.

Implementations

impl<Msg: Clone + 'static> Tooltip<Msg>

pub fn new(message: impl Into<String>, anchor_id: WidgetId) -> Self

Create a tooltip with the given message anchored to anchor_id.

pub fn max_width(self, w: u32) -> Self

Override the maximum tooltip width. Defaults to 320 logical px.

pub fn background(self, c: Color) -> Self

Override the background colour.

pub fn color(self, c: Color) -> Self

Override the body text colour.

pub fn on_dismiss(self, msg: Msg) -> Self

Set the dismiss message fired on a tap outside the popup.

pub fn overlay(self) -> OverlaySpec<Msg>

Build the OverlaySpec the application returns from App::overlays.