{"id":13605361,"url":"https://github.com/Chrisvin/ConcentricOnboarding","last_synced_at":"2025-04-12T05:32:46.141Z","repository":{"id":143525500,"uuid":"287951242","full_name":"Chrisvin/ConcentricOnboarding","owner":"Chrisvin","description":"Android Concentric Onboarding library","archived":false,"fork":false,"pushed_at":"2020-08-25T23:41:22.000Z","size":4217,"stargazers_count":52,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-07T10:41:08.000Z","etag":null,"topics":["android","android-library","concentric","concentriconboarding","library","onboarding","page","pager","viewpager"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","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/Chrisvin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-08-16T13:41:47.000Z","updated_at":"2023-12-03T02:15:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"bed400e2-4042-4337-8a6e-84926d6ccf48","html_url":"https://github.com/Chrisvin/ConcentricOnboarding","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chrisvin%2FConcentricOnboarding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chrisvin%2FConcentricOnboarding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chrisvin%2FConcentricOnboarding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chrisvin%2FConcentricOnboarding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chrisvin","download_url":"https://codeload.github.com/Chrisvin/ConcentricOnboarding/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248524191,"owners_count":21118609,"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":["android","android-library","concentric","concentriconboarding","library","onboarding","page","pager","viewpager"],"created_at":"2024-08-01T19:00:57.822Z","updated_at":"2025-04-12T05:32:45.077Z","avatar_url":"https://github.com/Chrisvin.png","language":"Kotlin","funding_links":[],"categories":["Kotlin"],"sub_categories":[],"readme":"# ConcentricOnboarding\nAndroid Concentric Onboarding library\n\n [![License: MIT](https://img.shields.io/badge/License-MIT-silver.svg)](https://opensource.org/licenses/MIT) [![](https://jitpack.io/v/Chrisvin/ConcentricOnboarding.svg)](https://jitpack.io/#Chrisvin/ConcentricOnboarding) [![API](https://img.shields.io/badge/API-21%2B-blue.svg?style=flat)](https://android-arsenal.com/api?level=21) \n\n| \u003cimg src=\"./screenrecording/slide.gif\"/\u003e | \u003cimg src=\"./screenrecording/reveal.gif\"/\u003e |\n| :-: | :-: |\n| Slide Mode | Reveal Mode |\n\nConcentricOnboarding is a viewpager library that can be used to make awesome onboarding designs.\n\nIf you like this, you'll like [LiquidSwipe](https://github.com/Chrisvin/LiquidSwipe) as well.\n\n## Demo app\nTo run the demo project, clone the repository and run it via Android Studio.\n\u003c/br\u003e(OR)\n\u003c/br\u003eDownload the latest demo apk from [releases](https://github.com/Chrisvin/ConcentricOnboarding/releases).\n\n## Usage\n#### Set up the dependency\n1. Add the JitPack repository to your root build.gradle at the end of repositories:\n```\nallprojects {\n\trepositories {\n\t\t...\n\t\tmaven { url 'https://jitpack.io' }\n\t}\n}\n```\n2. Add the ConcentricOnboarding dependency in the build.gradle:\n```\nimplementation 'com.github.Chrisvin:ConcentricOnboarding:1.0'\n```\n\n#### Use `ConcentricOnboardingViewPager` instead of the normal `ViewPager`\n```\n\u003candroidx.constraintlayout.widget.ConstraintLayout \n    xmlns:android=\"http://schemas.android.com/apk/res/android\"\n    android:layout_width=\"match_parent\"\n    android:layout_height=\"match_parent\"\u003e\n\n    \u003ccom.jem.concentriconboarding.ConcentricOnboardingViewPager\n        android:id=\"@+id/viewpager\"\n        android:layout_width=\"match_parent\"\n        android:layout_height=\"match_parent\"/\u003e\n\n\u003c/androidx.constraintlayout.widget.ConstraintLayout\u003e\n```\n\n#### Use a `ConcentricOnboardingLayout` as the base container in the fragment layouts\n```\n\u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n\u003ccom.jem.concentriconboarding.layout.ConcentricOnboardingConstraintLayout\n    xmlns:android=\"http://schemas.android.com/apk/res/android\"\n    xmlns:app=\"http://schemas.android.com/apk/res-auto\"\n    xmlns:tools=\"http://schemas.android.com/tools\"\n    android:layout_width=\"match_parent\"\n    android:layout_height=\"match_parent\"\n    tools:context=\".DummyFragment\"\u003e\n\n    \u003c!--  Fill with your views, just like you would in a normal ConstraintLayout  --\u003e\n\n\u003c/com.jem.concentriconboarding.layout.ConcentricOnboardingConstraintLayout\u003e\n\n\u003c!--  Also supports ConcentricOnboardingFrameLayout \u0026 ConcentricOnboardingLinearLayout  --\u003e\n```\n\n### And you're done, easy-peasy. ^_^\n\n## Customization\n### Via XML\n```\n\u003ccom.jem.concentriconboarding.ConcentricOnboardingViewPager\n    ...\n    app:mode=\"reveal\" // Default is slide\n    app:scrollerDuration=\"2000\" // Default is 1000\n    app:translationXFactor=\"3\" // Default is 2\n    app:translationYFactor=\"0.5\" // Default is 0.35\n    app:scaleXFactor=\"0.75\" // Default is 0.5\n    app:scaleYFactor=\"0.75\" // Default is 0.5\n    /\u003e\n```\n### Via Programmatically\n```\nviewpager.mode = ConcentricOnboardingViewPager.Mode.REVEAL // Default is SLIDE\nviewpager.setDuration(3000) // Default is 1000\nviewpager.translationXFactor = 1.5f // Default is 2f\nviewpager.translationYFactor = 1f // Default is 0.35f\nviewpager.scaleXFactor = 2f // Default is 0.5f\nviewpager.scaleYFactor = 2f // Default is 0.5f\nviewpager.revealCenterPoint = PointF(centerX, centerY) // Default is screen center\nviewpager.revealRadius = radius // Default is 0\n```\n\n## Creating custom swipe animations\n\nThe concept for the `ClipPathProvider` in ConcentricOnboarding is the same as that in the [LiquidSwipe library](https://github.com/Chrisvin/LiquidSwipe) \u0026 [EasyReveal library](https://github.com/Chrisvin/EasyReveal) (If you haven't already, then you should really check it out).\n\nYou can create your own swipe animation by extending the [ClipPathProvider](https://github.com/Chrisvin/ConcentricOnboarding/blob/master/concentriconboarding/src/main/java/com/jem/concentriconboarding/base/ClipPathProvider.kt) and implementing the `getPath()` method. `getPath()` provides the [Path](https://developer.android.com/reference/android/graphics/Path) for a given *percent* value on the provided *view*.  The path gotten from `getPath()` is then used to clip the view using `canvas.clipPath(path, op)` (The `op` value is provided by the `ClipPathProvider` as well). You can then set your custom [ClipPathProvider](https://github.com/Chrisvin/ConcentricOnboarding/blob/master/concentriconboarding/src/main/java/com/jem/concentriconboarding/base/ClipPathProvider.kt) to your layouts.\n\n## Bugs and Feedback\nFor bugs, questions and discussions please use the [Github Issues](https://github.com/Chrisvin/ConcentricOnboarding/issues).\n\n## Credits\n1. [Cuberto](https://dribbble.com/shots/6654320-Animated-Onboarding-Screens) - Onboarding design inspiration\n2. [Alvaro Fabre](https://lottiefiles.com/tomfabre) - Designer of the lottie animations in the demo app\n\n## License\n```\nMIT License\n\nCopyright (c) 2020 Jem\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChrisvin%2FConcentricOnboarding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FChrisvin%2FConcentricOnboarding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChrisvin%2FConcentricOnboarding/lists"}