spezionboarding
Spezi Onboarding module to inform a user or retrieve consent for a study participation
Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.2%) to scientific vocabulary
Keywords
Repository
Spezi Onboarding module to inform a user or retrieve consent for a study participation
Basic Info
- Host: GitHub
- Owner: StanfordSpezi
- License: mit
- Language: Swift
- Default Branch: main
- Homepage: https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding/documentation/
- Size: 5.08 MB
Statistics
- Stars: 15
- Watchers: 9
- Forks: 8
- Open Issues: 6
- Releases: 36
Topics
Metadata Files
README.md
Spezi Onboarding
Provides UI components for Onboarding.
Overview
The SpeziOnboarding module provides user interface components to onboard a user to an iOS application.
|
|
|
OnboardingView
|
SequentialOnboardingView
|
OnboardingConsentView
|
Setup
Add Spezi Onboarding as a Dependency
You need to add the Spezi Onboarding Swift package to your app in Xcode or Swift package.
Examples
Onboarding View
The OnboardingView allows you to separate information into areas on a screen, each with a title, description, and icon.
```swift import SpeziOnboarding import SwiftUI
struct OnboardingViewExample: View { var body: some View { OnboardingView( title: "Welcome", subtitle: "This is an example onboarding view", areas: [ .init( icon: Image(systemName: "tortoise.fill"), title: "Tortoise", description: "A Tortoise!" ), .init( icon: { Image(systemName: "lizard.fill") .foregroundColor(.green) }, title: "Lizard", description: "A Lizard!" ), .init( icon: { Circle().fill(.orange) }, title: "Circle", description: "A Circle!" ) ], actionText: "Learn More", action: { // Action to perform when the user taps the action button. } ) } } ```
Sequential Onboarding View
The SequentialOnboardingView allows you to display information step-by-step with each additional area appearing when the user taps the Continue button.
```swift import SpeziOnboarding import SwiftUI
struct SequentialOnboardingViewExample: View { var body: some View { SequentialOnboardingView( title: "Things to know", subtitle: "And you should pay close attention ...", steps: [ .init( title: "A thing to know", description: "This is a first thing that you should know; read carefully!" ), .init( title: "Second thing to know", description: "This is a second thing that you should know; read carefully!" ), .init( title: "Third thing to know", description: "This is a third thing that you should know; read carefully!" ) ], actionText: "Continue" ) { // Action to perform when the user has viewed all the steps } } } ```
The Spezi Template Application
The Spezi Template Application provides a great starting point and example using the SpeziOnboarding module.
Contributing
Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first.
License
This project is licensed under the MIT License. See Licenses for more information.
Owner
- Name: Stanford Spezi
- Login: StanfordSpezi
- Kind: organization
- Repositories: 1
- Profile: https://github.com/StanfordSpezi
GitHub Events
Total
- Create event: 23
- Release event: 8
- Issues event: 12
- Watch event: 2
- Delete event: 12
- Issue comment event: 50
- Push event: 119
- Pull request review event: 116
- Pull request review comment event: 131
- Pull request event: 22
- Fork event: 2
Last Year
- Create event: 23
- Release event: 8
- Issues event: 12
- Watch event: 2
- Delete event: 12
- Issue comment event: 50
- Push event: 119
- Pull request review event: 116
- Pull request review comment event: 131
- Pull request event: 22
- Fork event: 2
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 27
- Total pull requests: 58
- Average time to close issues: 4 months
- Average time to close pull requests: 27 days
- Total issue authors: 6
- Total pull request authors: 10
- Average comments per issue: 1.07
- Average comments per pull request: 3.36
- Merged pull requests: 50
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 7
- Pull requests: 22
- Average time to close issues: 2 days
- Average time to close pull requests: 28 days
- Issue authors: 4
- Pull request authors: 5
- Average comments per issue: 0.29
- Average comments per pull request: 2.14
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- PSchmiedmayer (9)
- philippzagar (6)
- vishnuravi (5)
- Supereg (3)
- LeonNissen (1)
- Dlemex (1)
Pull Request Authors
- Supereg (17)
- lukaskollmer (15)
- philippzagar (12)
- PSchmiedmayer (6)
- akanshyabhat (6)
- vishnuravi (5)
- RealLast (4)
- felixschlegel (4)
- pauljohanneskraft (2)
- AdritRao (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 36
swiftpackageindex.com: github.com/StanfordSpezi/SpeziOnboarding
Spezi Onboarding module to inform a user or retrieve consent for a study participation
- Homepage: https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding/documentation/
- Documentation: https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding/documentation
- License: mit
-
Latest release: 2.0.2
published 6 months ago