Inspired by Heinrich Reimer Material Intro and developed with love from scratch

Min SDK   15
Latest Commit   2017-01-31 09:43:06
License   MIT




Using app client to scan QR code to run Demo


GuideView 最最轻量级的新手引导库,能够快速为任何一个View创建一个遮罩层,支持单个页面,多个引导提示,支持为高亮区域设置不同的图形,支持引导动画,方便扩展,良好支持fragment
FancyShowCaseView An easy-to-use customisable show case view with circular reveal animation.
Onboarding A beautiful way to introduce users to your app

Android Material Intro Screen

Download Codacy Badge Build Status Android Arsenal Material Intro Screen

Material intro screen is inspired by Material Intro and developed with love from scratch. I decided to rewrite completely almost all features in order to make Android intro screen easy to use for everyone and extensible as possible.


Simple slide Custom slide Permission slide Finish slide
Simple slide Customslide Permission slide Finish slide


Step 1:

Add gradle dependecy

dependencies {
  compile '{latest_release}'

Step 2:

First, your intro activity class needs to extend MaterialIntroActivity:

public class IntroActivity extends MaterialIntroActivity

Step 3:

Add activity to manifest with defined theme:

            android:theme="@style/Theme.Intro" />

Step 4:

Add slides:

    protected void onCreate(@Nullable Bundle savedInstanceState) {
        addSlide(new SlideFragmentBuilder()
                .possiblePermissions(new String[]{Manifest.permission.CALL_PHONE, Manifest.permission.READ_SMS})
                .neededPermissions(new String[]{Manifest.permission.CAMERA, Manifest.permission.ACCESS_FINE_LOCATION, Manifest.permission.ACCESS_COARSE_LOCATION})
                .title("title 3")
                .description("Description 3")
                new MessageButtonBehaviour(new View.OnClickListener() {
                    public void onClick(View v) {
                        showMessage("We provide solutions to make you love your work");
                }, "Work with love"));

Explanation of SlideFragment usage:

  • possiblePermissions ⇾ permissions which are not necessary to be granted
  • neededPersmissions ⇾ permission which are needed to be granted to move further from that slide
  • MessageButtonBehaviour ⇾ create a new instance only if you want to have a custom action or text on a message button

Step 5:

Customize Intro Activity:

  • setSkipButtonVisible() ⇾ show skip button instead of back button on the left bottom of screen
  • hideBackButton() ⇾ hides any button on the left bottom of screen
  • enableLastSlideAlphaExitTransition() ⇾ set if the last slide should disapear with alpha hiding effect

Customizing view animations:

You can set enter, default and exit translation for every view in intro activity. To achive this you need to get translation wrapper for chosen view (for example: getNextButtonTranslationWrapper()) and set there new class which will implement IViewTranslation

                .setEnterTranslation(new IViewTranslation() {
                    public void translate(View view, @FloatRange(from = 0, to = 1.0) float percentage) {

Available translation wrappers:

  • getNextButtonTranslationWrapper()
  • getBackButtonTranslationWrapper()
  • getPageIndicatorTranslationWrapper()
  • getViewPagerTranslationWrapper()
  • getSkipButtonTranslationWrapper()

Custom slides

Of course you are able to implement completely custom slides. You only need to extend SlideFragment and override following functions:

  • backgroundColor()
  • buttonsColor()
  • canMoveFurther() (only if you want to stop user from being able to move further before he will do some action)
  • cantMoveFurtherErrorMessage() (as above)

If you want to use parallax in a fragment please use one of the below views:

And set there the app:layout_parallaxFactor attribute:



All features which are not available in simple Slide Fragment are shown here: Custom Slide

Things I have used to create this

Getting Help

To report a specific problem or feature request, open a new issue on Github.


Facebook     Twitter     LinkedIn