ProgressElement

@Serializable
sealed interface ProgressElement : UiElement.Static

UI Element to indicate linear progress of work being done.

Inheritors

Types

Link copied to clipboard
@Serializable
@SerialName(value = "determinate")
data class Determinate(val progress: Float, val caption: String? = null, val sentiment: Sentiment = Sentiment.Nominal) : ProgressElement

UI Element for a progress bar where the progress is known.

Link copied to clipboard
@Serializable
@SerialName(value = "indeterminate")
data class Indeterminate(val caption: String? = null, val sentiment: Sentiment = Sentiment.Nominal) : ProgressElement

UI element for a progress bar that is currently indeterminate.

Properties

Link copied to clipboard
abstract val caption: String?

Optional caption to indicate what work is being done.

Link copied to clipboard
abstract val sentiment: Sentiment

Signifier of the state of the work being done.

Functions

Link copied to clipboard
inline fun <T : UiElement> UiElement.renderWithType(block: T.() -> Unit): RenderResult