onboarding/edu.stanford.spezi.module.onboarding.onboarding

Package-level declarations

Types

Area

data class Area(val title: String, val iconId: Int, val description: String)

Represents an area of the onboarding screen.

OnboardingAction

sealed interface OnboardingAction

A sealed class representing the actions that can be performed on the onboarding screen.

OnboardingData

data class OnboardingData(val areas: List<Area> = emptyList(), val title: String = "Title", val subTitle: String = "SubTitle", val continueButtonText: String = "Learn more", val continueButtonAction: () -> Unit = {})

OnboardingRepository

interface OnboardingRepository

Repository for fetching onboarding data.

OnboardingScreenTestIdentifier

enum OnboardingScreenTestIdentifier : Enum<OnboardingScreenTestIdentifier>

OnboardingUiState

data class OnboardingUiState(val areas: List<Area> = emptyList(), val title: String = "Title", val subtitle: String = "Subtitle", val continueButtonText: String = "Continue", val continueAction: () -> Unit = {}, val error: String? = null)

The UI state for the onboarding screen.

OnboardingViewModel

class OnboardingViewModel : ViewModel

Functions

FeatureItem

@Composable

fun FeatureItem(area: Area)

OnboardingScreen

@Composable

fun OnboardingScreen()

The onboarding screen.

@Composable

fun OnboardingScreen(uiState: OnboardingUiState, onAction: (OnboardingAction) -> Unit)