Struct ButtonProps

pub struct ButtonProps {
    pub class: MaybeProp<String>,
    pub appearance: Signal<ButtonAppearance>,
    pub shape: Signal<ButtonShape>,
    pub size: Option<Signal<ButtonSize>>,
    pub button_type: MaybeProp<ButtonType>,
    pub block: Signal<bool>,
    pub icon: MaybeProp<Icon>,
    pub disabled: Signal<bool>,
    pub disabled_focusable: Signal<bool>,
    pub loading: Signal<bool>,
    pub on_click: Option<BoxOneCallback<MouseEvent>>,
    pub children: Option<Children>,
}

Props for the Button component.

A button triggers an action or event when activated.

Optional Props

• class: impl Into<MaybeProp<String>>
• appearance: impl Into<Signal<ButtonAppearance>>
  • A button can have its content and borders styled for greater emphasis or to be subtle.
• shape: impl Into<Signal<ButtonShape>>
  • A button can be rounded, circular, or square.
• size: impl Into<Signal<ButtonSize>>
  • A button supports different sizes.
• button_type: impl Into<MaybeProp<ButtonType>>
  • The default behavior of the button.
• block: impl Into<Signal<bool>>
  • Whether the button is displayed as block.
• icon: impl Into<MaybeProp<icondata_core::Icon>>
  • The icon of the button.
• disabled: impl Into<Signal<bool>>
  • Whether the button is disabled.
• disabled_focusable: impl Into<Signal<bool>>
  • When set, allows the button to be focusable even when it has been disabled.
• loading: impl Into<Signal<bool>>
  • Whether the button shows the loading status.
• on_click: impl Into<BoxOneCallback<ev::MouseEvent>>
• children: Children

Fields

class: MaybeProp<String>

appearance: Signal<ButtonAppearance>

A button can have its content and borders styled for greater emphasis or to be subtle.

shape: Signal<ButtonShape>

A button can be rounded, circular, or square.

size: Option<Signal<ButtonSize>>

A button supports different sizes.

button_type: MaybeProp<ButtonType>

The default behavior of the button.

block: Signal<bool>

Whether the button is displayed as block.

icon: MaybeProp<Icon>

The icon of the button.

disabled: Signal<bool>

Whether the button is disabled.

disabled_focusable: Signal<bool>

When set, allows the button to be focusable even when it has been disabled.

loading: Signal<bool>

Whether the button shows the loading status.

on_click: Option<BoxOneCallback<MouseEvent>>

children: Option<Children>

Implementations

impl ButtonProps

pub fn builder() -> ButtonPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building ButtonProps. On the builder, call .class(...)(optional), .appearance(...)(optional), .shape(...)(optional), .size(...)(optional), .button_type(...)(optional), .block(...)(optional), .icon(...)(optional), .disabled(...)(optional), .disabled_focusable(...)(optional), .loading(...)(optional), .on_click(...)(optional), .children(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ButtonProps.

Trait Implementations

impl Props for ButtonProps

type Builder = ButtonPropsBuilder

fn builder() -> Self::Builder