ProgressBar-class: ProgressBar widget

In termr: Modern Reactive Terminal Applications with Data Workflows

ProgressBar widget

Description

See progress_bar().

Super class

Widget -> ProgressBar

Public fields

paint_states

Progress changes only repaint.

total

The value that means 100%.

show_percent

Show the percentage?

Active bindings

value

Progress between 0 and total, or NA (reactive).

fraction

Progress as a fraction (NA when indeterminate).

Methods

Public methods

• ProgressBar$new()

• ProgressBar$default_style()

• ProgressBar$on_mount()

• ProgressBar$advance()

• ProgressBar$render_lines()

• ProgressBar$content_width()

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

---

ProgressBar$new()

Create a progress bar. See progress_bar().

Usage

ProgressBar$new(
  value = 0,
  total = 1,
  show_percent = TRUE,
  id = NULL,
  classes = NULL,
  style = NULL
)

Arguments

value

Progress (or NA for indeterminate).

total

Total.

show_percent

Show the percentage?

id, classes, style

See Widget.

---

ProgressBar$default_style()

The built-in style.

Usage

ProgressBar$default_style()

---

ProgressBar$on_mount()

Animate the indeterminate state.

Usage

ProgressBar$on_mount(event)

Arguments

event

A MountEvent.

---

ProgressBar$advance()

Advance the progress.

Usage

ProgressBar$advance(amount = 1)

Arguments

amount

Amount to add.

---

ProgressBar$render_lines()

The bar for a given width.

Usage

ProgressBar$render_lines(width = NA_integer_)

Arguments

width

Content width.

---

ProgressBar$content_width()

Natural width.

Usage

ProgressBar$content_width()

---

ProgressBar$clone()

The objects of this class are cloneable with this method.

Usage

ProgressBar$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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