{"id":15288659,"url":"https://github.com/stanfordspezi/spezionboarding","last_synced_at":"2025-12-11T22:53:05.400Z","repository":{"id":151310460,"uuid":"624068540","full_name":"StanfordSpezi/SpeziOnboarding","owner":"StanfordSpezi","description":"Spezi Onboarding module to inform a user or retrieve consent for a study participation","archived":false,"fork":false,"pushed_at":"2025-04-09T18:07:42.000Z","size":1473,"stargazers_count":14,"open_issues_count":13,"forks_count":7,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-10T07:05:26.878Z","etag":null,"topics":["consent","ios","onboarding","spezi","stanford","swift","swiftui","welcome","xcode"],"latest_commit_sha":null,"homepage":"https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding/documentation/","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StanfordSpezi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["spezi.sites.stanford.edu"]}},"created_at":"2023-04-05T17:18:31.000Z","updated_at":"2025-04-08T13:57:54.000Z","dependencies_parsed_at":"2023-06-28T15:00:50.312Z","dependency_job_id":"b84e7ea9-399e-4ab6-af60-a05d25962b97","html_url":"https://github.com/StanfordSpezi/SpeziOnboarding","commit_stats":null,"previous_names":["StanfordBDHG/CardinalKitOnboarding","stanfordbdhg/cardinalkitonboarding"],"tags_count":25,"template":false,"template_full_name":"StanfordBDHG/SwiftPackageTemplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StanfordSpezi%2FSpeziOnboarding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StanfordSpezi%2FSpeziOnboarding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StanfordSpezi%2FSpeziOnboarding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StanfordSpezi%2FSpeziOnboarding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StanfordSpezi","download_url":"https://codeload.github.com/StanfordSpezi/SpeziOnboarding/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248674659,"owners_count":21143760,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["consent","ios","onboarding","spezi","stanford","swift","swiftui","welcome","xcode"],"created_at":"2024-09-30T15:51:51.581Z","updated_at":"2025-12-11T22:53:05.393Z","avatar_url":"https://github.com/StanfordSpezi.png","language":"Swift","funding_links":["spezi.sites.stanford.edu"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\nThis source file is part of the Stanford Spezi open-source project.\n\nSPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)\n\nSPDX-License-Identifier: MIT\n  \n--\u003e\n\n# Spezi Onboarding\n\n[![Build and Test](https://github.com/StanfordSpezi/SpeziOnboarding/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/StanfordSpezi/SpeziOnboarding/actions/workflows/build-and-test.yml)\n[![codecov](https://codecov.io/gh/StanfordSpezi/SpeziOnboarding/branch/main/graph/badge.svg?token=lsRIXi5IXY)](https://codecov.io/gh/StanfordSpezi/SpeziOnboarding)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7806970.svg)](https://doi.org/10.5281/zenodo.7806970)\n[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordSpezi%2FSpeziOnboarding%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding)\n[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordSpezi%2FSpeziOnboarding%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding)\n\nProvides UI components for Onboarding.\n\n\n## Overview\n\nThe [`SpeziOnboarding`](https://swiftpackageindex.com/stanfordspezi/spezionboarding/documentation/spezionboarding) module provides user interface components to onboard a user to an iOS application.\n\n\u003ctable style=\"width: 80%\"\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\" width=\"33.33333%\"\u003e\n      \u003cimg src=\"Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/OnboardingView.png#gh-light-mode-only\" alt=\"Screenshot displaying the onboarding view\" width=\"80%\"/\u003e\n      \u003cimg src=\"Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/OnboardingView~dark.png#gh-dark-mode-only\" alt=\"Screenshot displaying the onboarding view\" width=\"80%\"/\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" width=\"33.33333%\"\u003e\n      \u003cimg src=\"Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/SequentialOnboarding.png#gh-light-mode-only\" alt=\"Screenshot displaying the sequential onboarding view\" width=\"80%\"/\u003e\n      \u003cimg src=\"Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/SequentialOnboarding~dark.png#gh-dark-mode-only\" alt=\"Screenshot displaying the sequential onboarding view\" width=\"80%\"/\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" width=\"33.33333%\"\u003e\n      \u003cimg src=\"Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/Consent.png#gh-light-mode-only\" alt=\"Screenshot displaying the onboarding view\" width=\"80%\"/\u003e\n      \u003cimg src=\"Sources/SpeziOnboarding/SpeziOnboarding.docc/Resources/Consent~dark.png#gh-dark-mode-only\" alt=\"Screenshot displaying the onboarding view\" width=\"80%\"/\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"https://swiftpackageindex.com/stanfordspezi/spezionboarding/documentation/spezionboarding/onboardingview\"\u003e\n        \u003ccode\u003eOnboardingView\u003c/code\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"https://swiftpackageindex.com/stanfordspezi/spezionboarding/documentation/spezionboarding/sequentialonboardingview\"\u003e\n        \u003ccode\u003eSequentialOnboardingView\u003c/code\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"https://swiftpackageindex.com/stanfordspezi/speziconsent/documentation/speziconsent/onboardingconsentview\"\u003e\n        \u003ccode\u003eOnboardingConsentView\u003c/code\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\n## Setup\n\n### Add Spezi Onboarding as a Dependency\n\nYou need to add the Spezi Onboarding Swift package to\n[your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or\n[Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package).\n\n\n## Examples\n\n### Onboarding View\n\nThe [`OnboardingView`](https://swiftpackageindex.com/stanfordspezi/spezionboarding/documentation/spezionboarding/onboardingview) allows you to separate information into areas on a screen, each with a title, description, and icon.\n\n```swift\nimport SpeziOnboarding\nimport SwiftUI\n\n\nstruct OnboardingViewExample: View {\n    var body: some View {\n        OnboardingView(\n            title: \"Welcome\",\n            subtitle: \"This is an example onboarding view\",\n            areas: [\n                .init(\n                    icon: Image(systemName: \"tortoise.fill\"), \n                    title: \"Tortoise\", \n                    description: \"A Tortoise!\"\n                ),\n                .init(\n                    icon: {\n                        Image(systemName: \"lizard.fill\")\n                            .foregroundColor(.green)\n                    },\n                    title: \"Lizard\", \n                    description: \"A Lizard!\"\n                ),\n                .init(\n                    icon: {\n                        Circle().fill(.orange)\n                    }, \n                    title: \"Circle\", \n                    description: \"A Circle!\"\n                )\n            ],\n            actionText: \"Learn More\",\n            action: {\n                // Action to perform when the user taps the action button.\n            }\n        )\n    }\n}\n```\n\n\n### Sequential Onboarding View\n\nThe [`SequentialOnboardingView`](https://swiftpackageindex.com/stanfordspezi/spezionboarding/documentation/spezionboarding/sequentialonboardingview) allows you to display information step-by-step with each additional area appearing when the user taps the `Continue` button.\n\n```swift\nimport SpeziOnboarding\nimport SwiftUI\n\n\nstruct SequentialOnboardingViewExample: View {\n    var body: some View {\n        SequentialOnboardingView(\n            title: \"Things to know\",\n            subtitle: \"And you should pay close attention ...\",\n            steps: [\n                .init(\n                    title: \"A thing to know\", \n                    description: \"This is a first thing that you should know; read carefully!\"\n                ),\n                .init(\n                    title: \"Second thing to know\", \n                    description: \"This is a second thing that you should know; read carefully!\"\n                ),\n                .init(\n                    title: \"Third thing to know\", \n                    description: \"This is a third thing that you should know; read carefully!\"\n                )\n            ],\n            actionText: \"Continue\"\n        ) {\n            // Action to perform when the user has viewed all the steps\n        }\n    }\n}\n```\n\n\n## The Spezi Template Application\n\nThe [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication) provides a great starting point and example using the `SpeziOnboarding` module.\n\n\n\n## Contributing\n\nContributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) first.\n\n\n## License\n\nThis project is licensed under the MIT License. See [Licenses](https://github.com/StanfordSpezi/SpeziOnboarding/tree/main/LICENSES) for more information.\n\n![Spezi Footer](https://raw.githubusercontent.com/StanfordSpezi/.github/main/assets/FooterLight.png#gh-light-mode-only)\n![Spezi Footer](https://raw.githubusercontent.com/StanfordSpezi/.github/main/assets/FooterDark.png#gh-dark-mode-only)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstanfordspezi%2Fspezionboarding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstanfordspezi%2Fspezionboarding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstanfordspezi%2Fspezionboarding/lists"}