Skip to main content Skip to secondary navigation

Onboarding

Main content start

Overview

The onboarding flow provides the user interface for first-time users of the Spezi application, including an option to request for consent. Because the onboarding flow is standardized in many digital health apps, this template helps maximize time on the developing the actual functionality of the app.

Spezi Template Application Welcome Page as a modal, which shows and briefly describes the Spezi Framework, Swift Package Manager, Spezi Modules. Blue button with white text at the bottom, saying "Learn More"
Welcome Page
This screenshot of an iOS modal describes three interesting modules that Spezi has to offer with some brief descriptions, including onboarding, HL7 FHIR, and Contact.
Onboarding steps
Consent modal on iOS screenshot, with fields to enter first name, last name, and signature. Blue button with white text: "I Consent".
Consent option

Features

Spezi Onboarding has three main UI views:

Onboarding View

The primary onboarding view has options to separate information into groups with a title, description, and icon. Below is an example from the Spezi Template Application.

Spezi Template Application Welcome Page as a modal, which shows and briefly describes the Spezi Framework, Swift Package Manager, Spezi Modules. Blue button with white text at the bottom, saying "Learn More"

Sequential Onboarding View

The sequential onboarding view displays a step-by-step guide or list of information for the users, with each additional block popping up after clicking "Next". Below is an example of the sequential onboarding view from the CS 342 2024 project, Intake.

Onboarding Consent View

If an app requires consent, it can be easily incorporated into the onboarding of the app with this view. Spezi allows you to upload a custom consent form to the app, which can be saved by the users as a PDF.

Consent modal on iOS screenshot, with fields to enter first name, last name, and signature. Blue button with white text: "I Consent".

Technical documentation

For developers, directly access the Spezi Onboarding module and the issues page from here.

GitHub                     Ask technical questions on Github

FAQs

Is this feature available for Android?

Yes! We have developed modules for compatibility on Android devices as well. For an overview of all of our Android-compatible features, refer to our GitHub page: Spezi Kt