hud/com.splendo.kaluga.hud

Package-level declarations

Types

Link copied to clipboard
abstract class BaseHUD(coroutineScope: CoroutineScope) : CoroutineScope

Class showing a loading indicator HUD.

Link copied to clipboard
actual class HUD : BaseHUD

Default BaseHUD implementation.

expect class HUD : BaseHUD

Default BaseHUD implementation.

actual class HUD

Default BaseHUD implementation.

actual class HUD : BaseHUD

Default BaseHUD implementation.

actual class HUD : BaseHUD

Default BaseHUD implementation.

Link copied to clipboard
data class HudConfig(val style: HUDStyle = HUDStyle.SYSTEM, val title: String? = null)
Link copied to clipboard
enum HUDStyle : Enum<HUDStyle>

Style of the Loading Indicator

Properties

Link copied to clipboard
val BaseHUD.style: HUDStyle

The HUDStyle of the HUD.

Link copied to clipboard
val BaseHUD.title: String?

The title of the HUD.

Functions

Link copied to clipboard
fun BaseHUD.Builder.build(coroutineScope: CoroutineScope, initialize: HudConfig.Builder.() -> Unit = { }): BaseHUD

Builds a HUD to display a loading indicator

Link copied to clipboard
fun BaseHUD.dismissAfter(timeMillis: Long, animated: Boolean = true): BaseHUD

Dismisses the indicator after timeMillis milliseconds

fun BaseHUD.dismissAfter(duration: Duration, animated: Boolean = true): BaseHUD

Dismisses the indicator after duration

Link copied to clipboard
suspend fun <T> BaseHUD.presentDuring(animated: Boolean = true, block: suspend BaseHUD.() -> T): T

Presents and keep presenting the indicator during block execution, hides view after block finished.