Package-level declarations
Types
Link copied to clipboard
class BaseCoroutineAnimator(terminal: Terminal, animation: RefreshableAnimation) : CoroutineAnimator
Link copied to clipboard
interface CoroutineAnimator
Link copied to clipboard
A CoroutineAnimator for a ProgressBarAnimation.
Link copied to clipboard
Link copied to clipboard
A CoroutineAnimator for a single task.
Functions
Link copied to clipboard
inline fun Animation<Unit>.animateInCoroutine(fps: Int = 30, crossinline finished: () -> Boolean = { false }): CoroutineAnimator
Create an animator that runs this animation in a coroutine.
fun ProgressBarDefinition<Unit>.animateInCoroutine(terminal: Terminal, total: Long? = null, completed: Long = 0, start: Boolean = true, visible: Boolean = true, clearWhenFinished: Boolean = false, speedEstimateDuration: Duration = 30.seconds, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic, maker: ProgressBarWidgetMaker = MultiProgressBarWidgetMaker): CoroutineProgressTaskAnimator<Unit>
Create a progress bar animation for a single task that runs synchronously.
fun <T> ProgressBarDefinition<T>.animateInCoroutine(terminal: Terminal, context: T, total: Long? = null, completed: Long = 0, start: Boolean = true, visible: Boolean = true, clearWhenFinished: Boolean = false, speedEstimateDuration: Duration = 30.seconds, timeSource: TimeSource.WithComparableMarks = TimeSource.Monotonic, maker: ProgressBarWidgetMaker = MultiProgressBarWidgetMaker): CoroutineProgressTaskAnimator<T>
Create a progress bar animation that runs in a coroutine.