Struct ButtonStyle 

#[non_exhaustive]
pub struct ButtonStyle {
    pub variant: Option<Variant>,
    pub size: Option<Size>,
    pub radius: Option<Pixels>,
    pub background: Option<ComponentColor>,
    pub foreground: Option<ComponentColor>,
    pub hover_bg: Option<ComponentColor>,
    pub hover_foreground: Option<ComponentColor>,
    pub pressed_bg: Option<ComponentColor>,
    pub pressed_foreground: Option<ComponentColor>,
    pub disabled_foreground: Option<ComponentColor>,
    pub style: Option<StyleRefinement>,
}

Button recipes can combine semantic colors with a sparse GPUI root style. Instance sx is refined over this style; instance builders retain precedence.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

variant: Option<Variant>

size: Option<Size>

radius: Option<Pixels>

background: Option<ComponentColor>

foreground: Option<ComponentColor>

hover_bg: Option<ComponentColor>

hover_foreground: Option<ComponentColor>

pressed_bg: Option<ComponentColor>

pressed_foreground: Option<ComponentColor>

disabled_foreground: Option<ComponentColor>

style: Option<StyleRefinement>

Implementations

impl ButtonStyle

pub fn variant(self, variant: Variant) -> Self

The variant this recipe selects.

Ignored on any button whose call site named a variant of its own: the instance is the more specific source. A recipe that must survive .variant(..) should say what it wants outright — ButtonStyle::hover_bg, ButtonStyle::background and their neighbours all apply whatever variant ends up in force — rather than express it by selecting a variant whose derived shades happen to match.

pub fn size(self, size: Size) -> Self

pub fn radius(self, radius: impl Into<Pixels>) -> Self

pub fn background(self, color: impl Into<ComponentColor>) -> Self

pub fn foreground(self, color: impl Into<ComponentColor>) -> Self

pub fn hover_bg(self, color: impl Into<ComponentColor>) -> Self

pub fn hover_foreground(self, color: impl Into<ComponentColor>) -> Self

pub fn pressed_bg(self, color: impl Into<ComponentColor>) -> Self

pub fn pressed_foreground(self, color: impl Into<ComponentColor>) -> Self

pub fn disabled_foreground(self, color: impl Into<ComponentColor>) -> Self

pub fn style(self, style: impl FnOnce(Div) -> Div) -> Self

Capture visual metrics such as height, padding, text size and gap. Prefer keeping flex placement and per-instance widths at the call site.

Trait Implementations

impl Clone for ButtonStyle

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComponentStyle for ButtonStyle

fn refine(&mut self, overlay: &Self)

Replace only the properties supplied by overlay.

impl Debug for ButtonStyle

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

Formats the value using the given formatter.

impl Default for ButtonStyle

fn default() -> Self

Returns the “default value” for a type.