Skip to content
Material Intro View is a showcase android library.
Branch: master
Clone or download
iammert Merge pull request #76 from badoualy/master
Update to v26 and Fix #23 (bad background on cardview)
Latest commit f7b36b7 Oct 18, 2017
Type Name Latest commit message Commit time
Failed to load latest commit information.
art Merge pull request #28 from icechen1/master Dec 19, 2016
gradle/wrapper Update to v26 Oct 17, 2017
materialintro Update to v26 Oct 17, 2017
sample Update to v26 Oct 17, 2017
.gitignore Mask color added. Jan 24, 2016 Fix broken Markdown headings Apr 16, 2017
build.gradle Update to v26 Oct 17, 2017 Mask color added. Jan 24, 2016
gradlew Mask color added. Jan 24, 2016
gradlew.bat Mask color added. Jan 24, 2016

MaterialIntroView [Beta]

Material Intro View is a showcase android library.

We saw this kind of showcase on Fabulous App and we love it. Then decided to create showcase just like it.



new MaterialIntroView.Builder(this)
                .setInfoText("Hi There! Click this card and see what happens.")
                .setUsageId("intro_card") //THIS SHOULD BE UNIQUE ID


Project build.gradle

repositories {
    maven {
        url ""

Module build.gradle

dependencies {
  compile 'com.github.iammert:MaterialIntroView:1.6.0'

Builder Methods

.setDelayMillis(3000) //starts after 3 seconds passed
.enableFadeAnimation(true) //View will appear/disappear with fade in/out animation
//ie. If your button's width has MATCH_PARENT.
//Focus.ALL is not a good option. You can use
//Focus.MINIMUM or Focus.NORMAL. See demos below.
//ie. You can focus on left of RecyclerView list item.
.setTarget(myButton) //Focus on myButton
.setTargetPadding(30) //add 30px padding to focus circle
.setInfoText("This is info text!") //Setting text will enable info dialog
.setTextColor(Color.Black) //Info dialog's text color is set to black
.setInfoTextSize(30) //Change text size
.setShapeType(ShapeType.CIRCLE) //Change shape of focus area
.setShapeType(ShapeType.RECTANGLE) //Change shape of focus area
.setCustomShape(Shape shape) //Use custom shape
// Allow this showcase overlay to only show up once. Prevents multiple screens from showing at the same time.
// Useful if you wish to show a tour step in a code that gets called multiple times
.setUsageId("intro_fab_button") //Store intro view status whether it is learnt or not
.enableDotAnimation(true) //Shows dot animation center of focus area
.enableIcon(false) //Turn off helper icon, default is true
.performClick(true) //Trigger click operation when user click focused area.
//If you don't want to perform click automatically
//You can disable perform clik and handle it yourself
.setListener(new MaterialIntroListener() {
                    public void onUserClicked(String materialIntroViewId) {

Configuration Method

//Create global config instance to not write same config to builder
//again and again.
MaterialIntroConfiguration config = new MaterialIntroConfiguration();
.setConfiguration(config) //

Use Custom Shapes

You can use your own highlight shapes if Circle and Rectangle do not work for you. See source for Circle and Rect for implementation example.

public class MyShape extends Shape {
    // ... your implementation

//... in your app code

.setCustomShape(MyShape shape)


Alt text Alt text Alt text Alt text Alt text


  • Sample app will be more detailed about using library.
  • Sequence for MaterialIntroViews



Murat Can BUR


Chinese Doc


Copyright 2015 Mert Şimşek.

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
You can’t perform that action at this time.