hud

HUD

A library allows you to show HUD (e.g. loading indicator) view.

Installing

This library is available on Maven Central. You can import Kaluga HUD as follows:

repositories {
    // ...
    mavenCentral()
}
// ...
dependencies {
    // ...
    implementation("com.splendo.kaluga:hud:$kalugaVersion")
}

Usage

Show default HUD:

MainScope().launch {
    val hud = builder.build(this)
    hud.present()
    // do Stuff
    hud.dismiss()
}

Default style is .SYSTEM and it will adapt colors for current appearance (dark/light) Default HUD also has no title label

Custom HUD with title:

MainScope().launch {
    val hud = builder.build(this) {
        setStyle(HUDStyle.CUSTOM)
        setTitle("Loading...")
    }
    hud.present()
}

The HUD has methods to show and dismiss a loading indicator view:

• present(animated: Boolean = true): HUD — show
• dismiss(animated: Boolean = true) — dismiss
• dismissAfter(timeMillis: Long, animated: Boolean = true): HUD — dismiss after timeMillis milliseconds
• presentDuring(block: suspend HUD.() -> T): T — show and keep visible during block execution, returning the result T of the block after dismissal.

Builder

The HUD.Builder class can be used to build HUDs.

Android

On Android the builder is a LifecycleSubscribable (see Architecture) that needs a LifecycleSubscribable.LifecycleManager object to provide the current context in which to display the HUD. For BaseViewModel, the builder should be made publicly visible and bound to a KalugaViewModelLifecycleObserver.

class HudViewModel: BaseViewModel() {

    val builder = HUD.Builder()

    fun present() {
        coroutineScope.launch {
            viewModel.builder.build(this) {
              setStyle(HUDStyle.CUSTOM)
              setTitle("Loading...")
            }.present()
        }
    }
}

And then in your Activity:

class MyActivity: KalugaViewModelActivity<HudViewModel>() {

    override val viewModel: HudViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        viewModel.present()
    }

}

For other usages, make sure to call LifecycleSubscriber.subscribe and LifecycleSubscriber.unsubscribe to manage the lifecycle manually.

// Android specific
MainScope().launch {
    val builder = HUD.Builder()
    builder.subscribe(activity)
    builder.build(coroutineScope) {
        // HUD Logic
    }.present()
}

You can use the AppCompatActivity.hudBuilder convenience method to get a builder that is valid during the lifespan of the Activity it belongs to.

Define your custom colors inside colors.xml if using .CUSTOM style:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <!-- surface color -->
    <color name="li_colorBackground">#FFFFFF</color>
    <!-- progress bar color -->
    <color name="li_colorAccent">#000000</color>
</resources>

iOS

On iOS this builder should be instantiated with UIViewController:

let builder = HUD.Builder(viewController)

Define your Color Sets in project's assets if using .CUSTOM style:

• li_colorBackground for surface color
• li_colorAccent for progress bar / activity indicator color