Struct ButtonScope 

pub struct ButtonScope { /* private fields */ }

A Button and its builder.

Implementations

impl ButtonScope

pub fn accessible_name(self, name: impl Into<String>) -> Self

The name assistive technology reads. With no visible label it is the control’s name; with one it replaces the label, and on an icon-only button it is read instead of the icon’s meaning.

impl ButtonScope

pub fn text_align(self, align: TextAlign) -> Self

Where the label sits in the button. A button that never calls this sends nothing and keeps its label centred.

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

The label’s size in sp. A button that never calls this sends nothing and takes the design system’s size for its variant.

pub fn font_weight(self, weight: u16) -> Self

The label’s weight (e.g. 400, 500, 600, 700). Overrides the type role’s weight. A button that never calls this sends nothing.

pub fn type_role(self, role: TypeRole) -> Self

The rung of the type ladder the label is set in: its size, weight and line height. font_size and font_weight win over the role’s values. A button that never calls this sends nothing and keeps the design system’s label style for its variant.

pub fn icon(self, icon: IconRole) -> Self

The meaning of the glyph on it, never a picture.

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

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

pub fn kind(self, kind: ButtonKind) -> Self

What the button is, apart from how loud it is: ButtonKind::ActionKey is one key of a dense grid, drawn in the design system’s own calculator-key shape.

pub fn max_lines(self, lines: u32) -> Self

How many lines the label may take. A label is one line unless this says more, so a Korean label is never broken between syllables by a squeezed parent.

pub fn overflow(self, overflow: TextOverflow) -> Self

What happens to a label longer than its lines.

pub fn color(self, paint: Paint) -> Self

The label’s colour, for the rare button whose meaning is not its variant’s.

pub fn color_if(self, paint: Option<Paint>) -> Self

The same, when there may be no colour of its own.

pub fn on_click(self, handler: impl FnMut() + 'static) -> Self

pub fn focus_handle(self, handle: &FocusHandle) -> Self

Binds handle to this button, so handle.request() puts keyboard focus here.

impl ButtonScope

pub fn modifier(self, modifier: Modifier) -> Self

What sits around it. Compose’s modifier parameter.

impl ButtonScope

pub fn content(self, content: impl FnOnce())

Composes this widget with content as its children.

Trait Implementations

impl Drop for ButtonScope

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.