Package com.skydoves.balloon

Types

ArrowOrientation
Link copied to clipboard
enum ArrowOrientation : Enum<ArrowOrientation>

ArrowOrientation determines the orientation of the arrow.

ArrowOrientationRules
Link copied to clipboard
enum ArrowOrientationRules : Enum<ArrowOrientationRules>

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

ArrowPositionRules
Link copied to clipboard
enum ArrowPositionRules : Enum<ArrowPositionRules>

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

Balloon
Link copied to clipboard
class Balloon : DefaultLifecycleObserver

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

BalloonAnimation
Link copied to clipboard
enum BalloonAnimation : Enum<BalloonAnimation>

BalloonAnimation is the collection of the popup animations.

BalloonCenterAlign
Link copied to clipboard
enum BalloonCenterAlign : Enum<BalloonCenterAlign>

BalloonCenterAlign is an aligning rule for the Balloon.showAtCenter.

BalloonHighlightAnimation
Link copied to clipboard
enum BalloonHighlightAnimation : Enum<BalloonHighlightAnimation>

BalloonHighlightAnimation gives repeated dynamic animations on Balloon when it's showing. The animation would work differently by the position of the arrow.

BalloonPersistence
Link copied to clipboard
class BalloonPersistence

BalloonPreferenceManager helps to persist showing counts.

BalloonSizeSpec
Link copied to clipboard
object BalloonSizeSpec

A specification interface for determining sizes of the Balloon materials. We can wrap some materials depending on their size of content using this interface.

IconForm
Link copied to clipboard
class IconForm

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

IconGravity
Link copied to clipboard
enum IconGravity : Enum<IconGravity>

IconGravity determines the orientation of the icon.

OnBalloonClickListener
Link copied to clipboard
fun interface OnBalloonClickListener

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

OnBalloonDismissListener
Link copied to clipboard
fun interface OnBalloonDismissListener

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

OnBalloonInitializedListener
Link copied to clipboard
fun interface OnBalloonInitializedListener

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

OnBalloonOutsideTouchListener
Link copied to clipboard
fun interface OnBalloonOutsideTouchListener

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

OnBalloonOverlayClickListener
Link copied to clipboard
fun interface OnBalloonOverlayClickListener

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

TextForm
Link copied to clipboard
class TextForm

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

Functions

balloon
Link copied to clipboard
inline fun <T : Balloon.Factory> View.balloon(): Lazy<Balloon>

Returns a Lazy delegate to access the custom View's Balloon property. The balloon property will be initialized lazily.

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

Returns a Lazy delegate to access the ComponentActivity's Balloon property. The balloon property will be initialized lazily.

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

Returns a Lazy delegate to access the Fragment's Balloon property. The balloon property will be initialized lazily.

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

Returns a Lazy delegate to access the custom ViewBinding's Balloon property. The balloon property will be initialized lazily.

createBalloon
Link copied to clipboard
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
Link copied to clipboard
inline fun iconForm(context: Context, crossinline block: IconForm.Builder.() -> Unit): IconForm

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

showAlignBottom
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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.

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

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