gpui-component/docs/docs/components/checkbox.md

title	description
Checkbox	A control that allows the user to toggle between checked and not checked.

Checkbox

A checkbox component for binary choices. Supports labels, disabled state, and different sizes.

Import

use gpui_component::checkbox::Checkbox;

Usage

Basic Checkbox

Checkbox::new("my-checkbox")
    .label("Accept terms and conditions")
    .checked(false)
    .on_click(|checked, _, _| {
        println!("Checkbox is now: {}", checked);
    })

Controlled Checkbox

struct MyView {
    is_checked: bool,
}

impl Render for MyView {
    fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
        Checkbox::new("checkbox")
            .label("Option")
            .checked(self.is_checked)
            .on_click(cx.listener(|view, checked, _, cx| {
                view.is_checked = *checked;
                cx.notify();
            }))
    }
}

Different Sizes

Checkbox::new("cb").text_xs().label("Extra Small")
Checkbox::new("cb").text_sm().label("Small")
Checkbox::new("cb").label("Medium") // default
Checkbox::new("cb").text_lg().label("Large")

Disabled State

Checkbox::new("checkbox")
    .label("Disabled checkbox")
    .disabled(true)
    .checked(false)

Without Label

Checkbox::new("checkbox")
    .checked(true)

Custom Tab Order

Checkbox::new("checkbox")
    .label("Custom tab order")
    .tab_index(2)
    .tab_stop(true)

API Reference

Checkbox

Method	Description
new(id)	Create a new checkbox with the given ID
label(text)	Set label text
checked(bool)	Set checked state
disabled(bool)	Set disabled state
on_click(fn)	Callback when clicked, receives &bool (new checked state)
tab_stop(bool)	Enable/disable tab navigation (default: true)
tab_index(isize)	Set tab order index (default: 0)

Styling

Implements Sizable and Disableable traits:

• text_xs() - Extra small text
• text_sm() - Small text
• text_base() - Base text (default)
• text_lg() - Large text
• disabled(bool) - Disabled state

Examples

Checkbox List

v_flex()
    .gap_2()
    .child(Checkbox::new("cb1").label("Option 1").checked(true))
    .child(Checkbox::new("cb2").label("Option 2").checked(false))
    .child(Checkbox::new("cb3").label("Option 3").checked(false))

Form Integration

struct FormView {
    agree_terms: bool,
    subscribe: bool,
}

v_flex()
    .gap_3()
    .child(
        Checkbox::new("terms")
            .label("I agree to the terms and conditions")
            .checked(self.agree_terms)
            .on_click(cx.listener(|view, checked, _, cx| {
                view.agree_terms = *checked;
                cx.notify();
            }))
    )
    .child(
        Checkbox::new("subscribe")
            .label("Subscribe to newsletter")
            .checked(self.subscribe)
            .on_click(cx.listener(|view, checked, _, cx| {
                view.subscribe = *checked;
                cx.notify();
            }))
    )

Accessibility

• Keyboard navigation with Tab
• Toggle with Space
• Clear focus indicators
• Disabled checkboxes cannot be focused
• Label text announced by screen readers