Element - Tooltip

Authoritative source: ref/doc/iced/widget/struct.Tooltip.html.

# Rustdoc summary

An element to display a widget over another.

# Verified type declaration

pub struct Tooltip<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>>
where
    Theme: Catalog,
    Renderer: Renderer,{ /* private fields */ }

# When to use

Use this element struct when you need direct type-level control over a widget value.

# Why to use

It enables strongly typed composition and explicit builder method flows.

# Example References

• ref/examples/tooltip/src/main.rs
• ref/examples/editor/src/main.rs
• ref/examples/table/src/main.rs

# Inline Examples (from rustdoc)

use iced::widget::{container, tooltip};

enum Message {
    // ...
}

fn view(_state: &State) -> Element<'_, Message> {
    tooltip(
        "Hover me to display the tooltip!",
        container("This is the tooltip contents!")
            .padding(10)
            .style(container::rounded_box),
        tooltip::Position::Bottom,
    ).into()
}

# Related

• Elements
• Constructors

# Use this when...

• You need the concrete widget struct type in signatures.
• You are debugging type errors involving generic bounds.
• You want lower-level control than constructor-only docs provide.

# Minimal example

// Constructors usually produce this element type.
// Name the type explicitly only when type-level APIs need it.

# How it works

Element structs are the underlying widget types used by constructors. Most app code can stay constructor-first, then use element docs for advanced typing/customization.

# Common patterns

// Use constructors in normal UI code,
// and reserve explicit element types for reusable abstractions.

# Gotchas / tips

• You usually do not need to construct element structs directly.
• Read trait bounds carefully when adding custom renderer/theme types.
• If a method is missing, check the related module page.