Skip to content

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

License

Notifications You must be signed in to change notification settings

NoelOmo/material-intro-screen

Repository files navigation

Android 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 extenisble as possible.

Features

  • Easly add new slides
  • Custom slides
  • Parallax slides
  • Easy extensible api
  • Material design as it's best!!!
Simple slide Custom slide Permission slide Finish slide
Simple slide Customslide Permission slide Finish slide

Usage

Step 1:

Download

Add gradle dependecy

compile 'agency.tango.android:material-intro-screen:0.0.1'

Step 2:

First, your intro activity class need to extend MaterialIntroActivity

public class IntroActivity extends MaterialIntroActivity

Step 3:

Add activity to manifest with defined theme

        <activity
            android:name=".IntroActivity"
            android:theme="@style/Theme.Intro" />

Step 4: Add slides

 @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        
        addSlide(new SlideFragmentBuilder()
                .backgroundColor(R.color.colorPrimary)
                .buttonsColor(R.color.colorAccent)
                .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})
                .image(agency.tango.materialintroscreen.R.drawable.ic_next)
                .title("title 3")
                .description("Description 3")
                .build(),
                new MessageButtonBehaviour(new View.OnClickListener() {
                    @Override
                    public void onClick(View v) {
                        Toast.makeText(IntroActivity.this, "We provide solutions to make you love your work", Toast.LENGTH_SHORT).show();
                    }
                }, "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 new instance only if you want to have custom action or text on 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

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 fragment please use one of below views:

  • ParallaxFrameLayout
  • ParallaxLinearLayout
  • ParallaxRelativeLayout

And set there attribute app:layout_parallaxFactor

<agency.tango.materialintroscreen.parallax.ParallaxLinearLayout
xmlns:android="http://schemas.android.com/apk/res/android">

    <ImageView
        android:id="@+id/image_slide"
        app:layout_parallaxFactor="0.6"/>

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

Things I have used to create this

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%