ModalScreen: Modal screen

In termr: Modern Reactive Terminal Applications with Data Workflows

Modal screen

Description

A screen drawn over the current one. See modal().

Super classes

Widget -> Screen -> ModalScreen

Public fields

dim

Dim the screens below?

dismissable

Close with Escape?

on_dismiss

NULL or ⁠function(result, app)⁠ called when the screen is dismissed.

Methods

Public methods

• ModalScreen$new()

• ModalScreen$default_style()

• ModalScreen$default_bindings()

• ModalScreen$dismiss()

• ModalScreen$action_dismiss()

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

---

ModalScreen$new()

Create a modal screen. See modal().

Usage

ModalScreen$new(
  ...,
  dim = TRUE,
  dismissable = TRUE,
  on_dismiss = NULL,
  id = NULL,
  classes = NULL,
  style = NULL
)

Arguments

...

Child widgets.

dim, dismissable

See fields.

on_dismiss

Callback.

id, classes, style

See Widget.

---

ModalScreen$default_style()

The built-in style: content centred.

Usage

ModalScreen$default_style()

---

ModalScreen$default_bindings()

Escape closes the screen (when dismissable).

Usage

ModalScreen$default_bindings()

---

ModalScreen$dismiss()

Close the screen, passing result to the callbacks.

Usage

ModalScreen$dismiss(result = NULL)

Arguments

result

Any value.

---

ModalScreen$action_dismiss()

Action used by the Escape binding.

Usage

ModalScreen$action_dismiss()

---

ModalScreen$clone()

The objects of this class are cloneable with this method.

Usage

ModalScreen$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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