Family - Overlay

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

# API surfaces

• Module: iced::widget::overlay

# Surface summaries

# Module

Display interactive elements on top of other widgets.

# Example References

• ref/examples/clock/src/main.rs
• ref/examples/loupe/src/main.rs
• ref/examples/text/src/main.rs
• ref/examples/integration/src/main.rs
• ref/examples/editor/src/main.rs
• ref/examples/pokedex/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.