Struct Button 

pub struct Button { /* private fields */ }

A labeled action.

The click handler is only installed when the button is enabled and not loading, so an unavailable action cannot fire through a stray event.

Implementations

impl Button

pub fn new(ident: impl Into<Ident>) -> Self

pub fn label(self, label: impl Into<SharedString>) -> Self

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

What assistive technology and a test call this action.

Overrides the label, which a graphic button does not have.

pub fn accessible_description( self, description: impl Into<SharedString>, ) -> Self

Adds supplementary literal help to the native button node.

pub fn icon_only(self, glyph: Icon, name: impl Into<SharedString>) -> Self

Draws the button as a square carrying only its glyph, and names it.

The name is required rather than optional because a glyph on its own is an action nobody can announce or address.

pub fn join(self, join: ButtonJoin) -> Self

Places the button in a joined run.

pub fn semantic_parent(self, parent: impl Into<SharedString>) -> Self

Names the surface this action belongs to in the semantic tree, so a reader can tell which notification or row an action came from.

pub fn icon(self, glyph: Icon) -> Self

pub fn icon_position(self, position: IconPosition) -> Self

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

pub fn primary(self) -> Self

pub fn secondary(self) -> Self

pub fn ghost(self) -> Self

pub fn danger(self) -> Self

pub fn link(self) -> Self

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

Marks the action as in flight. A loading button is not actionable.

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

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

Puts the button on a caller-owned focus handle.

An overlay that keeps its own tab order needs a handle it can focus directly, and the published node then reports whether the keyboard is on this action.

pub fn on_click(self, handler: impl Fn(&mut Window, &mut App) + 'static) -> Self

pub fn checked_state(self, checked: bool) -> Self

Publishes an explicit two-state answer, for a button that stays in.

A selected button publishes checked only when it is selected, because “this is the current one” has no meaningful false. A toggle does: out is a state, not the absence of one, so it says so.

Trait Implementations

impl Debug for Button

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

Formats the value using the given formatter.

impl Disableable for Button

fn disabled(self, disabled: bool) -> Self

impl IntoElement for Button

type Element = ViewElement<Button>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Button

fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.

impl Selectable for Button

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

impl Sizable for Button

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self