Element - Checkbox

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

# Rustdoc summary

A box that can be checked.

# Verified type declaration

pub struct Checkbox<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>>
where
    Renderer: Renderer,
    Theme: Catalog,{ /* 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/checkbox/src/main.rs
• ref/examples/custom_shader/src/main.rs
• ref/examples/events/src/main.rs
• ref/examples/ferris/src/main.rs
• ref/examples/game_of_life/src/main.rs
• ref/examples/gradient/src/main.rs

# Inline Examples (from rustdoc)

use iced::widget::checkbox;

struct State {
   is_checked: bool,
}

enum Message {
    CheckboxToggled(bool),
}

fn view(state: &State) -> Element<'_, Message> {
    checkbox(state.is_checked)
        .label("Toggle me!")
        .on_toggle(Message::CheckboxToggled)
        .into()
}

fn update(state: &mut State, message: Message) {
    match message {
        Message::CheckboxToggled(is_checked) => {
            state.is_checked = is_checked;
        }
    }
}

# 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.