{"id":13604144,"url":"https://github.com/Ramotion/paper-onboarding-android","last_synced_at":"2025-04-11T23:31:49.841Z","repository":{"id":47899811,"uuid":"57029460","full_name":"Ramotion/paper-onboarding-android","owner":"Ramotion","description":":octocat: PaperOnboarding is a material design slider made by @Ramotion","archived":false,"fork":false,"pushed_at":"2022-08-25T18:17:20.000Z","size":13319,"stargazers_count":2557,"open_issues_count":10,"forks_count":420,"subscribers_count":69,"default_branch":"master","last_synced_at":"2025-04-05T19:06:02.347Z","etag":null,"topics":["android","java","library"],"latest_commit_sha":null,"homepage":"https://www.ramotion.com/paper-onboarding-android/","language":"Java","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/Ramotion.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-25T09:31:20.000Z","updated_at":"2025-03-23T14:14:03.000Z","dependencies_parsed_at":"2022-08-12T14:00:51.829Z","dependency_job_id":null,"html_url":"https://github.com/Ramotion/paper-onboarding-android","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ramotion%2Fpaper-onboarding-android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ramotion%2Fpaper-onboarding-android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ramotion%2Fpaper-onboarding-android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ramotion%2Fpaper-onboarding-android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ramotion","download_url":"https://codeload.github.com/Ramotion/paper-onboarding-android/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248495005,"owners_count":21113545,"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","java","library"],"created_at":"2024-08-01T19:00:40.504Z","updated_at":"2025-04-11T23:31:48.501Z","avatar_url":"https://github.com/Ramotion.png","language":"Java","funding_links":["https://paypal.me/Ramotion"],"categories":["引导图(Intro)","Library","Java"],"sub_categories":[],"readme":"\u003ca href=\"https://www.ramotion.com/agency/app-development/?utm_source=gthb\u0026utm_medium=repo\u0026utm_campaign=paper-onboarding-android\"\u003e\u003cimg src=\"https://github.com/Ramotion/folding-cell/blob/master/header.png\"\u003e\u003c/a\u003e\n\n\u003ca href=\"https://github.com/Ramotion/paper-onboarding-android\"\u003e\n\u003cimg align=\"left\" src=\"https://github.com/Ramotion/paper-onboarding-android/blob/master/onboarding_preview.gif\" width=\"480\" height=\"360\" /\u003e\u003c/a\u003e\n\n\u003cp\u003e\u003ch1 align=\"left\"\u003ePAPER ONBOARDING\u003c/h1\u003e\u003c/p\u003e\n\n\u003ch4\u003eAndroid library Paper Onboarding is a material design UI slider written on Java\u003c/h4\u003e\n\n\n___\n\n\n\u003cp\u003e\u003ch6\u003eWe specialize in the designing and coding of custom UI for Mobile Apps and Websites.\u003c/h6\u003e\n\u003ca href=\"https://www.ramotion.com/agency/app-development/?utm_source=gthb\u0026utm_medium=repo\u0026utm_campaign=paper-onboarding-android\"\u003e\n\u003cimg src=\"https://github.com/ramotion/gliding-collection/raw/master/contact_our_team@2x.png\" width=\"187\" height=\"34\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ch6\u003eStay tuned for the latest updates:\u003c/h6\u003e\n\u003ca href=\"https://goo.gl/rPFpid\" \u003e\n\u003cimg src=\"https://i.imgur.com/ziSqeSo.png/\" width=\"156\" height=\"28\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003c/br\u003e\n\n[![CircleCI](https://circleci.com/gh/Ramotion/paper-onboarding-android.svg?style=svg)](https://circleci.com/gh/Ramotion/paper-onboarding-android)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ed1eb5c89dfc45eabb80e93c6a124012)](https://www.codacy.com/app/Ramotion/paper-onboarding-android?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=ramotion/paper-onboarding-android\u0026amp;utm_campaign=Badge_Grade)\n[![Twitter](https://img.shields.io/badge/Twitter-@Ramotion-blue.svg?style=flat)](http://twitter.com/Ramotion)\n[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://paypal.me/Ramotion)\n\n## Requirements\n​\n- Android 4.0.3 IceCreamSandwich (API lvl 15) or greater\n- Your favorite IDE\n\n## Installation\n​\nJust 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:\n​\nGradle:\n```groovy\n'com.ramotion.paperonboarding:paper-onboarding:1.1.3'\n```\nSBT:\n```scala\nlibraryDependencies += \"com.ramotion.paperonboarding\" % \"paper-onboarding\" % \"1.1.3\"\n```\nMaven:\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.ramotion.paperonboarding\u003c/groupId\u003e\n    \u003cartifactId\u003epaper-onboarding\u003c/artifactId\u003e\n    \u003cversion\u003e1.1.3\u003c/version\u003e\n    \u003ctype\u003eaar\u003c/type\u003e\n\u003c/dependency\u003e\n```\n\n## Basic usage\n\nPaper 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.\n\n1 Use `PaperOnboardingPage` to prepare your data for slider:\n```java\nPaperOnboardingPage scr1 = new PaperOnboardingPage(\"Hotels\",\n\t\"All hotels and hostels are sorted by hospitality rating\",\n        Color.parseColor(\"#678FB4\"), R.drawable.hotels, R.drawable.key);\nPaperOnboardingPage scr2 = new PaperOnboardingPage(\"Banks\",\n\t\"We carefully verify all banks before add them into the app\",\n        Color.parseColor(\"#65B0B4\"), R.drawable.banks, R.drawable.wallet);\nPaperOnboardingPage scr3 = new PaperOnboardingPage(\"Stores\",\n\t\"All local stores are categorized for your convenience\",\n        Color.parseColor(\"#9B90BC\"), R.drawable.stores, R.drawable.shopping_cart);\n\nArrayList\u003cPaperOnboardingPage\u003e elements = new ArrayList\u003c\u003e();\nelements.add(scr1);\nelements.add(scr2);\nelements.add(scr3);\n```\n\n\n2 Create a fragment from `PaperOnboardingFragment` and provide your data.\n```java\nPaperOnboardingFragment onBoardingFragment = PaperOnboardingFragment.newInstance(elements);\n```\n\n3 Done! Now you can use this fragment as you want in your activity, for example :\n\n```java\nFragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();\nfragmentTransaction.add(R.id.fragment_container, onBoardingFragment);\nfragmentTransaction.commit();\n```\n\n4 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:\n\n```java\nonBoardingFragment.setOnRightOutListener(new PaperOnboardingOnRightOutListener() {\n    @Override\n    public void onRightOut() {\n        FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();\n        Fragment bf = new BlankFragment();\n        fragmentTransaction.replace(R.id.fragment_container, bf);\n        fragmentTransaction.commit();\n    }\n});\n```\nCurrently, there are three listeners that cover all events - onRightOut, onLeftOut and onChange; see code examples and usage in the repo.\n\n\u003cbr\u003e\n\n## 🗂 Check this library on other language:\n\u003ca href=\"https://github.com/Ramotion/paper-onboarding\"\u003e \n\u003cimg src=\"https://github.com/ramotion/navigation-stack/raw/master/Swift@2x.png\" width=\"178\" height=\"81\"\u003e\u003c/a\u003e\n\n\n## 📄 License\n\nPaper Onboarding Android is released under the MIT license.\nSee [LICENSE](./LICENSE) for details.\n\nThis library is a part of a \u003ca href=\"https://github.com/Ramotion/android-ui-animation-components-and-libraries\"\u003e\u003cb\u003eselection of our best UI open-source projects\u003c/b\u003e\u003c/a\u003e\n\nIf you use the open-source library in your project, please make sure to credit and backlink to www.ramotion.com\n\n## 📱 Get the Showroom App for Android to give it a try\nTry this UI component and more like this in our Android app. Contact us if interested.\n\n\u003ca href=\"https://play.google.com/store/apps/details?id=com.ramotion.showroom\" \u003e\n\u003cimg src=\"https://raw.githubusercontent.com/Ramotion/react-native-circle-menu/master/google_play@2x.png\" width=\"104\" height=\"34\"\u003e\u003c/a\u003e\n\n\u003ca href=\"https://www.ramotion.com/agency/app-development/?utm_source=gthb\u0026utm_medium=repo\u0026utm_campaign=paper-onboarding-android\"\u003e\n\u003cimg src=\"https://github.com/ramotion/gliding-collection/raw/master/contact_our_team@2x.png\" width=\"187\" height=\"34\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRamotion%2Fpaper-onboarding-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRamotion%2Fpaper-onboarding-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRamotion%2Fpaper-onboarding-android/lists"}