Elements

Button

A button is a press target. It owns the behavior: presses, press feedback through the app’s state styles, the disabled and selected states, keyboard focus, and its role for screen readers. The look is the app’s: a Button has no colors, sizes, paddings or label of its own, so one component becomes a primary button, an icon button, a tab, a toolbar toggle or the row of a list, depending on the styles and children you give it.

el-button.tsx
el-button.tsxLive
import { mount, signal, Text, View } from "nsh";
import { Button, Switch } from "nsh/base";
import { desktop, Inspector, Panel, size, Stage, tint, ui, wide } from "./palette";

const track = `${desktop ? "w-9" : "w-12"} rounded-full p-0.5 transition-colors`;
const thumb = desktop ? "size-4 rounded-full transition-transform checked:translate-x-4" : "size-5.5 rounded-full transition-transform checked:translate-x-5";

function App() {
  const presses = signal(0);
  const pressing = signal(false);
  const disabled = signal(false);
  const bold = signal(true);
  const italic = signal(false);
  const last = signal("–");
  // A pointer gets compact buttons as wide as their labels; a phone, 44-point ones.
  const chip = () =>
    desktop
      ? { ...ui().raised, borderRadius: 8, height: size.control, paddingHorizontal: 12, alignItems: "center" as const, justifyContent: "center" as const }
      : { ...ui().raised, borderRadius: 10, paddingHorizontal: 14, paddingVertical: 10, alignItems: "center" as const };
  const label = () => ({ color: ui().text, fontSize: desktop ? 13 : 15, fontWeight: "600" as const });

  const counter = () => (
    <Button
      onPress={() => {
        presses.update((n) => n + 1);
        last.set(`counter ${presses()}`);
      }}
      onPressDown={() => pressing.set(true)}
      onPressUp={() => pressing.set(false)}
      disabled={disabled()}
      style={
        desktop
          ? { ...ui().accentFill, alignSelf: "flex-start", borderRadius: 8, height: size.control, paddingHorizontal: 14, justifyContent: "center" }
          : { ...ui().accentFill, borderRadius: 12, padding: 14, alignItems: "center" }
      }
      activeStyle={{ opacity: 0.7 }}
      hoverStyle={{ borderColor: ui().text }}
      focusStyle={{ borderColor: ui().info, borderWidth: 2 }}
      disabledStyle={{ opacity: 0.35 }}
    >
      <Text style={{ color: ui().onAccent, fontSize: desktop ? 14 : 16, fontWeight: "600" }}>Pressed {presses()}×</Text>
    </Button>
  );
  const pressState = () => `${pressing() ? "onPressDown: pressing…" : "onPressUp: released"} · disabled ${String(disabled())}`;
  const disabler = () => (
    <Switch
      checked={disabled()}
      onChange={(next) => disabled.set(next)}
      class={`flex-row items-center gap-2 active:opacity-70 ${desktop && !wide() ? "self-start" : ""}`}
      trackClass={track}
      trackStyle={disabled() ? ui().accentFill : ui().inset}
      thumbClass={thumb}
      thumbStyle={disabled() ? { backgroundColor: ui().onAccent } : ui().raised}
    >
      <Text style={label()}>{wide() ? (disabled() ? "Enable it" : "Disable it") : disabled() ? "Enable the button above" : "Disable the button above"}</Text>
    </Switch>
  );
  const toggle = (name: string, on: () => boolean, flip: () => void, text: () => object, glyph: string) => (
    <Button
      selected={on()}
      onPress={flip}
      accessibilityLabel={name}
      style={{ ...chip(), width: desktop ? size.control : 48, paddingHorizontal: desktop ? 0 : 14 }}
      selectedStyle={{ backgroundColor: tint(ui().accent, 0.25), backgroundImage: "none", borderColor: ui().accent }}
      activeStyle={{ opacity: 0.7 }}
    >
      <Text style={text()}>{glyph}</Text>
    </Button>
  );
  const toggles = () => (
    <>
      {toggle("Bold", bold, () => bold.set(!bold()), () => ({ ...label(), fontWeight: "800" }), "B")}
      {toggle("Italic", italic, () => italic.set(!italic()), () => ({ ...label(), fontStyle: "italic" }), "I")}
    </>
  );
  const caption = (text: string) => <Text style={{ fontSize: 12, color: ui().muted }}>{text}</Text>;

  return (
    <View style={{ flex: 1, backgroundColor: ui().page, padding: 20, paddingTop: 24, gap: 12 }}>
      <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>button</Text>
      <Text style={{ color: ui().muted }}>{desktop ? "Click, hover, or Tab to a button and press Space" : "Tap; move your finger away to cancel"}</Text>

      {() =>
        wide() ? (
          <View style={{ flex: 1, flexDirection: "row", gap: 16 }}>
            <Stage width={360} gap={24}>
              <View style={{ gap: 8 }}>
                {caption("onPress, onPressDown, onPressUp")}
                <View style={{ flexDirection: "row", alignItems: "center", gap: 12 }}>
                  {counter()}
                  {disabler()}
                </View>
              </View>
              <View style={{ gap: 8 }}>
                {caption("selected: toggles")}
                <View style={{ flexDirection: "row", gap: 8 }}>{toggles()}</View>
              </View>
            </Stage>
            <Inspector>
              <Panel title="press · disabled">
                <Text style={{ fontSize: 13, color: ui().text }}>{pressState()}</Text>
              </Panel>
              <Panel title="selected">
                <Text style={{ fontSize: 13, color: ui().text }}>
                  bold {String(bold())} · italic {String(italic())}
                </Text>
              </Panel>
              <Panel title="last onPress">
                <Text style={{ fontSize: 13, color: ui().up }}>{last()}</Text>
              </Panel>
            </Inspector>
          </View>
        ) : (
          <View style={{ gap: 12 }}>
            {counter()}
            <Text style={{ color: ui().muted, fontSize: 13 }}>{pressState()}</Text>

            {disabler()}

            <Text style={{ color: ui().muted, marginTop: 6 }}>selected: toggles</Text>
            <View style={{ flexDirection: "row", gap: 8 }}>
              {toggles()}
              <Text style={{ color: ui().muted, alignSelf: "center", flex: 1 }}>
                bold {String(bold())} · italic {String(italic())}
              </Text>
            </View>

            <Text style={{ color: ui().up }}>last onPress: {last()}</Text>
          </View>
        )
      }
    </View>
  );
}

