Home

Awesome

FancyShowCaseView

<p align="center">An easy-to-use customizable show case view with circular reveal animation.</p> <p align="center"> <a href="https://github.com/faruktoptas/FancyShowCaseView/actions"><img src="https://github.com/faruktoptas/FancyShowCaseView/workflows/build/badge.svg" alt="Status"/></a> <a href="https://jitpack.io/#faruktoptas/FancyShowCaseView"><img src="https://jitpack.io/v/faruktoptas/FancyShowCaseView.svg" alt="Download"/></a> <a href="https://www.codacy.com/manual/faruktoptas/FancyShowCaseView?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=faruktoptas/FancyShowCaseView&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/47050961b2d947d3a58292f50d74e110" alt=""/></a> <a href="https://android-arsenal.com/details/1/5440"><img src="https://img.shields.io/badge/Android%20Arsenal-FancyShowCaseView-brightgreen.svg?style=flat" alt=""/></a> <a href="https://android-arsenal.com/api?level=10"><img src="https://img.shields.io/badge/API-14%2B-blue.svg?style=flat" alt=""/></a> <a href="https://gitter.im/faruktoptas/FancyShowCaseView?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/faruktoptas/FancyShowCaseView.svg" alt=""/></a> </p> <p align="center"> <img src="https://cloud.githubusercontent.com/assets/1595227/24761426/f80dbc64-1af3-11e7-9c99-bca3dd836a8e.png"/> </p> <p align="center"> <a href="https://material.uplabs.com/posts/fancyshowcaseview">@MaterialUp Best of the Day</a> </p>

Features

!gif!gif

Download

Add this in your root build.gradle file (not your module build.gradle file):

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

Then, add the library to your module build.gradle

dependencies {
    implementation 'com.github.faruktoptas:FancyShowCaseView:1.4.0'
}

Sample Usage

new FancyShowCaseView.Builder(this)
        .focusOn(view)
        .title("Focus on View")
        .build()
        .show();

Supported Properties

CommandDescription
focusOnThe view to be focused.
titleThe title text to be displayed.
typefaceThe custom typeface for the title text.
titleStyleThe text style for the title. (style defined in xml file)
titleGravityThe gravity (alignment) of the title within the view (e.g., start, center, end).
titleSizeThe size of the title text, typically in sp units.
enableAutoTextPositionCenter text position vertically.
backgroundColorThe background color of the view, typically in hexadecimal or resource ID format.
fitSystemWindowsThis should be set to true, if your root view has this property set to true.
focusShapeThe shape of the focus area (e.g., rounded rectangle, circle).
focusBorderColorThe color of the border around the focus area.
focusBorderSizeThe thickness of the border around the focus area (px)
focusDashedBorderMakes focus border dashed
roundRectRadiusThe radius for rounded corners when the focus shape is a rectangle with rounded edges. Use 0 for rectangle shape.
showOnceDetermines if the focus should be shown only once.
clickableOnLet the touch event pass through to clickable view zone only if clicking within
focusCircleRadiusFactorCircle radius factor. Default value is 1. Bigger value makes bigger circle.
focusRectSizeFactorFocus rectangle size factor. Default value is 1. Bigger value makes bigger rectangle.
customViewUse a fully customized view. If custom view used, title and title properties (titleStyle, titleGravity etc.) will be ignored.
closeOnTouchCloses the FancyShowCaseView when touching it.
enableTouchOnFocusedViewEnables touching the focused view. Default value is false.
enterAnimation
exitAnimation
animationListener
disableFocusAnimation
focusAnimationMaxValueFocus animation max value. Bigger value makes larger focus area.
focusAnimationStepStep for focus animation. Default value is 1.
focusRectAtPosition
focusCircleAtPosition
dismissListener
delayShows the FancyShowCaseView after a delay.

Please see wiki for more samples.

Already in use in following apps

(feel free to send me new projects)

Sample App

Latest Release

Xamarin Port

Thanks to DigitalSa1nt for the Xamarin ported version Xamarin.ShowcaseView

Contribute

You can contribute by opening a pull request to dev branch. Please try to push one feature in one commit for a clean commit history.

Buy Me a Coffee

<a href="https://www.buymeacoffee.com/faruktoptas" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

License

Apache License 2.0