Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Chrisvin/ConcentricOnboarding

Android Concentric Onboarding library
https://github.com/Chrisvin/ConcentricOnboarding

android android-library concentric concentriconboarding library onboarding page pager viewpager

Last synced: about 2 months ago
JSON representation

Android Concentric Onboarding library

Host: GitHub
URL: https://github.com/Chrisvin/ConcentricOnboarding
Owner: Chrisvin
License: mit
Created: 2020-08-16T13:41:47.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2020-08-25T23:41:22.000Z (about 4 years ago)
Last Synced: 2024-07-11T13:00:28.818Z (2 months ago)
Topics: android, android-library, concentric, concentriconboarding, library, onboarding, page, pager, viewpager
Language: Kotlin
Homepage:
Size: 4.02 MB
Stars: 52
Watchers: 1
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-list - Chrisvin/ConcentricOnboarding - Android Concentric Onboarding library (Kotlin)

README

# ConcentricOnboarding
Android Concentric Onboarding library

[![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)

| | |
| :-: | :-: |
| Slide Mode | Reveal Mode |

ConcentricOnboarding is a viewpager library that can be used to make awesome onboarding designs.

If you like this, you'll like [LiquidSwipe](https://github.com/Chrisvin/LiquidSwipe) as well.

## Demo app
To run the demo project, clone the repository and run it via Android Studio.
(OR)
Download the latest demo apk from [releases](https://github.com/Chrisvin/ConcentricOnboarding/releases).

## Usage
#### Set up the dependency
1. Add the JitPack repository to your root build.gradle at the end of repositories:
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
2. Add the ConcentricOnboarding dependency in the build.gradle:
```
implementation 'com.github.Chrisvin:ConcentricOnboarding:1.0'
```

#### Use `ConcentricOnboardingViewPager` instead of the normal `ViewPager`
```

```

#### Use a `ConcentricOnboardingLayout` as the base container in the fragment layouts
```

```

### And you're done, easy-peasy. ^_^

## Customization
### Via XML
```

```
### Via Programmatically
```
viewpager.mode = ConcentricOnboardingViewPager.Mode.REVEAL // Default is SLIDE
viewpager.setDuration(3000) // Default is 1000
viewpager.translationXFactor = 1.5f // Default is 2f
viewpager.translationYFactor = 1f // Default is 0.35f
viewpager.scaleXFactor = 2f // Default is 0.5f
viewpager.scaleYFactor = 2f // Default is 0.5f
viewpager.revealCenterPoint = PointF(centerX, centerY) // Default is screen center
viewpager.revealRadius = radius // Default is 0
```

## Creating custom swipe animations

The concept for the `ClipPathProvider` in ConcentricOnboarding is the same as that in the [LiquidSwipe library](https://github.com/Chrisvin/LiquidSwipe) & [EasyReveal library](https://github.com/Chrisvin/EasyReveal) (If you haven't already, then you should really check it out).

You 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.

## Bugs and Feedback
For bugs, questions and discussions please use the [Github Issues](https://github.com/Chrisvin/ConcentricOnboarding/issues).

## Credits
1. [Cuberto](https://dribbble.com/shots/6654320-Animated-Onboarding-Screens) - Onboarding design inspiration
2. [Alvaro Fabre](https://lottiefiles.com/tomfabre) - Designer of the lottie animations in the demo app

## License
```
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```