Struct ButtonArgs 

pub struct ButtonArgs {

    pub color: Color,
    pub hover_color: Option<Color>,
    pub shape: Shape,
    pub padding: Dp,
    pub width: DimensionValue,
    pub height: DimensionValue,
    pub on_click: Option<Arc<dyn Fn() + Send + Sync>>,
    pub ripple_color: Color,
    pub border_width: Dp,
    pub border_color: Option<Color>,
    pub shadow: Option<ShadowProps>,
    pub accessibility_label: Option<String>,
    pub accessibility_description: Option<String>,
}

Arguments for the button component.

Fields

color: Color

The fill color of the button (RGBA).

hover_color: Option<Color>

The hover color of the button (RGBA). If None, no hover effect is applied.

shape: Shape

The shape of the button.

padding: Dp

The padding of the button.

width: DimensionValue

Optional explicit width behavior for the button.

height: DimensionValue

Optional explicit height behavior for the button.

on_click: Option<Arc<dyn Fn() + Send + Sync>>

The click callback function

ripple_color: Color

The ripple color (RGB) for the button.

border_width: Dp

Width of the border. If > 0, an outline will be drawn.

border_color: Option<Color>

Optional color for the border (RGBA). If None and border_width > 0, color will be used.

shadow: Option<ShadowProps>

Shadow of the button. If None, no shadow is applied.

accessibility_label: Option<String>

Optional label announced by assistive technologies (e.g., screen readers).

accessibility_description: Option<String>

Optional longer description or hint for assistive technologies.

Implementations

impl ButtonArgs

Convenience constructors for standard Material Design 3 button styles

pub fn filled(on_click: Arc<dyn Fn() + Send + Sync>) -> Self

Create a standard “Filled” button (High emphasis). Uses Primary color for container and OnPrimary for content.

pub fn elevated(on_click: Arc<dyn Fn() + Send + Sync>) -> Self

Create an “Elevated” button (Medium emphasis). Uses Surface color (or SurfaceContainerLow if available) with a shadow.

pub fn tonal(on_click: Arc<dyn Fn() + Send + Sync>) -> Self

Create a “Tonal” button (Medium emphasis). Uses SecondaryContainer color for container and OnSecondaryContainer for content.

pub fn outlined(on_click: Arc<dyn Fn() + Send + Sync>) -> Self

Create an “Outlined” button (Medium emphasis). Transparent container with an Outline border.

pub fn text(on_click: Arc<dyn Fn() + Send + Sync>) -> Self

Create a “Text” button (Low emphasis). Transparent container and no border.

impl ButtonArgs

Builder methods for fluent API

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

Sets the fill color for the button.

pub fn with_hover_color(self, hover_color: Color) -> Self

Sets the hover color applied when the pointer is over the button.

pub fn with_padding(self, padding: Dp) -> Self

Updates the padding inside the button.

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

Overrides the button’s shape.

pub fn with_width(self, width: DimensionValue) -> Self

Sets a fixed or flexible width constraint.

pub fn with_height(self, height: DimensionValue) -> Self

Sets a fixed or flexible height constraint.

pub fn with_ripple_color(self, ripple_color: Color) -> Self

Adjusts the ripple color tint.

pub fn with_border(self, width: Dp, color: Option<Color>) -> Self

Configures the border width and optional color.

Trait Implementations

impl Clone for ButtonArgs

fn clone(&self) -> ButtonArgs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ButtonArgs

fn default() -> Self

Returns the “default value” for a type.