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

Package-level declarations

The onboarding package contains the main onboarding screens, guiding users through the initial setup and introduction to the app. The Screen can be used anywhere after providing the OnboardingData via an implementation of the OnboardingRepository interface.

Example implementation:

class EngageOnboardingRepository @Inject constructor(
    private val navigator: Navigator,
) : OnboardingRepository {

    override suspend fun getOnboardingData(): Result<OnboardingData> = Result.success(
        OnboardingData(
            areas = listOf(
                Area(
                    title = "Join the Study",
                    iconId = R.drawable.ic_groups,
                    description = "Connect to your study via an invitation code from the researchers."
                ),
                Area(
                    title = "Complete Health Checks",
                    iconId = R.drawable.ic_assignment,
                    description = "Record and report health data automatically according to a schedule set by the research team."
                ),
                Area(
                    title = "Visualize Data",
                    iconId = R.drawable.ic_vital_signs,
                    description = "Visualize your heart health progress throughout participation in the study."
                )
            ),
            title = "Welcome to ENGAGE-HF",
            subTitle = "Remote study participation made easy.",
            continueButtonText = "Learn more",
            continueButtonAction = { navigator.navigateTo(OnboardingNavigationEvent.SequentialOnboardingScreen) }
        )
    )
}

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)

OnboardingView

@Composable

fun OnboardingView()

The onboarding screen.

@Composable

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