Button-class: Button widget

In termr: Modern Reactive Terminal Applications with Data Workflows

Button widget

Description

A focusable button. See button().

Super class

Widget -> Button

Public fields

paint_states

Pressing only repaints.

focusable

Buttons can be focused.

variant

Colour variant.

press_duration

Seconds the pressed state stays visible.

Active bindings

label

The button text (reactive).

pressed

Is the button showing its pressed state?

Methods

Public methods

• Button$new()

• Button$default_style()

• Button$default_bindings()

• Button$render()

• Button$press()

• Button$on_click()

• Button$action_press()

• Button$pseudo_states()

• Button$clone()

Inherited methods

• Widget$add_class()
• Widget$ancestors()
• Widget$animate()
• Widget$arrange_children()
• Widget$bind()
• Widget$bind_reactive()
• Widget$bindings()
• Widget$blur()
• Widget$capture_mouse()
• Widget$child_clip()
• Widget$clear()
• Widget$computed_style()
• Widget$content_height()
• Widget$content_width()
• Widget$focus()
• Widget$format()
• Widget$get_state()
• Widget$has_class()
• Widget$invalidate()
• Widget$invalidate_paint()
• Widget$is_displayed()
• Widget$is_enabled()
• Widget$layout_descend()
• Widget$layout_differs()
• Widget$matches()
• Widget$mount()
• Widget$on()
• Widget$paint()
• Widget$post_message()
• Widget$print()
• Widget$query()
• Widget$query_one()
• Widget$refresh()
• Widget$release_mouse()
• Widget$remove()
• Widget$remove_children()
• Widget$remove_class()
• Widget$render_lines()
• Widget$replace()
• Widget$run_action()
• Widget$run_process()
• Widget$run_worker()
• Widget$set()
• Widget$set_interval()
• Widget$set_state()
• Widget$set_timeout()
• Widget$toggle_class()
• Widget$walk()

---

Button$new()

Create a button.

Usage

Button$new(
  label = "Button",
  id = NULL,
  classes = NULL,
  style = NULL,
  disabled = FALSE,
  variant = "default"
)

Arguments

label

Button text, or a function of no arguments that returns it (re-evaluated when the signal()s it reads change).

id, classes, style, disabled

See Widget.

variant

One of "default", "primary", "success", "warning", "error".

---

Button$default_style()

The built-in style.

Usage

Button$default_style()

---

Button$default_bindings()

Enter and space press the button.

Usage

Button$default_bindings()

---

Button$render()

The button text.

Usage

Button$render()

---

Button$press()

Press the button: shows the pressed state briefly and sends a "button.pressed" message. Does nothing when disabled.

Usage

Button$press()

Returns

TRUE if the button was pressed.

---

Button$on_click()

A left click presses the button.

Usage

Button$on_click(event)

Arguments

event

A MouseEvent.

---

Button$action_press()

Action used by the default bindings.

Usage

Button$action_press()

---

Button$pseudo_states()

Active states: focus, disabled and pressed.

Usage

Button$pseudo_states()

---

Button$clone()

The objects of this class are cloneable with this method.

Usage

Button$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

termr documentation built on Oct. 21, 2026, 5:13 p.m.