Android LiveData: Handle UI Event With Event Wrapper (SingleLiveEvent Replacement)

August 19, 2019

Why not to use LiveData to handle UI event? Because LiveData will trigger again upon configuation change / screen rotation. We want to handle UI event such as click once only.

The above problem could be solved using SingleLiveEvent.

Alternatively, you can use Event wrapper.

open class Event<out T>(private val value: T) {
    private val pending = AtomicBoolean(true)

    fun getIfPending(): T? {
        return if (pending.compareAndSet(true, false)) {
            value
        }
        else {
            null
        }
    }

    fun peek(): T = value

    fun isPending(): Boolean = pending.get()
}

NOTE: Based on Event by JoseAlcerreca

NOTE: Solution for multiple observers (I didn’t try this)

Usage

val selectItemEvent = MutableLiveData<Event<Int>>()

// trigger ui event on item selected
selectItemEvent.value = Event(10)

selectItemEvent.observe(lifecycleOwner, Observer { event ->
    val position = event.getIfPending()
    if (position != null) {
        // do something
    }
})

To reduce boilerplate code, you can use an EventObserver.

class EventObserver<T>(private val observe: (T) -> Unit) : Observer<Event<T>> {
    override fun onChanged(event: Event<T>?) {
        event?.getIfPending()?.let { value ->
            observe(value)
        }
    }
}

NOTE: Based on EventObserver by JoseAlcerreca

selectItemEvent.observe(lifecycleOwner, EventObserver { position ->
    // do something
})

❤️ Is this article helpful?

Buy me a coffee☕ or support my work to keep this space 🖖 and ad-free.
If you can't, do send some 💖 to @d_luaz or help to share this article.

👶 Apps I built

Pixtory App (Alpha) - easily organize photos on your phone into a blog.
COVID-19 - data, chart, information & news.
暖心芽 (WIP) 🌞❤️🌱 - reminder of hope, warmth, thoughts and feelings.
Travelopy - travel discovery and journal
LuaPass - offline password manager
WhatIDoNow - a public log of things I am working on now

By Desmond Lua

A dream boy who enjoys programming and travelling, maker of Travelopy. Follow me on @d_luaz.

Tags:

Android Use LiveData To Show Toast Message From ViewModel

Guide to learning Android Dev with Kotlin and Architecture Components (ViewModel, LiveData and Room)

Android Keep Track of Edit and View Mode With LiveData (Fragment, Kotlin)

Android Create Singleton LiveData to Observe Changes (e.g. User Login and Logout) - Kotlin

Android Firebase Auth AuthStateListener as LiveData (lifecycle-aware)

Android Firestore Query addSnapshotListener as LiveData (lifecycle aware)

Android Firestore Document addSnapshotListener as LiveData (lifecycle aware)

Android Handle RecyclerView Click Event With LiveData

Android Instrumented Unit Test With Room Using In Memory Database And LiveData