Struct Button 

pub struct Button<'a, Message, Renderer = Renderer>
where
    Renderer: Renderer,
{ /* private fields */ }

A Material 3 button with Android-style bounded press ripples.

Implementations

impl<'a, Message, Renderer> Button<'a, Message, Renderer>

where Message: Clone + 'a, Renderer: Renderer + 'a,

pub fn new(content: impl Into<Element<'a, Message, Theme, Renderer>>) -> Self

Creates a new Button with the given content.

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

Sets the width of the Button.

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

Sets the height of the Button.

pub fn padding<P: Into<Padding>>(self, padding: P) -> Self

Sets the Padding of the Button.

pub fn on_press(self, on_press: Message) -> Self

Sets the message produced when the Button is pressed.

Examples found in repository

examples/quickstart/app.rs (line 79)

    fn view(self, app: &App) -> material::Element<'_, Message> {
        match self {
            Self::Home => page::surface(
                page::header("Home", "A small Material app"),
                column![
                    material::text::headline_medium(app.count.to_string()),
                    button::button("Increment", button::ButtonVariant::Filled)
                        .on_press(Message::Increment),
                    button::button("Decrement", button::ButtonVariant::Outlined)
                        .on_press(Message::Decrement),
                ]
                .spacing(12),
            )
            .into(),
            Self::Settings => page::surface(
                page::header("Settings", "Pages are enum variants"),
                material::text::body_large("Use the menu button in the rail"),
            )
            .into(),
        }
    }

examples/showcase/pages/structure.rs (line 129)

fn toolbars() -> material::Element<'static, Message> {
    use material::widget::button::{self, FabSize, FabVariant};
    use material::widget::toolbar;

    let docked = toolbar::docked(toolbar::icon_actions([
        ("arrow_back", Message::Decrement),
        ("arrow_forward", Message::Increment),
        ("add", Message::Increment),
        ("tab", Message::Increment),
        ("star", Message::Increment),
        ("search", Message::Increment),
    ]));

    let docked_vibrant = toolbar::docked_vibrant([
        toolbar::vibrant_icon_action("edit", Message::Increment),
        toolbar::selected_vibrant_icon_action("check", Message::Increment),
        toolbar::vibrant_icon_action("delete", Message::Decrement),
        toolbar::vibrant_icon_action("more_vert", Message::MenuPressed),
    ]);

    let floating = toolbar::floating([
        toolbar::selected_icon_action("format_bold", Message::Increment),
        toolbar::icon_action("format_italic", Message::Increment),
        toolbar::icon_action("format_underlined", Message::Increment),
        toolbar::icon_action("format_color_text", Message::Increment),
    ]);

    let floating_vibrant = toolbar::floating_with_fab(
        toolbar::floating_vibrant(toolbar::vibrant_icon_actions([
            ("share", Message::Increment),
            ("add", Message::Increment),
            ("edit", Message::Increment),
        ])),
        button::fab("search", FabVariant::Primary, FabSize::Standard).on_press(Message::Increment),
    );

    let vertical = toolbar::vertical_floating([
        toolbar::icon_action("undo", Message::Decrement),
        toolbar::icon_action("redo", Message::Increment),
        toolbar::selected_icon_action("palette", Message::Increment),
    ]);

    page::component_stack([
        docked.into(),
        docked_vibrant.into(),
        page::row([floating.into(), vertical.into()]).into(),
        floating_vibrant.into(),
    ])
    .into()
}

pub fn on_press_with(self, on_press: impl Fn() -> Message + 'a) -> Self

Sets the message produced when the Button is pressed using a closure.

pub fn on_press_maybe(self, on_press: Option<Message>) -> Self

Sets the message produced when the Button is pressed, if any.

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

Sets whether the button content should be clipped on overflow.

pub fn style(self, style: impl Fn(&Theme, Status) -> Style + 'a) -> Self

Sets the style of the Button.

Trait Implementations

impl<Message, Renderer> Debug for Button<'_, Message, Renderer>

where Renderer: Renderer,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, Message, Renderer> From<Button<'a, Message, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: Clone + 'a, Renderer: Renderer + Renderer + 'a,

fn from(button: Button<'a, Message, Renderer>) -> Self

Converts to this type from the input type.

impl<Message, Renderer> Widget<Message, Theme, Renderer> for Button<'_, Message, Renderer>

where Message: Clone, Renderer: Renderer + Renderer,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout( &mut self, tree: &mut Tree, renderer: &Renderer, limits: &Limits, ) -> Node

Returns the layout::Node of the Widget.

fn operate( &mut self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn update( &mut self, tree: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, )

Processes a runtime Event.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, _style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn mouse_interaction( &self, _tree: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'b>, renderer: &Renderer, viewport: &Rectangle, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.