Family - Mouse Area

This page unifies related iced::widget APIs for the Mouse Area family.

# API surfaces

• Constructor: iced::widget::mouse_area
• Element: iced::widget::MouseArea

# Surface summaries

# Constructor

Creates a new MouseArea .

# Element

Emit messages on mouse events.

# Verified constructor signature

pub fn mouse_area<'a, Message, Theme, Renderer>(
    widget: impl Into<Element<'a, Message, Theme, Renderer>>,
) -> MouseArea<'a, Message, Theme, Renderer>
where
    Renderer: Renderer,

# Verified element declaration

pub struct MouseArea<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> { /* private fields */ }

# Example References

• ref/examples/modal/src/main.rs
• ref/examples/gallery/src/main.rs

# Related

• Families
• Modules
• Constructors
• Elements

# Use this when...

• You want one page that links module, constructor, and element surfaces.
• You are deciding which API surface to start from.
• You need a practical map for this widget domain.

# Minimal example

// Typical flow:
// 1) Start with constructor usage.
// 2) Move to module docs for style/state details.
// 3) Use element docs for type-level control.

# How it works

Family pages connect related docs so you do not miss capabilities that are split across constructor/module/element pages.

# Common patterns

// Build with constructor APIs first,
// then refine behavior/styles through related module and element docs.

# Gotchas / tips

• Family routes normalize naming; module/function/struct names may differ slightly.
• Prefer this page as your entrypoint when learning unfamiliar widgets.
• Follow example references here before inventing integration patterns.