Struct MaterialButton 

pub struct MaterialButton<'a> { /* private fields */ }

Material Design button widget implementing Material Design 3 button specifications

This widget provides a button that follows Material Design guidelines including:

• Proper color schemes for different variants
• Hover and pressed state animations
• Material Design typography
• Accessibility support
• Icon and text support

Implementations

impl<'a> MaterialButton<'a>

pub fn filled(text: impl Into<WidgetText>) -> Self

Create a filled Material Design button with high emphasis

Filled buttons have the most visual impact and should be used for the primary action in a set of buttons.

Material Design Spec

• Background: Primary color
• Text: On-primary color
• Elevation: 0dp (no shadow)
• Corner radius: 20dp

pub fn outlined(text: impl Into<WidgetText>) -> Self

Create an outlined Material Design button with medium emphasis

Outlined buttons are medium-emphasis buttons. They contain actions that are important but aren’t the primary action in an app.

Material Design Spec

• Background: Transparent
• Text: Primary color
• Outline: 1dp primary color
• Corner radius: 20dp

pub fn text(text: impl Into<WidgetText>) -> Self

Create a text Material Design button with low emphasis

Text buttons are used for the least important actions in a UI. They’re often used for secondary actions.

Material Design Spec

• Background: Transparent
• Text: Primary color
• No outline or elevation
• Corner radius: 20dp

pub fn elevated(text: impl Into<WidgetText>) -> Self

Create an elevated Material Design button with medium emphasis

Elevated buttons are essentially filled buttons with a shadow. Use them to add separation between button and background.

Material Design Spec

• Background: Surface color
• Text: Primary color
• Elevation: 1dp shadow
• Corner radius: 20dp

pub fn filled_tonal(text: impl Into<WidgetText>) -> Self

Create a filled tonal Material Design button with medium emphasis

Filled tonal buttons are used to convey a secondary action that is still important, but not the primary action.

Material Design Spec

• Background: Secondary container color
• Text: On-secondary-container color
• Elevation: 0dp (no shadow)
• Corner radius: 20dp

pub fn new(text: impl Into<WidgetText>) -> Self

pub fn image(image: impl Into<Image<'a>>) -> Self

Creates a button with an image. The size of the image as displayed is defined by the provided size.

pub fn image_and_text( image: impl Into<Image<'a>>, text: impl Into<WidgetText>, ) -> Self

Creates a button with an image to the left of the text. The size of the image as displayed is defined by the provided size.

pub fn opt_image_and_text( image: Option<Image<'a>>, text: Option<WidgetText>, ) -> Self

Creates a button with an image. The size of the image as displayed is defined by the provided size.

Use this when you need both or either an image and text, or when text might be None.

Parameters

• image: Optional icon/image to display
• text: Optional text content

pub fn opt_image_and_text_with_variant( variant: MaterialButtonVariant, image: Option<Image<'a>>, text: Option<WidgetText>, ) -> Self

Create a Material Design button with specific variant and optional image and text

This is the most flexible constructor allowing full control over button content.

Parameters

• variant: The Material Design button variant to use
• image: Optional icon/image to display
• text: Optional text content

pub fn wrap_mode(self, wrap_mode: TextWrapMode) -> Self

Set the wrap mode for the text.

By default, egui::Ui::wrap_mode will be used, which can be overridden with egui::Style::wrap_mode.

Note that any \n in the text will always produce a new line.

pub fn wrap(self) -> Self

Set Self::wrap_mode to TextWrapMode::Wrap.

pub fn truncate(self) -> Self

Set Self::wrap_mode to TextWrapMode::Truncate.

pub fn fill(self, fill: impl Into<Color32>) -> Self

Override background fill color. Note that this will override any on-hover effects. Calling this will also turn on the frame.

pub fn stroke(self, stroke: impl Into<Stroke>) -> Self

Override button stroke. Note that this will override any on-hover effects. Calling this will also turn on the frame.

pub fn small(self) -> Self

Make this a small button, suitable for embedding into text.

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

Turn off the frame

pub fn sense(self, sense: Sense) -> Self

By default, buttons senses clicks. Change this to a drag-button with Sense::drag().

pub fn min_size(self, min_size: Vec2) -> Self

Set the minimum size of the button.

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

Set the rounding of the button.

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

👎Deprecated: Renamed to corner_radius

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

If true, the tint of the image is multiplied by the widget text color.

This makes sense for images that are white, that should have the same color as the text color. This will also make the icon color depend on hover state.

Default: false.

pub fn shortcut_text(self, shortcut_text: impl Into<WidgetText>) -> Self

Show some text on the right side of the button, in weak color.

Designed for menu buttons, for setting a keyboard shortcut text (e.g. Ctrl+S).

The text can be created with egui::Context::format_shortcut.

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

If true, mark this button as “selected”.

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

Enable or disable the button.

pub fn elevation(self, elevation: Shadow) -> Self

Set the elevation shadow for the button.

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

Add a leading icon to the button.

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

Add a trailing icon to the button.

Trait Implementations

impl Widget for MaterialButton<'_>

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response.