Checkbox

A controlled tri-state check control with a separately styled indicator.

Like every gpui-base primitive, Checkbox supplies behavior and semantic structure without imposing a product visual language. Apply GPUI styles and compose the exported parts to match your design system.

#Example

The single native Cargo entrypoint selects this primitive from the shared showcase implementation. The same showcase is compiled once for the WASM preview above.

cargo run -p gpui-base-examples -- checkbox

#Import

use gpui_kit::base::{Checkbox, CheckboxIndicator};

#Anatomy and API

The example composes Checkbox, CheckboxIndicator. GPUI’s standard styling and event traits provide presentation; these base types provide the interaction structure.

The authoritative module is components/checkbox.rs. Native and browser previews compile this same file.

#State and events

Pass the controlled value to checked; on_change emits CheckboxState, including indeterminate.

Keep controlled state on the parent render type or in a GPUI entity. Update it in callbacks and call cx.notify(); do not recreate persistent entities during every render.

#Complete Rust example

The complete implementation used by the runnable showcase is embedded directly from Rust source:

<<< ../../../crates/base/examples/showcase/components/checkbox.rs{rust}

The command above supplies application initialization, window creation, and shared BaseShowcase state.

#Accessibility

Keep label and control associated and expose checked, unchecked, indeterminate, and disabled states.

#Notes

Use stable element IDs where accepted. Verify focus, hover, active, selected, disabled, reduced-motion, and high-contrast appearances in the consuming design system.