Checkbox-class: Checkbox widget

In termr: Modern Reactive Terminal Applications with Data Workflows

Checkbox widget

Description

A labelled boolean toggle. See checkbox().

Super class

Widget -> Checkbox

Public fields

focusable

Checkboxes can be focused.

Active bindings

value

TRUE or FALSE (reactive; sends "checkbox.changed").

label

The label (reactive).

Methods

Public methods

• Checkbox$new()

• Checkbox$default_style()

• Checkbox$default_bindings()

• Checkbox$toggle()

• Checkbox$action_toggle()

• Checkbox$on_click()

• Checkbox$render()

• Checkbox$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$pseudo_states()
• 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()

---

Checkbox$new()

Create a checkbox. See checkbox().

Usage

Checkbox$new(
  label = "",
  value = FALSE,
  id = NULL,
  classes = NULL,
  style = NULL,
  disabled = FALSE
)

Arguments

label

Label.

value

Initial state.

id, classes, style, disabled

See Widget.

---

Checkbox$default_style()

The built-in style.

Usage

Checkbox$default_style()

---

Checkbox$default_bindings()

Space and Enter toggle.

Usage

Checkbox$default_bindings()

---

Checkbox$toggle()

Toggle the value (sends "checkbox.changed").

Usage

Checkbox$toggle()

---

Checkbox$action_toggle()

Action used by the bindings.

Usage

Checkbox$action_toggle()

---

Checkbox$on_click()

Clicking toggles.

Usage

Checkbox$on_click(event)

Arguments

event

A MouseEvent.

---

Checkbox$render()

The box and the label.

Usage

Checkbox$render()

---

Checkbox$clone()

The objects of this class are cloneable with this method.

Usage

Checkbox$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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