Jenga/io.github.joelkanyi.jenga.component.stepindicator

Package-level declarations

JengaStepIndicator: a row of steps (done, current, pending, locked) for a multi-step flow.

Types

class JengaStep(val label: String, val state: JengaStepState)

One step in a JengaStepIndicator: its label and state.

JengaStepIndicatorColors

class JengaStepIndicatorColors(val active: Color, val onActive: Color, val pending: Color, val line: Color, val label: Color, val currentLabel: Color)

Resolved colors for a JengaStepIndicator. Override via JengaStepIndicatorDefaults.colors.

JengaStepIndicatorDefaults

object JengaStepIndicatorDefaults

Defaults and token mappings for JengaStepIndicator.

enum JengaStepState : Enum<JengaStepState>

The state of one step in a JengaStepIndicator.

Functions

JengaStepIndicator

fun JengaStepIndicator(steps: List<JengaStep>, stepContentDescription: (index: Int, step: JengaStep) -> String, modifier: Modifier = Modifier, onStepClick: (index: Int) -> Unit? = null, colors: JengaStepIndicatorColors = JengaStepIndicatorDefaults.colors())

A horizontal row of steps joined by lines, with a label under each step, for multi-step flows such as sign-up, verification or checkout.