mount(App);
use nsh_base::button;
use nsh_core::ui::prelude::*;

fn counter() -> impl IntoElement {
    let count = signal(0_u32);
    button()
        .on_press(move || count.update(|n| *n += 1))
        .self_center()
        .px_5()
        .py_3()
        .rounded_xl()
        .bg(rgb(0x2563eb))
        .active(|s| s.bg(rgb(0x1d4ed8)))
        .child(
            text(move || format!("Pressed {}", count.get()))
                .text_color(white())
                .font_weight(FontWeight::SEMIBOLD),
        )
}

Button comes from nsh/base, the nsh-base crate in Rust. In TSX its look is class and style, with the state variants active:, hover:, focus:, selected: and disabled: (or the matching activeStyle, hoverStyle, focusStyle, selectedStyle and disabledStyle). In Rust, button() makes one as view() makes a view: a setter per prop (.disabled(..), .selected(..)), a listener per event (.on_press(..)), the typed style methods (.px_4(), .bg(..)) for its look, the state methods (.active(..), .hover(..), .focus(..), .selected_style(..), .disabled_style(..)) for its states and .child(..) for its content.

#Props

PropRustTypeDefaultDescription
disabled.disabled(..)booleanfalseNo presses and no press feedback; disabled: styles apply and screen readers say it is dimmed.
selected.selected(..)booleanfalseSelected: a toggle that is on, the current tab. Screen readers say so. The app owns the value and styles it.
selectedStyle.selected_style(|s| ..)StyleProp<ViewStyle>noneThe style while selected and not disabled, as selected: classes.
accessibilityLabel.accessibility_label(..)stringnoneWhat screen readers say when the content is not enough, as for an icon.
role.role(..)AccessibilityRole"button"What it is for screen readers when no nsh/base component is that control: "link" (it opens a URL), …
children.child(..)JSX.ElementnoneThe content: text, an icon, any layout.
class, stylestyle methodsstring, StyleProp<ViewStyle>noneIts look, all of it.
activeStyle, hoverStyle, focusStyle, disabledStyle.active(|s| ..), .hover(..), .focus(..), .disabled_style(..)StyleProp<ViewStyle>noneThe style while pressed, hovered, focused or disabled, as the <state>: classes. Later states win; disabled wins over all.

