mordant/com.github.ajalt.mordant.widgets.progress/progressBar

progressBar

fun ProgressLayoutScope<*>.progressBar(width: Int? = null, pendingChar: String? = null, separatorChar: String? = null, completeChar: String? = null, pendingStyle: TextStyle? = null, separatorStyle: TextStyle? = null, completeStyle: TextStyle? = null, finishedStyle: TextStyle? = null, indeterminateStyle: TextStyle? = null, pulsePeriod: Duration = 2.seconds, verticalAlign: VerticalAlign = this.verticalAlign, fps: Int = animationFps)

Add a progress bar cell to this layout.

Parameters

width

The width in characters for this widget, or null to expand to fill the remaining space.

pendingChar

(theme string: "progressbar.pending") The character to use to draw the pending portion of the bar in the active state.

separatorChar

(theme string: "progressbar.separator") The character to draw in between the competed and pending bar in the active state.

completeChar

(theme string: "progressbar.complete") The character to use to draw the completed portion of the bar in the active state.

pendingStyle

(theme style: "progressbar.pending") The style to use for the pendingChars

separatorStyle

(theme style: "progressbar.separator") The style to use for the separatorChar

completeStyle

(theme style: "progressbar.complete") The style to use for the completeChar when completed < total

finishedStyle

(theme style: "progressbar.complete") The style to use for the completeChar when total <= completed

indeterminateStyle

e (theme style: "progressbar.separator") The style to use when the state us indeterminate

pulsePeriod

(theme flag: "progressbar.pulse") The time that it takes for one cycle of the pulse animation. 2 seconds by default. Set this to 0 or the theme flag to false to disable the pulse.

fps

The number of times per second to update the displayed bar. Uses the animation fps by default.