Struct Button 

pub struct Button { /* private fields */ }

Simply a button.

Normal

fn app() -> impl IntoElement {
    Button::new()
        .on_press(|_| println!("Pressed!"))
        .child("Press me")
}

Filled

fn app() -> impl IntoElement {
    Button::new()
        .on_press(|_| println!("Pressed!"))
        .filled()
        .child("Press me")
}

Outline

fn app() -> impl IntoElement {
    Button::new()
        .on_press(|_| println!("Pressed!"))
        .outline()
        .child("Press me")
}

Flat

fn app() -> impl IntoElement {
    Button::new()
        .on_press(|_| println!("Pressed!"))
        .flat()
        .child("Press me")
}

Preview

Implementations

impl Button

pub fn new() -> Self

pub fn get_layout_variant(&self) -> &ButtonLayoutVariant

pub fn get_theme_layout(&self) -> Option<&ButtonLayoutThemePartial>

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

pub fn focusable(self, focusable: impl Into<bool>) -> Self

pub fn style_variant(self, style_variant: impl Into<ButtonStyleVariant>) -> Self

pub fn layout_variant( self, layout_variant: impl Into<ButtonLayoutVariant>, ) -> Self

pub fn on_press( self, on_press: impl Into<EventHandler<Event<PressEventData>>>, ) -> Self

pub fn on_secondary_down( self, on_secondary_down: impl Into<EventHandler<Event<PressEventData>>>, ) -> Self

pub fn on_pointer_down( self, on_pointer_down: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self

pub fn theme_colors(self, theme: ButtonColorsThemePartial) -> Self

pub fn theme_layout(self, theme: ButtonLayoutThemePartial) -> Self

pub fn compact(self) -> Self

Shortcut for Self::theme_layout and ButtonLayoutVariant::Compact.

pub fn expanded(self) -> Self

Shortcut for Self::theme_layout and ButtonLayoutVariant::Expanded.

pub fn filled(self) -> Self

Shortcut for Self::style_variant and ButtonStyleVariant::Filled.

pub fn outline(self) -> Self

Shortcut for Self::style_variant and ButtonStyleVariant::Outline.

pub fn flat(self) -> Self

Shortcut for Self::style_variant and ButtonStyleVariant::Flat.

pub fn cursor_icon(self, cursor_icon: impl Into<CursorIcon>) -> Self

Override the cursor icon shown when hovering over the button while enabled.

Trait Implementations

impl ButtonColorsThemePartialExt for Button

fn background(self, background: impl Into<Color>) -> Self

fn hover_background(self, hover_background: impl Into<Color>) -> Self

fn border_fill(self, border_fill: impl Into<Color>) -> Self

fn focus_border_fill(self, focus_border_fill: impl Into<Color>) -> Self

fn color(self, color: impl Into<Color>) -> Self

impl ButtonLayoutThemePartialExt for Button

fn margin(self, margin: impl Into<Gaps>) -> Self

fn corner_radius(self, corner_radius: impl Into<CornerRadius>) -> Self

fn width(self, width: impl Into<Size>) -> Self

fn height(self, height: impl Into<Size>) -> Self

fn padding(self, padding: impl Into<Gaps>) -> Self

impl ChildrenExt for Button

fn get_children(&mut self) -> &mut Vec<Element>

Returns a mutable reference to the internal children vector.

fn children(self, children: impl IntoIterator<Item = Element>) -> Self

Extends the children with an iterable of Elements.

fn maybe_child<C>(self, child: Option<C>) -> Self

where C: IntoElement,

Appends a child only when the Option is Some.

fn child<C>(self, child: C) -> Self

where C: IntoElement,

Appends a single child element.

impl Clone for Button

fn clone(&self) -> Button

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Button

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl CornerRadiusExt for Button

fn with_corner_radius(self, corner_radius: f32) -> Self

Round all four corners to the given radius in pixels.

fn rounded_none(self) -> Self

Shortcut for corner_radius(0.) - removes border radius.

fn rounded(self) -> Self

Shortcut for corner_radius(6.) - default border radius.

fn rounded_sm(self) -> Self

Shortcut for corner_radius(4.) - small border radius.

fn rounded_md(self) -> Self

Shortcut for corner_radius(6.) - medium border radius.

fn rounded_lg(self) -> Self

Shortcut for corner_radius(8.) - large border radius.

fn rounded_xl(self) -> Self

Shortcut for corner_radius(12.) - extra large border radius.

fn rounded_2xl(self) -> Self

Shortcut for corner_radius(16.) - extra large border radius.

fn rounded_3xl(self) -> Self

Shortcut for corner_radius(24.) - extra large border radius.

fn rounded_4xl(self) -> Self

Shortcut for corner_radius(32.) - extra large border radius.

fn rounded_full(self) -> Self

Shortcut for corner_radius(99.) - fully rounded (pill shape).

impl Default for Button

fn default() -> Self

Returns the “default value” for a type.

impl KeyExt for Button

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

where Self: 'static,

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists. The key is scoped to the element’s type, so the same value used on different element or component types never collides.

impl PartialEq for Button

fn eq(&self, other: &Button) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Button