In Rust each prop is a setter that takes a value, a signal or a closure; the props you leave out keep their defaults:

button()
    .disabled(move || saving.get())
    .accessibility_label("Save")

#Events

EventRustDescription
onPress.on_press(|| ..)The button was pressed: a tap, a click, Return or Space while it has the keyboard focus, or a screen reader’s activation.
onPressDown.on_press_down(|| ..)A press went down on it.
onPressUp.on_press_up(|| ..)The press ended: released, moved away or cancelled.

onPressDown and onPressUp are for press feedback of your own, such as a spring or a highlight that the state styles do not express. A disabled button reports none of them.

#Styling

The look of a button is your app’s: the app decides what a primary or a secondary button is. A pair of small components keeps that decision in one place:

use nsh_base::button;
use nsh_core::ui::prelude::*;

/// A filled button, darker while pressed.
fn primary(label: &'static str, on_press: impl Fn() + 'static) -> impl IntoElement {
    button()
        .on_press(on_press)
        .items_center()
        .rounded_lg()
        .px_4()
        .py_3()
        .bg(rgb(0x2563eb))
        .active(|s| s.bg(rgb(0x1d4ed8)))
        .disabled_style(|s| s.opacity(0.4))
        .child(text(label).text_color(white()).font_weight(FontWeight::SEMIBOLD))
}

/// An outlined button.
fn secondary(label: &'static str, on_press: impl Fn() + 'static) -> impl IntoElement {
    button()
        .on_press(on_press)
        .items_center()
        .rounded_lg()
        .px_4()
        .py_3()
        .border_1()
        .border_color(rgb(0xd4d4d4))
        .hover(|s| s.bg(rgb(0xfafafa)))
        .active(|s| s.bg(rgb(0xf5f5f5)))
        .child(text(label).text_color(rgb(0x171717)))
}

The state variants are applied natively: a press darkens the button on the main thread with no JS or Rust running. In Rust the state methods are the same variants: .active(..), .hover(..), .focus(..), .selected_style(..) and .disabled_style(..) follow the button’s own states. Your theme’s colors work the same way: bg-primary in TSX, theme().primary in Rust (see Theme tokens).

#Disabled

A disabled button takes no presses and gives no feedback, and screen readers announce it as dimmed. Its look while disabled is yours, with disabled: classes or disabledStyle:

fn save(saving: Signal<bool>) -> impl IntoElement {
    button()
        .disabled(saving)
        .on_press(move || saving.set(true))
        .rounded_lg()
        .px_4()
        .py_3()
        .bg(rgb(0x2563eb))
        .disabled_style(|s| s.opacity(0.4))
        .child(text("Save").text_color(white()))
}

#A toggle with selected

selected makes a button a toggle: a toolbar’s bold button, a filter chip, the current tab. The app holds the value, flips it in onPress and styles the selected state; screen readers announce the button as selected.

fn bold(on: Signal<bool>) -> impl IntoElement {
    button()
        .selected(on)
        .accessibility_label("Bold")
        .on_press(move || on.update(|on| *on = !*on))
        .size(px(40.0))
        .items_center()
        .justify_center()
        .rounded_md()
        .selected_style(|s| s.bg(rgb(0xdbeafe)))
        .child(text("B").font_weight(FontWeight::BOLD))
}

A row of tabs is Tabs and an on / off control is Switch, from nsh/base: they own the role, the selected state and the keyboard of their kind, which a Button with role="tab" or role="switch" does not.

#Accessibility

  • A button is one element for screen readers, with the role "button" unless role says otherwise. Its label is its text content; give accessibilityLabel when the content is an icon or says too little.
  • disabled and selected are announced as the platform announces them (VoiceOver, TalkBack, UI Automation, the browser’s accessibility tree).
  • On macOS and the web a button is a stop of the keyboard focus: Tab reaches it, Return and Space press it, and focus: styles show where the focus is.

See Accessibility for labels, roles and announcements in general.

#Platform notes

  • iOS, Android and Mac Catalyst: a press is a tap that ends on the button; moving away cancels it, as with the system’s own buttons.
  • Desktops (macOS, Windows, Linux, GPUI) and the web: a press is a click. On macOS and the web, Return and Space also press the button that has the keyboard focus. hover: styles apply under a mouse or a trackpad’s pointer.
  • Every platform draws what the app styles: press feedback is active: / activeStyle or an animation of your own.