Skip to content

Latest commit

 

History

History
114 lines (97 loc) · 4.04 KB

README.md

File metadata and controls

114 lines (97 loc) · 4.04 KB
Raw

FancyShowCaseView Status Android Arsenal API Join the chat at https://gitter.im/faruktoptas/FancyShowCaseView

An easy-to-use customizable show case view with circular reveal animation.

materialup

@MaterialUp Best of the Day

Features

  • Circular reveal animation (API Level 21+)
  • Background color
  • Circle and Rounded Rectangle focus shapes
  • Title style and position
  • Custom view inflation
  • Custom enter/exit animations
  • Chaining multiple FancyShowCaseView instances
  • Showing only one time

!gif

!gif

Gradle Dependency

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 {
    compile 'com.github.faruktoptas:FancyShowCaseView:0.1.1'
}

Sample Usage

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

Rounded Rectangle

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

Customize

new FancyShowCaseView.Builder(this)
        .focusOn(view)
        .focusCircleRadiusFactor(1.5)
        .title("Focus on View with larger circle")
        .titleStyle(0, Gravity.BOTTOM | Gravity.CENTER)
        .enterAnimation(enterAnimation)
        .exitAnimation(exitAnimation)
        .showOnce("fancy1")
        .backgroundColor(Color.parseColor("#CC00FF00"))
        .build()
        .show();

Inflating Custom View

new FancyShowCaseView.Builder(this)
        .customView(R.layout.layout_my_custom_view, null)
        .build()
        .show();

Queuing multiple instances

new FancyShowCaseQueue()
	    .add(fancyShowCaseView1)
	    .add(fancyShowCaseView2)
	    .add(fancyShowCaseView3)
	    .show();

Already in use in following apps

(feel free to send me new projects)

Sample App

fancyshowcaseview-sample-v0.1.2.apk

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.

License

Copyright 2017 Faruk Toptaş

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

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.