Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramotion/paper-onboarding-android
:octocat: PaperOnboarding is a material design slider made by @Ramotion
https://github.com/ramotion/paper-onboarding-android
android java library
Last synced: 2 days ago
JSON representation
:octocat: PaperOnboarding is a material design slider made by @Ramotion
- Host: GitHub
- URL: https://github.com/ramotion/paper-onboarding-android
- Owner: Ramotion
- License: mit
- Created: 2016-04-25T09:31:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-25T18:17:20.000Z (over 2 years ago)
- Last Synced: 2024-12-13T06:00:50.673Z (9 days ago)
- Topics: android, java, library
- Language: Java
- Homepage: https://www.ramotion.com/paper-onboarding-android/
- Size: 12.7 MB
- Stars: 2,560
- Watchers: 70
- Forks: 420
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
PAPER ONBOARDING
Android library Paper Onboarding is a material design UI slider written on Java
___
We specialize in the designing and coding of custom UI for Mobile Apps and Websites.
Stay tuned for the latest updates:
[](https://circleci.com/gh/Ramotion/paper-onboarding-android)
[](https://www.codacy.com/app/Ramotion/paper-onboarding-android?utm_source=github.com&utm_medium=referral&utm_content=ramotion/paper-onboarding-android&utm_campaign=Badge_Grade)
[](http://twitter.com/Ramotion)
[](https://paypal.me/Ramotion)
## Requirements
- Android 4.0.3 IceCreamSandwich (API lvl 15) or greater
- Your favorite IDE
## Installation
Just download the package from [here](http://central.maven.org/maven2/com/ramotion/paperonboarding/paper-onboarding/1.1.3/paper-onboarding-1.1.3.aar) and add it to your project classpath, or just use the maven repo:
Gradle:
```groovy
'com.ramotion.paperonboarding:paper-onboarding:1.1.3'
```
SBT:
```scala
libraryDependencies += "com.ramotion.paperonboarding" % "paper-onboarding" % "1.1.3"
```
Maven:
```xml
com.ramotion.paperonboarding
paper-onboarding
1.1.3
aar
```
## Basic usage
Paper Onboarding is a simple and easy to use onboarding slider for your app. You just need to provide content for each slider page - a main icon, text, and small round icon for the bottom.
1 Use `PaperOnboardingPage` to prepare your data for slider:
```java
PaperOnboardingPage scr1 = new PaperOnboardingPage("Hotels",
"All hotels and hostels are sorted by hospitality rating",
Color.parseColor("#678FB4"), R.drawable.hotels, R.drawable.key);
PaperOnboardingPage scr2 = new PaperOnboardingPage("Banks",
"We carefully verify all banks before add them into the app",
Color.parseColor("#65B0B4"), R.drawable.banks, R.drawable.wallet);
PaperOnboardingPage scr3 = new PaperOnboardingPage("Stores",
"All local stores are categorized for your convenience",
Color.parseColor("#9B90BC"), R.drawable.stores, R.drawable.shopping_cart);
ArrayList elements = new ArrayList<>();
elements.add(scr1);
elements.add(scr2);
elements.add(scr3);
```
2 Create a fragment from `PaperOnboardingFragment` and provide your data.
```java
PaperOnboardingFragment onBoardingFragment = PaperOnboardingFragment.newInstance(elements);
```
3 Done! Now you can use this fragment as you want in your activity, for example :
```java
FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
fragmentTransaction.add(R.id.fragment_container, onBoardingFragment);
fragmentTransaction.commit();
```
4 Extra step : You can add event listeners to fragments with your logic, like replacing this fragment to another when the user swipes next from the last screen:
```java
onBoardingFragment.setOnRightOutListener(new PaperOnboardingOnRightOutListener() {
@Override
public void onRightOut() {
FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
Fragment bf = new BlankFragment();
fragmentTransaction.replace(R.id.fragment_container, bf);
fragmentTransaction.commit();
}
});
```
Currently, there are three listeners that cover all events - onRightOut, onLeftOut and onChange; see code examples and usage in the repo.
## 🗂 Check this library on other language:
## 📄 License
Paper Onboarding Android is released under the MIT license.
See [LICENSE](./LICENSE) for details.
This library is a part of a selection of our best UI open-source projects
If you use the open-source library in your project, please make sure to credit and backlink to www.ramotion.com
## 📱 Get the Showroom App for Android to give it a try
Try this UI component and more like this in our Android app. Contact us if interested.
