Struct CheckboxArgsBuilder 

pub struct CheckboxArgsBuilder { /* private fields */ }

Builder for CheckboxArgs.

Implementations

impl CheckboxArgsBuilder

pub fn on_toggle(self, value: Arc<dyn Fn(bool) + Send + Sync>) -> Self

Callback invoked when the checkbox is toggled.

pub fn size(self, value: Dp) -> Self

Size of the checkbox (width and height).

Expressed in Dp (density-independent pixels). The checkbox will use the same value for width and height; default is Dp(24.0).

pub fn color(self, value: Color) -> Self

Background color when the checkbox is not checked.

This sets the surface color shown for the unchecked state and is typically a subtle neutral color.

pub fn checked_color(self, value: Color) -> Self

Background color used when the checkbox is checked.

This color is shown behind the checkmark to indicate an active/selected state. Choose a higher-contrast color relative to color.

pub fn checkmark_color(self, value: Color) -> Self

Color used to draw the checkmark icon inside the checkbox.

This is applied on top of the checked_color surface.

pub fn checkmark_stroke_width(self, value: f32) -> Self

Stroke width in physical pixels used to render the checkmark path.

Higher values produce a thicker checkmark. The default value is tuned for the default size.

pub fn checkmark_animation_progress(self, value: f32) -> Self

Initial animation progress of the checkmark (0.0 ..= 1.0).

Used to drive the checkmark animation when toggling. 0.0 means not visible; 1.0 means fully drawn. Values in-between show the intermediate animation state.

pub fn shape(self, value: Shape) -> Self

pub fn hover_color(self, value: Option<Color>) -> Self

Shape used for the outer checkbox surface (rounded rectangle, etc.).

Use this to customize the corner radii or switch to alternate shapes.

pub fn accessibility_label<VALUE: Into<String>>(self, value: VALUE) -> Self

Optional surface color to apply when the pointer hovers over the control.

If None, the control does not apply a hover style by default. Optional accessibility label read by assistive technologies.

The label should be a short, human-readable string describing the purpose of the checkbox (for example “Enable auto-save”).

pub fn accessibility_description<VALUE: Into<String>>( self, value: VALUE, ) -> Self

Optional accessibility description read by assistive technologies.

A longer description or contextual helper text that augments the accessibility_label for users of assistive technology.

pub fn build(self) -> Result<CheckboxArgs, CheckboxArgsBuilderError>

Builds a new CheckboxArgs.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for CheckboxArgsBuilder

fn default() -> Self

Returns the “default value” for a type.