{"id":18274039,"url":"https://github.com/kirlosyousef/onboardmate","last_synced_at":"2026-05-01T19:34:35.710Z","repository":{"id":256622460,"uuid":"855435017","full_name":"KirlosYousef/OnboardMate","owner":"KirlosYousef","description":"SwiftUI Onboarding Library with Smooth Animations and Full Customization Options","archived":false,"fork":false,"pushed_at":"2025-02-08T15:03:33.000Z","size":20,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T03:41:51.896Z","etag":null,"topics":["framework","library","onboard","onboarding","onboarding-screen","swift","swiftui"],"latest_commit_sha":null,"homepage":"","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/KirlosYousef.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":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-10T21:29:12.000Z","updated_at":"2025-02-20T01:47:05.000Z","dependencies_parsed_at":"2024-09-12T04:48:10.872Z","dependency_job_id":"9f56440d-28aa-4386-ac1a-dfeb9e1c69ad","html_url":"https://github.com/KirlosYousef/OnboardMate","commit_stats":null,"previous_names":["kirlosyousef/onboardmate"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/KirlosYousef/OnboardMate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KirlosYousef%2FOnboardMate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KirlosYousef%2FOnboardMate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KirlosYousef%2FOnboardMate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KirlosYousef%2FOnboardMate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KirlosYousef","download_url":"https://codeload.github.com/KirlosYousef/OnboardMate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KirlosYousef%2FOnboardMate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32510808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["framework","library","onboard","onboarding","onboarding-screen","swift","swiftui"],"created_at":"2024-11-05T12:08:25.088Z","updated_at":"2026-05-01T19:34:35.677Z","avatar_url":"https://github.com/KirlosYousef.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OnboardMate\n\nYour simple and lightweight SwiftUI library mate for creating beautiful onboarding screens with smooth animations and full customization options.\n\nA real example from [RaceMe!](https://apps.apple.com/us/app/id1514432749) App:\n\n![Onboarding animation](https://i.imgur.com/XowgD2p.gif)\n\n## Features\n- Smooth animations\n- Full customization for each screen\n- Optional background and object images\n- Customizable action buttons with flexible actions\n\n## Usage\n\n1. **Import the `OnboardMate` library:**\n   ```swift\n   import OnboardMate\n   ```\n\n2. **Create a list of `OnboardingScreen`:**\n   Each `OnboardingScreen` represents the data for one screen.\n\n   Properties:\n   - `id`: Unique tab ID.\n   - `backgroundImage`: Optional background image to show at the top.\n   - `objectImage`: Optional object image to appear with smooth animation.\n   - `primaryText`: Main title for the screen.\n   - `descriptionText`: Secondary text for additional descriptions.\n   - `calloutText`: Optional callout text for highlights.\n   - `buttonTitle`: Action button title, default is \"Get Started!\".\n   - `buttonColor`: Button color, default is system’s background color.\n   - `didTapAction`: Action triggered when the button is tapped. Set to `nil` to hide the button.\n\n   Example:\n   ```swift\n   let screen1 = OnboardingScreen(\n       id: 0,\n       backgroundImage: Image(\"screen_1\"),\n       objectImage: Image(\"object_1\"),\n       primaryText: \"Screen 1 title\",\n       descriptionText: \"Screen 1 description\"\n   )\n\n   let screen2 = OnboardingScreen(\n       id: 1,\n       backgroundImage: Image(\"screen_2\"),\n       objectImage: Image(\"object_2\"),\n       primaryText: \"Screen 2 title\",\n       descriptionText: \"Screen 2 description\",\n       calloutText: \"Screen 2 callout\",\n       buttonTitle: \"Get Started!\",\n       buttonColor: .white\n   ) {\n       print(\"Onboarding done!\")\n   }\n\n   let screensList = [screen1, screen2]\n   ```\n\n3. **Display the onboarding screens:**\n   Call the `OnboardMateView` and pass your screens list.\n   \n   - `screensList`: The list of `OnboardingScreen` objects.\n   - `nextButtonColor`: Optional. If set, a \"Next\" button will appear on screens without action buttons.\n\n   Example:\n   ```swift\n   OnboardMateView(screensList: screensList, nextButtonColor: .white)\n   ```\n\n## Installation\n\n### Swift Package Manager\n\nAdd this to your package dependencies in `Package.swift`:\n```swift\ndependencies: [\n    .package(url: \"https://github.com/KirlosYousef/OnboardMate\")\n]\n```\n\n## Requirements\n- iOS 14+\n- Xcode 12+\n\n## Support\n\nFeel free to reach out to me at:\n- [Portfolio](https://kirlosyousef.com)\n- [LinkedIn](https://www.linkedin.com/in/kirlosyousef)\n\n## License\n\nOnboardMate is available under the MIT License. See the [LICENSE.md](LICENSE.md) file for more info.\n\n---\n\n© 2024 Kirlos Yousef.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirlosyousef%2Fonboardmate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkirlosyousef%2Fonboardmate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirlosyousef%2Fonboardmate/lists"}