Struct MaterialTooltip 

pub struct MaterialTooltip { /* private fields */ }

An M3 tooltip. With MaterialTooltip::trigger it wraps that element and shows on hover and keyboard focus; without one it renders the tooltip container in place (a specimen).

Implementations

impl MaterialTooltip

pub fn plain(id: impl Into<ElementId>, text: impl Into<SharedString>) -> Self

A plain tooltip with text.

pub fn rich( id: impl Into<ElementId>, supporting: impl Into<SharedString>, ) -> Self

A rich tooltip with supporting text.

pub fn subhead(self, subhead: impl Into<SharedString>) -> Self

A rich tooltip’s title-small subhead.

pub fn action(self, action: impl IntoElement) -> Self

An action of a rich tooltip; the tooltip then stays open while the pointer is over it.

pub fn trigger(self, trigger: impl IntoElement) -> Self

The element the tooltip describes.

pub fn placement(self, placement: Placement) -> Self

The preferred side; it flips when the tooltip does not fit.

pub fn align(self, align: Align) -> Self

How the tooltip lines up with its trigger along the placement side: centered (default), or flush with the trigger’s start or end edge.

pub fn show_on_hover(self, show: bool) -> Self

Whether hovering the trigger shows the tooltip (default true).

pub fn show_on_focus(self, show: bool) -> Self

Whether keyboard focus in the trigger shows the tooltip (default true).

pub fn show_delay(self, delay: Duration) -> Self

The hover delay before showing (default: Base’s show delay).

pub fn hide_delay(self, delay: Duration) -> Self

The grace period before hiding once input leaves (default: Base’s grace period).

pub fn force_visible(self, visible: bool) -> Self

Keep the tooltip shown (or hidden) regardless of input, e.g. for a captured demo.

Trait Implementations

impl IntoElement for MaterialTooltip

type Element = ViewElement<MaterialTooltip>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements [Element].

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed [AnyElement].

impl RenderOnce for MaterialTooltip

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to [Render::render()] method which takes a mutable reference.