AndroidOnboarder


Source link: https://github.com/chyrta/AndroidOnboarder

Android Onboarder

Android Onboarder is a lightweight library that helps you to create a simple and beautiful welcome screen (as known as App Intro, Onboarding Experience and etc.) for your users.

Usage

Gradle

Add dependency in your build.gradle

compile 'com.github.chyrta:AndroidOnboarder:0.7'

Maven

<dependency>
  <groupId>com.github.chyrta</groupId>
  <artifactId>AndroidOnboarder</artifactId>
  <version>0.7</version>
  <type>pom</type> </dependency> 

Implementation

Create an activity which should inherits from OnboarderActivity. Look at the example below to see how that library works.

public class IntroActivity extends OnboarderActivity {

 List<OnboarderPage> onboarderPages;
 @Override
protected void onCreate(Bundle savedInstanceState) {

  super.onCreate(savedInstanceState);

  onboarderPages = new ArrayList<OnboarderPage>();

// Create your first page
  OnboarderPage onboarderPage1 = new OnboarderPage("Title 1", "Description 1");

  OnboarderPage onboarderPage2 = new OnboarderPage(R.string.app_title, R.string.app_description, R.drawable.my_awesome_image);

// You can define title and description colors (by default white)
  onboarderPage1.setTitleColor(R.color.black);

  onboarderPage1.setDescriptionColor(R.color.white);

// Don't forget to set background color for your page
  onboarderPage1.setBackgroundColor(R.color.my_awesome_color);

// Add your pages to the list
  onboarderPages.add(onboarderPage1);

  onboarderPages.add(onboarderPage2);

// And pass your pages to 'setOnboardPagesReady' method
  setOnboardPagesReady(onboarderPages);

 
}

 @Override
public void onSkipButtonPressed() {

  // Optional: by default it skips onboarder to the end
  super.onSkipButtonPressed();

  // Define your actions when the user press 'Skip' button

}

 @Override
public void onFinishButtonPressed() {

  // Define your actions when the user press 'Finish' button

}
  
}

Tips

Remember that you can (Inside your Activity that extends OnboarderActivity):

  • Change dot's colors (active and inactive)
  • Darken the layout where buttons are placed
  • Change divider color, height (in dp) and visibility
  • Choose to use FloatingActionButton or not
  • Set text size of title and description
  • Force multiline description to be centered
  • Set title to skip and finish buttons
  • Hide skip button from the user
setActiveIndicatorColor(android.R.color.white);
 setInactiveIndicatorColor(android.R.color.darker_gray);
 shouldDarkenButtonsLayout(true);
 setDividerColor(Color.WHITE);
 setDividerHeight(2);
 setDividerVisibility(View.GONE);
 shouldUseFloatingActionButton(true);
 setSkipButtonTitle("Skip");
 setFinishButton("Finish");
 setSkipButtonHidden();
 setTitleTextSize(12);
 setDescriptionTextSize(12);
 setMultilineDescriptionCentered(true);

Contributions

Feel free to create issues and pull requests

License

MIT License  Copyright (c) 2017 Dzmitry Chyrta, Daniel Morales  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. 

Resources

This library makes it easy to animate Floating Action Button to Bottom Sheet Dialog and vice versa.

Library to create a material search view similar to one used in apps developed by Google Inc.

R2D2 Android uses Android Keystore to store passwords and other sensitive information for different API versions in an encrypted form.

An Android library to easily display attribution information of open source libraries.

A custom radio button with liquid animations. It lets you to control everything related to animations from xml attributes.

Just another Kotlin sample application.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes