Rule-class: Rule widget

In termr: Modern Reactive Terminal Applications with Data Workflows

Rule widget

Description

See rule().

Super class

Widget -> Rule

Public fields

orientation

"horizontal" or "vertical".

title

Optional title in the middle of a horizontal rule.

Methods

Public methods

• Rule$new()

• Rule$default_style()

• Rule$paint()

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

---

Rule$new()

Create a rule. See rule().

Usage

Rule$new(
  orientation = "horizontal",
  title = NULL,
  id = NULL,
  classes = NULL,
  style = NULL
)

Arguments

orientation

Orientation.

title

Title.

id, classes, style

See Widget.

---

Rule$default_style()

The built-in style.

Usage

Rule$default_style()

---

Rule$paint()

Paint the line.

Usage

Rule$paint(buffer, area, st)

Arguments

buffer

A ScreenBuffer.

area

Visible part of the region.

st

Computed style.

---

Rule$clone()

The objects of this class are cloneable with this method.

Usage

Rule$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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