chyrta / androidonboarder Goto Github PK

A simple way to make a beauty onboarding experience (app intro or welcome screen) for your users.

Java 100.00%

android onboarding onboarder introduction intro app material gradle

androidonboarder's Introduction

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.

androidonboarder's People

Contributors

Stargazers

Watchers

androidonboarder's Issues

New Onboarding Material Guidelines

Google create guidelines for Onboarding screens:

https://material.io/guidelines/growth-communications/onboarding.html#onboarding-top-user-benefits

Diferences: portrait and landscape

And tablets:

version 0.7 clashes with support library 26

i have checked the source files and found that the latest version is 0.8 but using that results in an error perhaps 0.8 was not pushed to maven or am i missing something

error: expected reference but got (raw string) #000000 with Gradle "implementation"

Thanks for this library that looks super cool.

Sadly, when I add implementation 'com.github.chyrta:AndroidOnboarder:0.7' to Gradle, I get this error: error: expected reference but got (raw string) #000000.

This error looks to point to this:

<style name="Widget.Support.CoordinatorLayout" parent="android:Widget">
        <item name="statusBarBackground">#000000</item>
</style>

This happen only when I use implementation instead of 'compile' (which is deprecated).

Can you do something to fully support the new implementation in Gradle?

Title centered?

Hi,

Right now I have 5 onboarding pages and my 1-line titles are centered but my 2-line titles are left-aligned. I don't see an option to make the title appear centered always?
Can we make the title appear centered if the title is more than 1 line?

thanks
ed

Skipping Button

Hi there,

When using the skip button I want to move on something else and not having to slide to the last one and then move to something else.

This can be done changing the onClick

else if (i == R.id.btn_skip) {
    vpOnboarderPager.setCurrentItem(onboarderAdapter.getCount());
    onSkipButtonPressed();
}

else if (i == R.id.btn_skip) {
       onSkipButtonPressed();
}

and moving the logic to the abstract method onSkipButtonPressed()

abstract public void onSkipButtonPressed(){
    vpOnboarderPager.setCurrentItem(onboarderAdapter.getCount());
}

This way if you want to auto-scroll to last page, call the super.onSkipButtonPressed()
else don't put the super for not scrolling to the last page.

Is it something possible to add in the library or considered out bounds?

Centered multiline description not updated to library

Even though the centered multiline description effect has been merged to the repository, it has not been updated to the library yet.
I am unable to access the method.

onboarderPage.setMultilineDescriptionCentered(true) raises a Cannot resolve error

Suggestions

Hi, thanks for this useful project.

I want to suggest some features also:

allow to set font size of title and description.
allow to set image as background.
allow to hide the skip button and rename the skip button.
allow to rename the finish button.

Thanks again!