Kotlin coroutine flow example for Android button click event?

Question

I used to use Channel to send out click event from Anko View class to Activity class, however more and more Channel functions are marked as deprecated. So I wanted to start using Flow apis.

I migrated code below:

private val btnProduceChannel = Channel<Unit>()
val btnChannel : ReceiveChannel<Unit> = btnProduceChannel 

// Anko
button {
    onClick {
        btnProduceChannel.send(Unit)
    }
}

to:

lateinit var btnFlow: Flow<Unit>
    private set

button {
    btnFlow = flow { 
       onClick { 
            emit(Unit) 
       }
    }
}

I have to mark flow properties as var now which is not so elegant as before. Is this way right? Can I init a Rx Subject like Flow when defining the property?

Edit:

I brought Channel back, then used consumeAsFlow():

private val btnChannel = Channel<Unit>()

// This can be collected only once
val btnFlow = btnChannel.consumeAsFlow()

// Or add get() to make property can be collected multiple times
// But the "get()" can be easily forgotten and I don't know the performance of create flow every access
val btnFlow get() = btnChannel.consumeAsFlow()


// Send event with btnChannel

This seems better than lateinit var one, but any way to get rid of Channel completely? (Though Flow itself like callbackFlow, channelFlow are using channel)

Stanislav Shamilov · Accepted Answer · 2021-09-20T13:15:32.643

22

Although I don't use Anko in my project, I've written this function to use with regular button references, see if it helps you:

fun View.clicks(): Flow<Unit> = callbackFlow {
    setOnClickListener {
        offer(Unit)
    }
    awaitClose { setOnClickListener(null) }
}

An example of possible usage is:

button.clicks()
   .onEach { /*React on a click event*/ }
   .launchIn(lifecycleScope)

UPDATE

As @Micer mentioned in the comments to the original answer, the method Channel#offer has become deprecated in the favour of Channel#trySend method.

The updated version:

fun View.clicks() = callbackFlow<Unit> {
    setOnClickListener {
        trySend(Unit)
    }
    awaitClose { setOnClickListener(null)}
}

edited Sep 20 '21 at 13:15

answered Sep 12 '19 at 20:57

Stanislav Shamilov

1,746
11
20

Thanks for sharing this useful kotlin extension! This replaces my old `RxView.clicks(view)` :) – Ryan Amaral Nov 15 '19 at 10:22
What is the difference between `lifecycleScope.launch` and `.launchIn(lifecycleScope)`? – IgorGanapolsky Apr 26 '20 at 18:07
guys for some reasona it's not working on AppcompatButton – vikas kumar Jun 13 '20 at 08:37
1

@IgorGanapolsky aside from being more convenient in some cases, it's a terminal statement, almost always needs `onEach()` before – Ace Jan 01 '21 at 17:11
`offer` is deprecated and should be replaced by `trySend` – Micer Sep 17 '21 at 08:24

score 0 · Answer 2 · answered Mar 01 '22 at 04:13

For kotlin lover

Using callbacFlow

fun View.clicks() = callbackFlow {
setOnClickListener {
    this.trySend(Unit).isSuccess
}
 awaitClose { setOnClickListener(null) }
}

Usage

bind.btn.clicks().onEach {
 // do your staff
}.launchIn(lifecycleScope)

Using Channel eventActor

fun View.setOnClick(action: suspend () -> Unit) {
 // launch one actor as a parent of the context job
 val scope = (context as? CoroutineScope) ?: AppScope
 val eventActor = scope.actor<Unit>(capacity = Channel.CONFLATED) {
     for (event in channel) action()
  }
    // install a listener to activate this actor
    setOnClickListener { eventActor.trySend(Unit).isSuccess }
}

Usage

bind.btn.setOnClick {
    // do your staff
  }

Kotlin coroutine flow example for Android button click event?

2 Answers2

Linked