Struct MaterialCheckbox 

pub struct MaterialCheckbox { /* private fields */ }

Controlled tri-state M3 checkbox. Activation reports the next state: unchecked and indeterminate become checked, checked becomes unchecked.

Implementations

impl MaterialCheckbox

pub fn new(id: impl Into<ElementId>, label: impl Into<SharedString>) -> Self

label is the checkbox’s accessible name.

pub fn state(self, state: CheckboxState) -> Self

pub fn checked(self, checked: bool) -> Self

pub fn error(self, error: bool) -> Self

Paint the error colors, e.g. for a required choice left unchecked.

pub fn disabled(self, disabled: bool) -> Self

pub fn preview_state(self, state: InteractionPreview) -> Self

Render a static specimen in one forced interaction state. See InteractionPreview.

pub fn track_focus(self, focus: &FocusHandle) -> Self

Use a caller-owned focus handle.

pub fn tab_stop(self, tab_stop: bool) -> Self

pub fn on_change( self, f: impl Fn(&CheckboxState, &mut Window, &mut App) + 'static, ) -> Self

Called with the next state when the checkbox is activated.

Trait Implementations

impl IntoElement for MaterialCheckbox

type Element = ViewElement<MaterialCheckbox>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements [Element].

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed [AnyElement].

impl RenderOnce for MaterialCheckbox

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to [Render::render()] method which takes a mutable reference.