Spinner-class: Spinner widget

In termr: Modern Reactive Terminal Applications with Data Workflows

Spinner widget

Description

See spinner().

Super class

Widget -> Spinner

Public fields

paint_states

Animation frames only repaint.

frames

Animation frames.

interval

Seconds per frame.

Active bindings

label

Text after the spinner (reactive).

spinning

Is it animating? (reactive)

Methods

Public methods

• Spinner$new()

• Spinner$default_style()

• Spinner$on_mount()

• Spinner$render()

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

---

Spinner$new()

Create a spinner. See spinner().

Usage

Spinner$new(
  label = "",
  type = "dots",
  interval = 0.1,
  id = NULL,
  classes = NULL,
  style = NULL
)

Arguments

label

Text after the spinner.

type

Animation name.

interval

Seconds per frame.

id, classes, style

See Widget.

---

Spinner$default_style()

The built-in style.

Usage

Spinner$default_style()

---

Spinner$on_mount()

Start the animation timer.

Usage

Spinner$on_mount(event)

Arguments

event

A MountEvent.

---

Spinner$render()

The current frame and the label.

Usage

Spinner$render()

---

Spinner$clone()

The objects of this class are cloneable with this method.

Usage

Spinner$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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