Struct StyledButton 

pub struct StyledButton { /* private fields */ }

A clickable button with per-state (hover / focus / active) styling.

Wraps egui’s button with the SharedStyle box builders (bg, border, corner_radius, padding, …) plus per-state color variants (hover_bg, active_bg, focus_bg, …) that resolve through egui’s active Visuals for anything left unset. An optional leading image and an explicit font round out the label.

Construct via Styled::button and call show to add it to a Ui. Set id when the button is conditionally rendered so its pseudo-state stays stable.

Implementations

impl StyledButton

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

pub fn image(self, img: Image<'static>) -> Self

pub fn font(self, font: FontId) -> Self

Set the font (family + size) used to render the button label. Overrides SharedStyle::font_size when both are set.

pub fn id(self, id: impl Hash + Debug) -> Self

Override the auto-generated widget id. Use this to pin pseudo-state (hover / active / focus) across conditional rendering - without an explicit id, ui.next_auto_id() shifts when a sibling appears or disappears, misattributing one frame of state.

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

impl StyledButton

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

Set the base background fill colour.

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

Background fill while the pointer is hovering. Falls back to bg when unset.

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

Background fill while the widget is pressed/active. Falls back to hover_bg / bg when unset.

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

Background fill while the widget has keyboard focus. Falls back to bg when unset.

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

Set the accent colour — maps to selection.bg_fill in egui (slider trailing fill, text-selection highlight, focus ring).

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

Accent colour while hovering. Falls back to accent when unset.

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

Set the text/foreground colour for the widget’s label.

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

Text/foreground colour while the pointer is hovering. Falls back to text_color when unset.

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

Text/foreground colour while the widget has keyboard focus. Falls back to hover_text_color / text_color when unset.

pub fn font_size(self, size: f32) -> Self

Set the label font size in points. On widgets with a dedicated font builder, an explicit font takes precedence.

pub fn border(self, width: f32, color: Color32) -> Self

Set the base border stroke (width in points, color).

pub fn hover_border(self, width: f32, color: Color32) -> Self

Border stroke while hovering. Falls back to border when unset.

pub fn focus_border(self, width: f32, color: Color32) -> Self

Border stroke while focused. Falls back to border when unset.

pub fn border_top(self, width: f32, color: Color32) -> Self

Set the base top border (width in points, color).

pub fn border_right(self, width: f32, color: Color32) -> Self

Set the base right border (width in points, color).

pub fn border_bottom(self, width: f32, color: Color32) -> Self

Set the base bottom border (width in points, color).

pub fn border_left(self, width: f32, color: Color32) -> Self

Set the base left border (width in points, color).

pub fn border_x(self, width: f32, color: Color32) -> Self

Set the base left and right borders in one call.

pub fn border_y(self, width: f32, color: Color32) -> Self

Set the base top and bottom borders in one call.

pub fn hover_border_top(self, width: f32, color: Color32) -> Self

Top border while hovering. Falls back to border_top.

pub fn hover_border_right(self, width: f32, color: Color32) -> Self

Right border while hovering. Falls back to border_right.

pub fn hover_border_bottom(self, width: f32, color: Color32) -> Self

Bottom border while hovering. Falls back to border_bottom.

pub fn hover_border_left(self, width: f32, color: Color32) -> Self

Left border while hovering. Falls back to border_left.

pub fn hover_border_x(self, width: f32, color: Color32) -> Self

Left and right borders while hovering.

pub fn hover_border_y(self, width: f32, color: Color32) -> Self

Top and bottom borders while hovering.

pub fn focus_border_top(self, width: f32, color: Color32) -> Self

Top border while focused. Falls back to border_top.

pub fn focus_border_right(self, width: f32, color: Color32) -> Self

Right border while focused. Falls back to border_right.

pub fn focus_border_bottom(self, width: f32, color: Color32) -> Self

Bottom border while focused. Falls back to border_bottom.

pub fn focus_border_left(self, width: f32, color: Color32) -> Self

Left border while focused. Falls back to border_left.

pub fn focus_border_x(self, width: f32, color: Color32) -> Self

Left and right borders while focused.

pub fn focus_border_y(self, width: f32, color: Color32) -> Self

Top and bottom borders while focused.

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

Set the corner radius. Accepts an f32 (uniform) or any Into<egui::CornerRadius> for per-corner control.

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

Set inner padding (space between the border and the content). Accepts any Into<egui::Margin>.

pub fn margin_top(self, val: f32) -> Self

Set the top outer margin in points (space outside the border).

pub fn margin_bottom(self, val: f32) -> Self

Set the bottom outer margin in points (space outside the border).

pub fn margin_left(self, val: f32) -> Self

Set the left outer margin in points (space outside the border).

pub fn margin_right(self, val: f32) -> Self

Set the right outer margin in points (space outside the border).

pub fn full_width(self) -> Self

Stretch the widget to fill the available width of its parent.

pub fn full_height(self) -> Self

Stretch the widget to fill the available height of its parent.

pub fn min_width(self, width: f32) -> Self

Set a minimum width in points.

pub fn max_width(self, width: f32) -> Self

Set a maximum width in points.

pub fn min_height(self, height: f32) -> Self

Set a minimum height in points.

pub fn max_height(self, height: f32) -> Self

Set a maximum height in points.

pub fn width_pct(self, pct: f32) -> Self

Set width as a percentage (0–100) of the parent’s available width. Resolves to a definite size at render time, superseding full_width. Composes with min_width/max_width as clamps after resolution.

pub fn height_pct(self, pct: f32) -> Self

Set height as a percentage (0–100) of the parent’s available height. Resolves to a definite size at render time, superseding full_height. Composes with min_height/max_height as clamps after resolution.

pub fn aspect_ratio(self, ratio: f32) -> Self

Derive height from width (width ÷ height, e.g. 16.0/9.0). Requires a definite width (width_pct or full_width); no-op otherwise. Overridden by an explicit height_pct or full_height.

pub fn cursor(self, icon: CursorIcon) -> Self

Set the cursor icon shown while hovering the widget.

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

Show or hide the widget. When false the widget still occupies its layout space but is not painted or interactive.

pub fn background_image(self, image: impl Into<Image<'static>>) -> Self

Set a background texture drawn on top of bg fill, clipped to the same rounded rect. Accepts egui::Image, egui::ImageSource, or an include_image!(...) macro result.

Texture loading is the app’s responsibility — install loaders via egui_extras::install_image_loaders or register textures with ctx.load_texture. egui_styled only paints, never loads.

pub fn background_image_fit(self, fit: BackgroundImageFit) -> Self

Override the fill mode for background_image. Default: BackgroundImageFit::Stretch (maps full texture over the rect).

pub fn background_image_tint(self, tint: Color32) -> Self

Multiply the background image colour by tint (default: WHITE = no tint).

pub fn background_image_fade_in(self, seconds: f32) -> Self

Fade the background image in over seconds the first time its texture finishes loading, instead of snapping in. Default: no fade.

pub fn reveal_with_background_image(self, seconds: f32) -> Self

Reveal the whole area — background image and body content — in together over seconds, the first time the image’s texture finishes loading. The bg backdrop stays opaque, so the area reveals as a unit instead of content showing over a bare backdrop while the art is still decoding.

pub fn shadow(self, offset: Vec2, width: f32, color: Color32) -> Self

Paint an offset stroke rect behind the widget. Multiple calls append; each shadow uses the widget’s corner_radius.

pub fn shadow_filled(self, offset: Vec2, color: Color32) -> Self

Paint a filled (+ optionally stroked) offset rect behind the widget. Use for conventional drop shadows.

pub fn bg_gradient( self, top_left: Color32, top_right: Color32, bottom_left: Color32, bottom_right: Color32, ) -> Self

Four-corner bilinear gradient painted over the solid bg fill. Colors are interpolated across the rect using a cached 2×2 GPU texture, so corner_radius is respected. See also bg_gradient_v / bg_gradient_h for two-stop shortcuts and bg_gradient_stops for N-stop ramps.

pub fn bg_gradient_v(self, top: Color32, bottom: Color32) -> Self

Vertical two-stop gradient (top → bottom). Shorthand for bg_gradient.

pub fn bg_gradient_h(self, left: Color32, right: Color32) -> Self

Horizontal two-stop gradient (left → right). Shorthand for bg_gradient.

pub fn hover_bg_gradient( self, top_left: Color32, top_right: Color32, bottom_left: Color32, bottom_right: Color32, ) -> Self

bg_gradient applied when hovered.

pub fn hover_bg_gradient_v(self, top: Color32, bottom: Color32) -> Self

Vertical two-stop hover_bg_gradient.

pub fn hover_bg_gradient_h(self, left: Color32, right: Color32) -> Self

Horizontal two-stop hover_bg_gradient.

pub fn active_bg_gradient( self, top_left: Color32, top_right: Color32, bottom_left: Color32, bottom_right: Color32, ) -> Self

bg_gradient applied when active (pointer pressed).

pub fn active_bg_gradient_v(self, top: Color32, bottom: Color32) -> Self

Vertical two-stop active_bg_gradient.

pub fn active_bg_gradient_h(self, left: Color32, right: Color32) -> Self

Horizontal two-stop active_bg_gradient.

pub fn focus_bg_gradient( self, top_left: Color32, top_right: Color32, bottom_left: Color32, bottom_right: Color32, ) -> Self

bg_gradient applied when focused.

pub fn focus_bg_gradient_v(self, top: Color32, bottom: Color32) -> Self

Vertical two-stop focus_bg_gradient.

pub fn focus_bg_gradient_h(self, left: Color32, right: Color32) -> Self

Horizontal two-stop focus_bg_gradient.

pub fn bg_gradient_stops( self, stops: impl IntoIterator<Item = (f32, Color32)>, ) -> Self

Vertical N-stop linear gradient over the solid bg fill. stops are (position, color) pairs with position in 0.0..=1.0 (sorted for you). Respects corner_radius. Use bg_gradient_stops_h for horizontal.

pub fn bg_gradient_stops_h( self, stops: impl IntoIterator<Item = (f32, Color32)>, ) -> Self

Horizontal N-stop linear gradient. See bg_gradient_stops.

pub fn hover_bg_gradient_stops( self, stops: impl IntoIterator<Item = (f32, Color32)>, ) -> Self

bg_gradient_stops applied when hovered.

pub fn active_bg_gradient_stops( self, stops: impl IntoIterator<Item = (f32, Color32)>, ) -> Self

bg_gradient_stops applied when active (pointer pressed).

pub fn focus_bg_gradient_stops( self, stops: impl IntoIterator<Item = (f32, Color32)>, ) -> Self

bg_gradient_stops applied when focused.

pub fn inner_glow(self, width: f32, color: Color32) -> Self

Inward glow: width logical pixels deep, fading from color at the edge to transparent toward the center. Drawn as a smooth vertex-colored ring that follows corner_radius.

pub fn inner_glow_sides(self, sides: Sides, width: f32, color: Color32) -> Self

Inner glow drawn only from the given sides. See inner_glow; partial selections draw straight bands (corners are not rounded).

pub fn inner_glow_top(self, width: f32, color: Color32) -> Self

Inner glow from the top edge only.

pub fn inner_glow_bottom(self, width: f32, color: Color32) -> Self

Inner glow from the bottom edge only.

pub fn inner_glow_left(self, width: f32, color: Color32) -> Self

Inner glow from the left edge only.

pub fn inner_glow_right(self, width: f32, color: Color32) -> Self

Inner glow from the right edge only.

pub fn inner_glow_x(self, width: f32, color: Color32) -> Self

Inner glow from the left and right edges.

pub fn inner_glow_y(self, width: f32, color: Color32) -> Self

Inner glow from the top and bottom edges.

pub fn hover_inner_glow(self, width: f32, color: Color32) -> Self

inner_glow applied when hovered.

pub fn active_inner_glow(self, width: f32, color: Color32) -> Self

inner_glow applied when active (pointer pressed).

pub fn focus_inner_glow(self, width: f32, color: Color32) -> Self

inner_glow applied when focused.

pub fn border_gradient(self, width: f32, top: Color32, bottom: Color32) -> Self

Vertically-interpolated border: top color at the top edge, bottom at the bottom, linearly interpolated down. Wins over uniform border and per-side overrides. Corner radius is not rounded (straight mitered edges).

pub fn hover_border_gradient( self, width: f32, top: Color32, bottom: Color32, ) -> Self

border_gradient applied when hovered.

pub fn active_border_gradient( self, width: f32, top: Color32, bottom: Color32, ) -> Self

border_gradient applied when active (pointer pressed).

pub fn focus_border_gradient( self, width: f32, top: Color32, bottom: Color32, ) -> Self

border_gradient applied when focused.

Trait Implementations

impl Apply for StyledButton

fn apply(self, f: impl FnOnce(Self) -> Self) -> Self

Apply a style function to this builder.

impl StyledWidget for StyledButton

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