Step

data class Step(    val actionControls: @Composable () -> Unit? = null,     val initiallyExpanded: Boolean = false,     val enabled: MutableState<Boolean>? = null,     val stepIcon: ImageVector,     val title: StringResource,     val content: @Composable ColumnScope.() -> Unit,     val isError: MutableState<Boolean>? = null,     val dismissAction: (MutableState<Boolean>) -> Unit? = null,     val dismissIcon: ImageVector = Icons.Default.Cancel,     val confirmAction: (MutableState<Boolean>) -> Unit = { it.value = false },     val confirmIcon: ImageVector = Icons.Default.CheckCircle)

The information related to a single step to represent in the Stepper component

Author

N7ghtm4r3

Since

1.0.7

Constructors

Link copied to clipboard
constructor(    actionControls: @Composable () -> Unit? = null,     initiallyExpanded: Boolean = false,     enabled: MutableState<Boolean>? = null,     stepIcon: ImageVector,     title: StringResource,     content: @Composable ColumnScope.() -> Unit,     isError: MutableState<Boolean>? = null,     dismissAction: (MutableState<Boolean>) -> Unit? = null,     dismissIcon: ImageVector = Icons.Default.Cancel,     confirmAction: (MutableState<Boolean>) -> Unit = { it.value = false },     confirmIcon: ImageVector = Icons.Default.CheckCircle)

Properties

Link copied to clipboard
val actionControls: @Composable () -> Unit? = null

The controls available for the current step, if null will be used the default actions

Link copied to clipboard

The action to execute when the action confirmed

Link copied to clipboard

The representative icon to indicate to confirm the current action

Link copied to clipboard

The content of the step (see the StepContent annotation)

Link copied to clipboard

The action to execute when the action dismissed

Link copied to clipboard

The representative icon to indicate to dismiss the current action

Link copied to clipboard

Whether the step depends on specific scenario to be enabled

Link copied to clipboard

Whether the step is initially expanded

Link copied to clipboard

The state used to indicate whether the step is currently in error

Link copied to clipboard

The representative icon of the step

Link copied to clipboard
val title: StringResource

The title of the step

Functions

Link copied to clipboard
private fun Step.isEnabled(): Boolean

Scoped function used to check whether a Step depends on a special condition to be enabled