Struct Button 

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

Clickable themed button, built on egui Atoms.

Reads ButtonVisuals from the installed Theme unless you pass .visuals(...). Use Button::bg_color for a one-off idle fill (semantic actions). Chromatic fills should use theme.colors.bg as the text color so glyphs stay readable.

if ui.add(Button::new("Save")).clicked() {
    // …
}

Implementations

impl<'a> Button<'a>

pub fn new(atoms: impl IntoAtoms<'a>) -> Self

Create a button from atoms (text, images, or a mix).

pub fn selectable(selected: bool, atoms: impl IntoAtoms<'a>) -> Self

Show a selectable button.

Equivalent to:

let selected = true;
ui.add(Button::new("toggle me").selected(selected).frame_when_inactive(!selected).frame(true));

See also:

• Ui::selectable_value
• Ui::selectable_label

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.

Note: In contrast to Button::new, this limits the image size to the default font height (using egui::AtomExt::atom_max_height_font_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.

Note: In contrast to Button::new, this limits the image size to the default font height (using egui::AtomExt::atom_max_height_font_size).

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

Create a button with an optional image and optional text.

Note: In contrast to Button::new, this limits the image size to the default font height (using egui::AtomExt::atom_max_height_font_size).

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 small(self) -> Self

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

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

If false, the button will not have a frame when inactive.

Default: true.

Note: When ui.visuals().button_frame is false, this setting has no effect.

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 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<Atom<'a>>) -> 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.

See also Self::right_text.

pub fn right_text(self, right_text: impl Into<Atom<'a>>) -> Self

Show some text on the right side of the button.

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

If true, mark this button as “selected”.

pub fn visuals(self, visuals: ButtonVisuals) -> Self

Set the visuals of the button

pub fn bg_color(self, color: Color32) -> Self

Set the background color of the button

pub fn atom_ui(self, ui: &mut Ui) -> AtomLayoutResponse

Show the button and return a AtomLayoutResponse for painting custom contents.

Trait Implementations

impl Widget for Button<'_>

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

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

fn boxed<'a>(self) -> Box<dyn FnOnce(&mut Ui) -> Response + 'a>

where Self: Sized + 'a,

Box this widget for dynamic dispatch.