Module - Button

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

# Rustdoc description

Buttons allow your users to perform actions by pressing them.

# When to use

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

# Example References

• ref/examples/pokedex/src/main.rs
• ref/examples/bezier_tool/src/main.rs
• ref/examples/changelog/src/main.rs
• ref/examples/counter/src/main.rs
• ref/examples/download_progress/src/main.rs
• ref/examples/editor/src/main.rs

# Inline Examples (from rustdoc)

use iced::widget::button;

#[derive(Clone)]
enum Message {
    ButtonPressed,
}

fn view(state: &State) -> Element<'_, Message> {
    button("Press me!").on_press(Message::ButtonPressed).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.