Struct Button 

pub struct Button<Msg> { /* private fields */ }

A button: the shape is its surface colour, never brackets.

Sends its message on Enter or Space while focused, or on a click released over it, and flashes one tone brighter to confirm. Hovered and focused buttons show the pillar in their very first cell, before the shortcut segment and the icon (▌ ⏎ Save); the cell is reserved at rest, so nothing moves when the pillar appears. Like every widget that is not a list, buttons never slide. A middle click sends a second message when the button has one (on_middle_press). A theme padding of zero columns leaves no room for the pillar and draws none. Style keys (pillar sets the pillar colour): button, button.<variant>, states hover, focus, pressed, disabled; the shortcut segment uses button-key and button-key.<variant>.

Implementations

impl<Msg> Button<Msg>

pub fn new(label: impl Into<String>) -> Self

A button labelled label.

pub fn on_press(self, message: Msg) -> Self

The message sent when the button is pressed.

pub fn on_middle_press(self, message: Msg) -> Self

The message sent when the middle mouse button is pressed and released over the button, such as closing a tab or opening a link in a new one. The middle press flashes the button like any press. It takes effect on a button that can be pressed at all, so give it on_press too; without this option the middle button passes the button by, as the right button does.

pub fn variant(self, variant: impl Into<String>) -> Self

Theme variant, e.g. "primary" or "danger".

pub fn icon(self, key: impl Into<String>) -> Self

Icon key drawn before the label.

pub fn shortcut(self, label: impl Into<String>) -> Self

Key label drawn in a darker segment on the left, e.g. "⏎" or "ctrl s". The segment starts with the button’s pillar cell, so the pillar stays the leftmost mark.

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

Greys the button out; it cannot be focused or pressed.

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

Shows a spinner in the default spinner style instead of the icon and ignores presses.

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

Makes this a choice button, such as one of a few view modes: selected shows it chosen, raised with a steady pillar. Choosing is its own feedback, so a choice button does not flash when pressed.

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

Draws the button a step quieter, for a screen that has gone still, such as a running timer nobody has touched for a while. Only the tone changes: the button still presses, and the pointer over it or the keyboard on it bring its full tone back, so it never hides the fact that it can be used.

Trait Implementations

impl<Msg: Clone + 'static> Widget<Msg> for Button<Msg>

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.