Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Highlight the best bits of your app to users quickly, simply, and cool...ly
Java
branch: master

This branch is 3 commits behind tonchidot:master

README.md

Showcase View library

The ShowcaseView library is designed to highlight and showcase specific parts of apps to the user with a distinctive and attractive overlay. This library is great for pointing out points of interest for users, gestures, or obscure but useful items.

The library is based on the "Cling" view found in the Launcher on Ice-Cream Sandwich and Jelly Bean, but extended to be easier to use.

Please check out the website for more information.

Example image

Set-up

For people who use Maven, ShowcaseView should work immediately without any issues. If you aren't, you'll need to download the NineOldAndroids library and add it as a dependency library to the ShowcaseView library. Then add ShowcaseView as a library dependency to your project, and you're done!

WARNING: Sometimes Eclipse/IDEA will automatically import the non-NineOldAndroid versions of the animation classes, which will cause crashes on versions of Android below 3.0. Check that your imports start with com.nineoldandroids.animation and not android.animation.

Usage

v2 brings the ability to showcase items on the ActionBar. Currently built in showcase-able things are:

  • The home button
  • Your application title or a Spinner if you're using that navigation type
  • Any ActionItem - requires only the item's ID
  • The Overflow icon

Gestures can now be indicated using animateGesture(...), which returns a NineOldAndroids AnimatorSet, which can be gestured simply by calling start() on it. If you want to make your own gestures, getHand() will return the View which contains the Ghostly Hand. You can also quickly point to something using the pointTo(..) methods.

Styles are included to maintain consistently in ShowcaseViews. Buttons should use the style ClingButton, with title text using ClingTitleText and standard text using ClingText.

Upcoming features

  • Improved styling ability
  • Variable sized circles/images for showcasing

Copyright and Licensing

Copyright Alex Curran (+Alex) © 2012. All rights reserved.

This library is disributed under an Apache 2.0 License.

Something went wrong with that request. Please try again.