You're viewing documentation for a pre-release version. View the latest stable version

Protocol

ActivityBar

An ActivityIndicatorType that renders an activity bar on a single line.

protocol ActivityBar : ActivityIndicatorType

Overview

Title [=======              ]

ActivityBars implement the renderActiveBar(tick:width:) method to customize the bar style.

See LoadingBar and ProgressBar implementations.

See ActivityIndicatorType for more information.

Topics

Instance Properties

var title: String
The title to display when rendering this ActivityBar.

Instance Methods

func renderActiveBar(tick: UInt, width: Int) -> ConsoleText
Called each time the ActivityBar should refresh its display.

Relationships

Inherits From

ActivityIndicatorType
Swift.Sendable
Swift.SendableMetatype

Conforming Types

See Also

Activity

class ActivityIndicator
An instance of a ActivityIndicatorType that can be started, failed, and succeeded.
protocol ActivityIndicatorType
ActivityIndicatorTypes are responsible for drawing / rendering the current ActivityIndicatorState to the Console.
enum ActivityIndicatorState
Possible states to draw / render and ActivityIndicatorType.
struct LoadingBar
Loading-style implementation of ActivityBar.
struct ProgressBar
Progress-style implementation of ActivityBar.
struct CustomActivity
An activity indicator with customizable frames and success and failure messages.