Skip to main content

MaterialCheckbox

Struct MaterialCheckbox 

Source
pub struct MaterialCheckbox<'a> { /* private fields */ }
Expand description

Material Design checkbox component following Material Design 3 specifications

Provides a checkbox with three states: checked, unchecked, and indeterminate. Follows Material Design guidelines for colors, sizing, and interaction states.

§Usage Examples

let mut checked = false;

// Basic checkbox
ui.add(MaterialCheckbox::new(&mut checked, "Accept terms"));

// Checkbox with indeterminate state
let mut partial_checked = false;
ui.add(MaterialCheckbox::new(&mut partial_checked, "Select all")
    .indeterminate(true));

// Disabled checkbox
let mut disabled_checked = false;  
ui.add(MaterialCheckbox::new(&mut disabled_checked, "Disabled option")
    .enabled(false));

§Material Design Spec

  • Size: 18x18dp checkbox with 40x40dp touch target
  • Colors: Primary color when checked, outline when unchecked
  • Animation: 150ms cubic-bezier transition
  • States: Normal, hover, focus, pressed, disabled, error

Implementations§

Source§

impl<'a> MaterialCheckbox<'a>

Source

pub fn new(checked: &'a mut bool, text: impl Into<String>) -> Self

Create a new Material Design checkbox

§Parameters
  • checked: Mutable reference to boolean state
  • text: Label text displayed next to checkbox
§Returns

A new MaterialCheckbox instance with default settings

Source

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

Set the indeterminate state of the checkbox

Indeterminate checkboxes are used when the checkbox represents a collection of items where some, but not all, are selected.

§Parameters
  • indeterminate: True for indeterminate state, false for normal
Source

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

Set whether the checkbox is enabled or disabled

Disabled checkboxes cannot be interacted with and are visually dimmed.

§Parameters
  • enabled: True for interactive, false for disabled
Source

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

Set whether the checkbox should display in error state

Error state checkboxes use error color from the theme to indicate validation failure or invalid selection.

§Parameters
  • is_error: True for error state styling
Source

pub fn check_color(self, color: Color32) -> Self

Set custom check mark color

Overrides the default check mark color from the theme.

§Parameters
  • color: Custom color for the check mark
Source

pub fn fill_color(self, color: Color32) -> Self

Set custom fill color when checked

Overrides the default fill color from the theme.

§Parameters
  • color: Custom fill color when checkbox is checked
Source

pub fn border_width(self, width: f32) -> Self

Set custom border width

§Parameters
  • width: Border width in pixels (default: 2.0)

Trait Implementations§

Source§

impl<'a> Widget for MaterialCheckbox<'a>

Source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for MaterialCheckbox<'a>

§

impl<'a> RefUnwindSafe for MaterialCheckbox<'a>

§

impl<'a> Send for MaterialCheckbox<'a>

§

impl<'a> Sync for MaterialCheckbox<'a>

§

impl<'a> Unpin for MaterialCheckbox<'a>

§

impl<'a> UnsafeUnpin for MaterialCheckbox<'a>

§

impl<'a> !UnwindSafe for MaterialCheckbox<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more