structures/ink.ui.structures.elements/ProgressElement

ProgressElement

sealed interface ProgressElement : UiElement.Static

UI Element to indicate linear progress of work being done.

Inheritors

Types

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.

data class Indeterminate(val caption: String? = null, val sentiment: Sentiment = Sentiment.Nominal) : ProgressElement

UI element for a progress bar that is currently indeterminate.

Properties

abstract val caption: String?

Optional caption to indicate what work is being done.

abstract val sentiment: Sentiment

Signifier of the state of the work being done.