Package-level declarations

Types

Link copied to clipboard
sealed interface Action

A sealed interface that represents the actions that can be triggered in the sequential onboarding screen.

Link copied to clipboard

Button event that can be triggered by the user in sequential onboarding screen.

Link copied to clipboard
data class SequentialOnboardingData(val steps: List<Step>, val actionText: String, val onAction: () -> Unit)
Link copied to clipboard

A interface that needs to be implemented and provided by the app to provide a list of steps to be shown in the edu.stanford.spezi.module.onboarding.sequential.SequentialOnboardingScreen. The implementation should be provided by the app using Dagger.

Link copied to clipboard
data class SequentialOnboardingUiState(val steps: List<Step> = emptyList(), val currentPage: Int = 0, val pageCount: Int = steps.size, val actionText: String = "Start")

A data class that represents the current ui state of the sequential onboarding screen.

Link copied to clipboard
data class Step(val title: String, val description: String, val icon: Int = edu.stanford.spezi.core.design.R.drawable.ic_groups)

Represents a step in the onboarding process.

Functions

Link copied to clipboard

The screen that displays the sequential onboarding steps.