MaterialShowcaseView

Additional

Language
Java
Version
1.3.4 (Apr 18, 2019)
Created
Aug 5, 2015
Updated
Aug 20, 2020
Owner
Dean Wild (deano2390)
Contributors
Miroslav Michalec (ForestTree)
Dean Wild (deano2390)
Pratyush Verma (p-v)
Colin White (colinrtwhite)
Sanjiv (narutosanjiv)
Tobias Boehm (ToBoehmK)
Turing Technologies (Wynne Plaga) (turing-tech)
Noor Dawod (noordawod)
yashasvi (yashasvigirdhar)
Luca Cesarano (Cesarsk)
Marc-Antoine Sauvé (madeinqc)
Aurèle Oulès (aureleoules)
Dale Lim (limdale)
Sridhar Nalam (sridhar-nalam)
Ricardo Sousa (RicardoRSousa)
Aleksey Goryachev (glnix)
iambalu
Majed DH (MajedDH)
18
Activity
Badge
Generate
Download
Source code
APK file

Promotion

Looking for collaborators to help maintain this library, drop me a line at me@deanwild.co.uk if you want to help.

MaterialShowcaseView

A Material Design themed ShowcaseView for Android

This library is heavily inspired by the original ShowcaseView library.

Since Google introduced the Material design philosophy I have seen quite a few apps with a nice clean, flat showcase view (the Youtube app is a good example). The only library out there however is the original one. This was a great library for a long time but the theming is now looking a bit dated.

Gradle

Add the jitpack repo to your your project's build.gradle at the end of repositories Why?

/build.gradle


Then add the dependency to your module's build.gradle:

/app/build.gradle

compile 'com.github.deano2390:MaterialShowcaseView:1.3.4'

NOTE: Some people have mentioned that they needed to add the @aar suffix to get it to resolve from JitPack:

compile 'com.github.deano2390:MaterialShowcaseView:1.3.4@aar'

How to use

This is the basic usage of a single showcase view, you should check out the sample app for more advanced usage.

// single examplenewMaterialShowcaseView.Builder(this)
  .setTarget(mButtonShow)
  .setDismissText("GOT IT")
  .setContentText("This is some amazing feature you should know about")
  .setDelay(withDelay) // optional but starting animations immediately in onCreate can make them choppy
  .singleUse(SHOWCASE_ID) // provide a unique ID used to ensure it is only shown once
  .show();
                
                
                
                
 // sequence example            ShowcaseConfig config =newShowcaseConfig();
 config.setDelay(500); // half second between each showcase viewMaterialShowcaseSequence sequence =newMaterialShowcaseSequence(this, SHOWCASE_ID);

 sequence.setConfig(config);

 sequence.addSequenceItem(mButtonOne,
  "This is button one", "GOT IT");

 sequence.addSequenceItem(mButtonTwo,
  "This is button two", "GOT IT");

 sequence.addSequenceItem(mButtonThree,
  "This is button three", "GOT IT");

 sequence.start();