EasyIntro

The flexible, easy to use, all in one app intro library for your Android project.

Programming language: Java

License: Apache License 2.0

Tags: Other Widget    

Latest version: v3.0

README

EasyIntro

Does your application contain an Intro? Do you want to have it up and running in less than 5 minutes? Do you want your intro to follow the Android Design Guidelines? Do you need flexibility? Do you believe Google is wrong with not providing native intro? Do you want a simple and easy to understand API?

If any (or all) of these questions seem familiar, the EasyIntro is the perfect library for you.

Never waste your time again. It provides you with the easiest possible implementation of an intro for your application. There is an Activity and Fragment with lots of methods, provide custom page indicator, custom toggle indicators, custom colors, custom themes, custom slide transformers … No limits for customizations.

A Quick Overview What's In

• The easiest possible integration
• Integrate in less than 5 minutes
• Compatible down to API level 13
• Quick and simple API
• Uses the AppCompat support library
• Follows the Google Material Design Guidelines
• Uses vector (.svg) icons
• Overlay slides
• Fully supports back stack
• Modify intro settings on the go
• Comes with multiple default indicators
• Limit your swipe direction
• Supports back button press on slides
• Supports custom indicators
• Callbacks
• Supports overlay slides animations
• Extended Fragment for easy access to intro methods
• Comes with multiple default slide transformers
• Based on a ViewPager
• Supports RTL
• Lock on specific slides
• Incredibly customizable
• Tested and stable
• Absolutely no limits

Screenshots

EasyIntro in Action

Wiki

You surely can find more details on the wiki page.

Include to Project

Provide the Gradle Dependency

Add the dependency:

dependencies {
    compile 'io.github.meness:easyintro:x.y.z'
}

Note: Replace x.y.z with the latest version which can be found at releases page.

Clone or Download .zip file

Clone this repository or download the compressed file, then extract to your computer. Simply import the library module to your project.

Usage

Create your Fragments which extend EasyIntroFragment and provide your desired layout resource as you always do:

public class IntroOneFragment extends EasyIntroFragment {
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        return inflater.inflate(R.layout.intro_one, container, false);
    }
}

Note: By extending EasyIntroFragment you have easier access to the intro methods and the layout bottom padding will be modified automatically.

Create an activity which extends EasyIntro and override the necessary initIntro() method:

public class MyEasyIntro extends EasyIntro {

    // override callbacks you need

    @Override
    protected void initIntro() {
        // use withSlide() to add slides and
        // configure your app intro
    }
}

Note: For more details about listeners, intro settings, customizing colors, and all other things visit wiki.

Define your activity in your Manifest.xml:

<activity
    android:name=".MyEasyIntro"
    android:theme="@style/EasyIntro"/>

Note: This is good to give your intro activity a theme which has EasyIntro as a parent.

Libraries Used

• Materialize
• ViewPagerTransforms
• SpringIndicator
• CircleIndicator

Credits

• Mike Penz - Github
  • For the good .README appearance.

Developed By

• Alireza Eskandarpour Shoferi
  • Twitter - [email protected]

License

Copyright 2016 Alireza Eskandarpour Shoferi

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.