Spinner class

A spinner animation for indicating indeterminate loading states.

The spinner is displayed at the current cursor position and animates through a sequence of characters to indicate that work is in progress.

Example usage:

final spinner = Spinner(message: 'Loading...');
spinner.start();
// ... do some work ...
spinner.stop();

Constructors

Spinner({String message = '', List<String> spinnerCharacters = const <String>['|', '/', '-', '\\'], int intervalMs = 100, Coordinate? startCoordinate})

Creates a new spinner.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

intervalMs → int

The interval between spinner updates in milliseconds.

final

isRunning → bool

Whether the spinner is currently running.

no setter

message → String

The message to display next to the spinner.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

spinnerCharacters → List<String>

The characters to use for the spinner animation.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

start() → void

Starts the spinner animation.

stop({String? finalMessage}) → void

Stops the spinner animation.

toString() → String

A string representation of this object.

inherited

updateMessage(String newMessage) → void

Updates the message displayed next to the spinner.

Operators

operator ==(Object other) → bool

The equality operator.

inherited