class

Term::Spinner::Multi

Inherits Enumerable / Reference / Object

Used for managing multiple terminal spinners

Constants

DEFAULT_INSET = { top: "┌ ", middle: "├── ", bottom: "└── ", }

Constructors

new(message = nil, style : NamedTuple(top: String, middle: String, bottom: String) = DEFAULT_INSET, **options)

Initialize a multispinner

Example:

spinner = TTY::Spinner::Multi.new
Source

Instance methods

auto_spin

Auto spin the top level spinner & all child spinners that have scheduled jobs

Source
create_spinner(pattern_or_spinner, **options)

Create a spinner instance

Source
done?

Check if all spinners are done

Source
each(*args, **options)
Source
each(*args, **options, &)
Source
empty?(*args, **options)
Source
empty?(*args, **options, &)
Source
error

Stop all spinners with error status

Source
error?

Check if any spinner errored

Source
line_inset(line_no)

Find the number of characters to move into the line before printing the spinner

Source
next_row

Increase a row count

Source
on(key, &callback : Spinner -> )

Listen on event

Source
pause

Pause all spinners

Source
register(pattern_or_spinner, observable = true, job = nil, **options)

Register a new spinner

Source
register(pattern_or_spinner, observable = true, **options, &job : Spinner -> )

ditto

Source
resume

Resume all spinners

Source
rows

The current count of all rendered rows

Source
size(*args, **options)
Source
size(*args, **options, &)
Source
spin

Perform a single spin animation

Source
stop

Stop all spinners

Source
success

Stop all spinners with success status

Source
success?

Check if all spinners succeeded

Source
synchronize
Source
top_spinner

Get the top level spinner if it exists

Source