OptionList-class: OptionList widget

In termr: Modern Reactive Terminal Applications with Data Workflows

OptionList widget

Description

A list of choices. See option_list().

Super classes

Widget -> ListBase -> OptionList

Active bindings

value

Value of the highlighted choice (NULL if none).

choices

The choice values.

Methods

Public methods

• OptionList$new()

• OptionList$set_choices()

• OptionList$item_count()

• OptionList$item_text()

• OptionList$on_highlight()

• OptionList$on_activate()

• OptionList$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$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$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()
• 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()
• ListBase$action_list_activate()
• ListBase$action_list_down()
• ListBase$action_list_first()
• ListBase$action_list_last()
• ListBase$action_list_page_down()
• ListBase$action_list_page_up()
• ListBase$action_list_up()
• ListBase$content_height()
• ListBase$content_width()
• ListBase$default_bindings()
• ListBase$default_style()
• ListBase$highlight()
• ListBase$item_style()
• ListBase$on_click()
• ListBase$on_mouse_down()
• ListBase$on_mouse_scroll()
• ListBase$paint()
• ListBase$scroll_to_end()
• ListBase$scroll_to_item()

---

OptionList$new()

Create an option list. See option_list().

Usage

OptionList$new(
  choices,
  id = NULL,
  classes = NULL,
  style = NULL,
  disabled = FALSE
)

Arguments

choices

Choices.

id, classes, style, disabled

See Widget.

---

OptionList$set_choices()

Replace the choices.

Usage

OptionList$set_choices(choices)

Arguments

choices

Character vector (named: names are shown).

---

OptionList$item_count()

Number of choices.

Usage

OptionList$item_count()

---

OptionList$item_text()

Label of choice i.

Usage

OptionList$item_text(i)

Arguments

i

Index.

---

OptionList$on_highlight()

Sends "option_list.highlighted".

Usage

OptionList$on_highlight(i)

Arguments

i

Index.

---

OptionList$on_activate()

Sends "option_list.selected".

Usage

OptionList$on_activate(i)

Arguments

i

Index.

---

OptionList$clone()

The objects of this class are cloneable with this method.

Usage

OptionList$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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