Package com.skydoves.balloon

Types

ArrowOrientation

enum ArrowOrientation : Enum<ArrowOrientation>

ArrowOrientation determines the orientation of the arrow.

ArrowOrientationRules

enum ArrowOrientationRules : Enum<ArrowOrientationRules>

ArrowOrientationRules determines the orientation of the arrow depending on the aligning rules.

ArrowPositionRules

enum ArrowPositionRules : Enum<ArrowPositionRules>

ArrowPositionRules determines the position of the arrow depending on the aligning rules.

Balloon

class Balloon : LifecycleObserver

Balloon implements a customizable tooltips popup with and arrow and animations.

BalloonAnimation

enum BalloonAnimation : Enum<BalloonAnimation>

BalloonAnimation is the collection of the popup animations.

BalloonCenterAlign

enum BalloonCenterAlign : Enum<BalloonCenterAlign>

BalloonCenterAlign is an aligning rule for the Balloon.showAtCenter.

BalloonHighlightAnimation

enum BalloonHighlightAnimation : Enum<BalloonHighlightAnimation>

BalloonHighlightAnimation gives repeated dynamic animations on Balloon when it's showing.

BalloonPersistence

class BalloonPersistence

BalloonPreferenceManager helps to persist showing counts.

BalloonSizeSpec

object BalloonSizeSpec

A specification interface for determining sizes of the Balloon materials.

IconForm

class IconForm

IconForm is an attribute class which has TextView attributes for customizing popup icons easily.

IconGravity

enum IconGravity : Enum<IconGravity>

IconGravity determines the orientation of the icon.

OnBalloonClickListener

fun fun interface OnBalloonClickListener

Interface definition for a callback to be invoked when a balloon view is clicked.

OnBalloonDismissListener

fun fun interface OnBalloonDismissListener

Interface definition for a callback to be invoked when a balloon view is dismissed.

OnBalloonInitializedListener

fun fun interface OnBalloonInitializedListener

Interface definition for a callback to be invoked when a balloon view is initialized.

OnBalloonOutsideTouchListener

fun fun interface OnBalloonOutsideTouchListener

Interface definition for a callback to be invoked when touched on outside of the balloon popup.

OnBalloonOverlayClickListener

fun fun interface OnBalloonOverlayClickListener

Interface definition for a callback to be invoked when a balloon overlay view is clicked.

TextForm

class TextForm

TextFrom is an attribute class what has some attributes about TextView for customizing popup texts easily.

Functions

balloon

@MainThread()

inline fun <T : Balloon.Factory> View.balloon(): Lazy<Balloon>

Returns a Lazy delegate to access the custom View's Balloon property.

@MainThread()

inline fun <T : Balloon.Factory> ComponentActivity.balloon(): Lazy<Balloon>

Returns a Lazy delegate to access the ComponentActivity's Balloon property.

@MainThread()

inline fun <T : Balloon.Factory> Fragment.balloon(): Lazy<Balloon>

Returns a Lazy delegate to access the Fragment's Balloon property.

@MainThread()

inline fun <T : Balloon.Factory> View.balloon(factory: KClass<T>): Lazy<Balloon>

Returns a Lazy delegate to access the custom View's Balloon property.

@MainThread()

inline fun <T : Balloon.Factory> ComponentActivity.balloon(factory: KClass<T>): Lazy<Balloon>

Returns a Lazy delegate to access the ComponentActivity's Balloon property.

@MainThread()

inline fun <T : Balloon.Factory> Fragment.balloon(factory: KClass<T>): Lazy<Balloon>

Returns a Lazy delegate to access the Fragment's Balloon property.

createBalloon

@MainThread()

inline fun createBalloon(context: Context, crossinline block: Balloon.Builder.() -> Unit): Balloon

Creates an instance of the Balloon by scope of the Balloon.Builder using kotlin dsl.

iconForm

@MainThread()

inline fun iconForm(context: Context, crossinline block: IconForm.Builder.() -> Unit): IconForm

creates an instance of IconForm from IconForm.Builder using kotlin dsl.

showAlignBottom

@JvmOverloads()

fun View.showAlignBottom(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as the bottom alignment with x-off and y-off.

showAlignLeft

@JvmOverloads()

fun View.showAlignLeft(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as the left alignment with x-off and y-off..

showAlignRight

@JvmOverloads()

fun View.showAlignRight(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as the right alignment with x-off and y-off.

showAlignTop

@JvmOverloads()

fun View.showAlignTop(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as the top alignment with x-off and y-off.

showAsDropDown

@JvmOverloads()

fun View.showAsDropDown(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as drop down with x-off and y-off.

showAtCenter

@JvmOverloads()

fun View.showAtCenter(balloon: Balloon, xOff: Int = 0, yOff: Int = 0, centerAlign: BalloonCenterAlign = BalloonCenterAlign.TOP)

shows the balloon on the center of an anchor view.

showBalloon

fun View.showBalloon(balloon: Balloon)

shows the balloon on the center of an anchor view.

fun View.showBalloon(balloon: Balloon, xOff: Int, yOff: Int)

shows the balloon on an anchor view with x-off and y-off.

textForm

@MainThread()

inline fun textForm(context: Context, crossinline block: TextForm.Builder.() -> Unit): TextForm

creates an instance of TextForm from TextForm.Builder using kotlin dsl.