mordant/com.github.ajalt.mordant.animation

Package-level declarations

Types

abstract class Animation<T>(trailingLinebreak: Boolean = true, val terminal: Terminal)

An Animation renders a widget to the screen each time update is called, clearing the render from the previous call.

A version of Animation that has a parameterless refresh method instead of update.

The time between refreshes. This is 1 / refreshRate

inline fun <T> Terminal.animation(trailingLinebreak: Boolean = true, crossinline draw: (T) -> Widget): Animation<T>

Create an Animation that uses the draw function to render objects of type T.

inline fun Animation<Unit>.asRefreshable(fps: Int = 5, crossinline finished: () -> Boolean = { false }): RefreshableAnimation

inline fun <T> Terminal.textAnimation(whitespace: Whitespace = Whitespace.PRE, align: TextAlign = TextAlign.NONE, overflowWrap: OverflowWrap = OverflowWrap.NORMAL, width: Int? = null, tabWidth: Int? = null, trailingLinebreak: Boolean = true, crossinline draw: (T) -> String): Animation<T>

Create an Animation that wraps the result of the draw function into a Text widget and renders it.