Struct Throbber

pub struct Throbber<'a> { /* private fields */ }

A compact widget to display a throbber.

A throbber may also be called:

• activity indicator
• indeterminate progress bar
• loading icon
• spinner
• guru guru

Examples:

let throbber = throbber_widgets_tui::Throbber::default()
    .throbber_style(ratatui::style::Style::default().fg(ratatui::style::Color::White).bg(ratatui::style::Color::Black))
    .label("NOW LOADING...");
// frame.render_widget(throbber, chunks[0]);
let throbber_state = throbber_widgets_tui::ThrobberState::default();
// frame.render_stateful_widget(throbber, chunks[0], &mut throbber_state);

Implementations

impl<'a> Throbber<'a>

pub fn label<T>(self, label: T) -> Self

where T: Into<Span<'a>>,

pub fn style(self, style: Style) -> Self

pub fn throbber_style(self, style: Style) -> Self

pub fn throbber_set(self, set: Set) -> Self

pub fn use_type(self, use_type: WhichUse) -> Self

pub fn to_symbol_span(&self, state: &ThrobberState) -> Span<'a>

Convert symbol only to Span with state.

pub fn to_line(&self, state: &ThrobberState) -> Line<'a>

Convert symbol and label to Line with state.

Trait Implementations

impl<'a> Clone for Throbber<'a>

fn clone(&self) -> Throbber<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Throbber<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for Throbber<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<Throbber<'a>> for Line<'a>

Convert symbol and label to Line without state(mostly random index).

If you want to specify a state, use Throbber::to_line().

fn from(throbber: Throbber<'a>) -> Line<'a>

Converts to this type from the input type.

impl<'a> From<Throbber<'a>> for Span<'a>

Convert symbol only to Span without state(mostly random index).

If you want to specify a state, use Throbber::to_symbol_span().

fn from(throbber: Throbber<'a>) -> Span<'a>

Converts to this type from the input type.

impl<'a> StatefulWidget for Throbber<'a>

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Render specified index symbols.

type State = ThrobberState

State associated with the stateful widget.

impl<'a> Widget for Throbber<'a>

fn render(self, area: Rect, buf: &mut Buffer)

Render random step symbols.