ComponentsButton

Button

A pressable control with focus, keyboard, and disabled behavior.

Base UI referenceSource
EXAMPLEwasm · webgpu

This demo runs the real GPUI component on WebGPU, which this browser does not expose.

Try Chrome or Edge 113+, or Safari 26+. In Firefox, enable dom.webgpu.enabled.

You can also run it natively: cargo run -p showcase button

The demo failed to start in this browser.

You can run it natively instead: cargo run -p showcase button

Live examples are not supported on most mobile browsers yet — open this page on a desktop or tablet to run the demo.

Recent phones with WebGPU may manage it (downloads ~18 MB):

#Anatomy

Import the component's parts and compose them under its root:

use base_gpui::button::{
    ButtonRoot,
};

ButtonRoot::new();
The anatomy is a structural overview. Parts with mutually exclusive modes may need separate instances; each part's section below documents its configuration.

#ButtonRoot

Coordinates the component's state and supplies context to its child parts.

Source

use base_gpui::button::ButtonRoot;

ButtonRoot::new()
    .id("example-id")
    .disabled(true)
    .focusable_when_disabled(true)
    .aria_label("label")
    .on_click(|/* callback arguments */| { /* handle change */ })
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

BuilderSignature & description
.newpub fn new() -> Self

Creates a ButtonRoot with its default configuration.

.idpub fn id(mut self, id: impl Into<ElementId>) -> Self
  • id: impl Into<ElementId>

Sets the stable GPUI element identity. Use a unique value when multiple instances can appear in the same view.

.disabledpub fn disabled(mut self, disabled: bool) -> Self
  • disabled: bool

When true, prevents user interaction with this part.

.focusable_when_disabledpub fn focusable_when_disabled(mut self, focusable_when_disabled: bool) -> Self
  • focusable_when_disabled: bool

Sets the focusable when disabled configuration for this part.

.aria_labelpub fn aria_label(mut self, label: impl Into<SharedString>) -> Self
  • label: impl Into<SharedString>

Accessible name for the button. Required for icon-only buttons; when set alongside a visible text child, render that child with Text::new_inaccessible(...) to avoid double-announcing.

.on_clickpub fn on_click(mut self, on_click: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static,) -> Self
  • on_click: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static

Registers a callback invoked when click occurs.

.style_with_statepub fn style_with_state(mut self, style: impl Fn(ButtonRootStyleState, Div) -> Div + 'static,) -> Self
  • style: impl Fn(ButtonRootStyleState, Div) -> Div + 'static,

Styles the part from its current behavioral state while preserving separation between behavior and visual design.

ButtonRoot also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#Accessibility

Keyboard interaction and accessibility semantics are implemented by the component, independently of visual styling. Known limitations caused by missing GPUI accessibility primitives are documented in the module source and are not silently approximated.

#Stability

Base GPUI is pre-1.0. Builder names and state types may evolve as GPUI and this port mature.

PreviousAvatarNextCheckbox