00zhengfu00 / android-simple-tooltip

A simple library based on PopupWindow to create Tooltips on Android. 💚

Android Simple Tooltip

PT

A simple library based on PopupWindow to create Tooltips on Android.

Features

• Working from Android 2.1 (API 7) Note: animation above 3.0 (API 11)
• Simple to use: few parameters in a single line of code
• Animation with speed and size control
• Option to close with touch inside or outside of the tooltip.
• Modal mode (prevents touch in the background)
• Overlay (darkens the background highlighting the anchor)
• Customizable arrow
• Inflatable content from a View or XML layout.
• Colors and dimensions customized by Builder or XML resources

Demo

Usage

Basic

View yourView = findViewById(R.id.your_view);

new SimpleTooltip.Builder(this)
    .anchorView(yourView)
    .text("Texto do Tooltip")
    .gravity(Gravity.END)
    .animated(true)
    .transparentOverlay(false)
    .build()
    .show();

Resources

<color name="simpletooltip_background">@color/colorAccent</color>
<color name="simpletooltip_text">@android:color/primary_text_light</color>
<color name="simpletooltip_arrow">@color/colorAccent</color>

<dimen name="simpletooltip_max_width">150dp</dimen>
<dimen name="simpletooltip_overlay_offset">10dp</dimen>
<dimen name="simpletooltip_margin">10dp</dimen>
<dimen name="simpletooltip_padding">8dp</dimen>
<dimen name="simpletooltip_arrow_width">30dp</dimen>
<dimen name="simpletooltip_arrow_height">15dp</dimen>
<dimen name="simpletooltip_animation_padding">4dp</dimen>

<integer name="simpletooltip_overlay_alpha">120</integer>
<integer name="simpletooltip_animation_duration">800</integer>

<style name="simpletooltip_default" parent="@android:style/TextAppearance.Medium"></style>

More info on the sample project and javadoc.

Download

Release

1. Add it in your root build.gradle at the end of repositories:

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

2. Add the dependency

   dependencies {
       compile 'com.github.douglasjunior:android-simple-tooltip:0.2.1'
   }

Snapshot

dependencies {
    compile('com.github.douglasjunior:android-simple-tooltip:master-SNAPSHOT') {
        changing = true // Gradle will then check for updates every 24 hours
    }
}

Contribute

New features, bug fixes and improvements in the translation are welcome! For questions and suggestions use the issues.

Before submit your PR, run the gradle check.

./gradlew build connectedCheck

Known issues

1. If you close the Dialog/Activity without the Tooltip is closed, there may be the exception java.lang.IllegalArgumentException: Could not lock surface. This error occurs because the animation continue for a while after closing the Dialog/Activity. (This error does not impact the execution of the app)

2. If you call tooltip.show() after Activity/Dialog is closed, there may be the exception android.view.WindowLeaked: Activity has leaked window android.widget.PopupWindow$PopupViewContainer that was originally added here. Read more. (This error does not impact the execution of the app)

3. From API 24, Android has changed the behavior of PopupWindow in relation to the setClippingEnabled property, which causes the Popup to be cut off. Read more.

Licence

The MIT License (MIT)

Copyright (c) 2016 Douglas Nassif Roma Junior

See the full licence file.