Module - Pane Grid

Authoritative source: ref/doc/iced/widget/pane_grid/index.html.

# Rustdoc description

Pane grids let your users split regions of your application and organize layout dynamically.

# When to use

Use this module when you need the widget family and related style/state APIs grouped under iced::widget::pane_grid.

# Example References

• ref/examples/pane_grid/src/main.rs

# Inline Examples (from rustdoc)

use iced::widget::{pane_grid, text};

struct State {
    panes: pane_grid::State<Pane>,
}

enum Pane {
    SomePane,
    AnotherKindOfPane,
}

enum Message {
    PaneDragged(pane_grid::DragEvent),
    PaneResized(pane_grid::ResizeEvent),
}

fn view(state: &State) -> Element<'_, Message> {
    pane_grid(&state.panes, |pane, state, is_maximized| {
        pane_grid::Content::new(match state {
            Pane::SomePane => text("This is some pane"),
            Pane::AnotherKindOfPane => text("This is another kind of pane"),
        })
    })
    .on_drag(Message::PaneDragged)
    .on_resize(10, Message::PaneResized)
    .into()
}

# Related

• Modules
• Constructors

# Use this when...

• You need module-level APIs beyond the basic constructor call.
• You want family-specific style/state traits and helper types.
• You are building reusable widget abstractions.

# Minimal example

// Start with the constructor from this module family in `view`.
// Then move to module APIs for deeper customization.

# How it works

Module docs explain the namespace that groups constructors, types, and related traits. In everyday app code, this helps you discover advanced options after basic usage works.

# Common patterns

// Message flow pattern:
// widget interaction -> Message -> update -> state change -> rerender

# Gotchas / tips

• Check this page together with its family page for complete context.
• Verify trait bounds and associated types in rustdoc when custom styling fails.
• Keep module imports explicit while learning.