├── .gitignore ├── .idea ├── .gitignore ├── .name ├── compiler.xml ├── gradle.xml ├── kotlinc.xml └── misc.xml ├── LICENSE ├── README.md ├── app ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── dladukedev │ │ └── uievents │ │ └── ExampleInstrumentedTest.kt │ ├── main │ ├── AndroidManifest.xml │ ├── java │ │ └── com │ │ │ └── dladukedev │ │ │ └── uievents │ │ │ ├── MainActivity.kt │ │ │ ├── domain │ │ │ └── LogAnalyticsUseCase.kt │ │ │ └── ui │ │ │ ├── core │ │ │ ├── DetailsScreen.kt │ │ │ ├── EventScreen.kt │ │ │ ├── HomeScreen.kt │ │ │ └── Router.kt │ │ │ └── events │ │ │ ├── CallbacksScreen.kt │ │ │ ├── FireAndForgetScreen.kt │ │ │ ├── MarkOnConsumeScreen.kt │ │ │ ├── MarkOnSendScreen.kt │ │ │ └── StateScreen.kt │ └── res │ │ ├── drawable │ │ ├── ic_launcher_background.xml │ │ └── ic_launcher_foreground.xml │ │ ├── mipmap-anydpi │ │ ├── ic_launcher.xml │ │ └── ic_launcher_round.xml │ │ ├── mipmap-hdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-mdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xxhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xxxhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── values │ │ ├── colors.xml │ │ ├── strings.xml │ │ └── themes.xml │ │ └── xml │ │ ├── backup_rules.xml │ │ └── data_extraction_rules.xml │ └── test │ └── java │ └── com │ └── dladukedev │ └── uievents │ └── ExampleUnitTest.kt ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── settings.gradle /.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.aar 4 | *.ap_ 5 | *.aab 6 | 7 | # Files for the ART/Dalvik VM 8 | *.dex 9 | 10 | # Java class files 11 | *.class 12 | 13 | # Generated files 14 | bin/ 15 | gen/ 16 | out/ 17 | # Uncomment the following line in case you need and you don't have the release build type files in your app 18 | # release/ 19 | 20 | # Gradle files 21 | .gradle/ 22 | build/ 23 | 24 | # Local configuration file (sdk path, etc) 25 | local.properties 26 | 27 | # Proguard folder generated by Eclipse 28 | proguard/ 29 | 30 | # Log Files 31 | *.log 32 | 33 | # Android Studio Navigation editor temp files 34 | .navigation/ 35 | 36 | # Android Studio captures folder 37 | captures/ 38 | 39 | # IntelliJ 40 | *.iml 41 | .idea/workspace.xml 42 | .idea/tasks.xml 43 | .idea/gradle.xml 44 | .idea/assetWizardSettings.xml 45 | .idea/dictionaries 46 | .idea/libraries 47 | # Android Studio 3 in .gitignore file. 48 | .idea/caches 49 | .idea/modules.xml 50 | # Comment next line if keeping position of elements in Navigation Editor is relevant for you 51 | .idea/navEditor.xml 52 | 53 | # Keystore files 54 | # Uncomment the following lines if you do not want to check your keystore files in. 55 | #*.jks 56 | #*.keystore 57 | 58 | # External native build folder generated in Android Studio 2.2 and later 59 | .externalNativeBuild 60 | .cxx/ 61 | 62 | # Google Services (e.g. APIs or Firebase) 63 | # google-services.json 64 | 65 | # Freeline 66 | freeline.py 67 | freeline/ 68 | freeline_project_description.json 69 | 70 | # fastlane 71 | fastlane/report.xml 72 | fastlane/Preview.html 73 | fastlane/screenshots 74 | fastlane/test_output 75 | fastlane/readme.md 76 | 77 | # Version control 78 | vcs.xml 79 | 80 | # lint 81 | lint/intermediates/ 82 | lint/generated/ 83 | lint/outputs/ 84 | lint/tmp/ 85 | # lint/reports/ 86 | -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | -------------------------------------------------------------------------------- /.idea/.name: -------------------------------------------------------------------------------- 1 | Ui Events -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 18 | 19 | -------------------------------------------------------------------------------- /.idea/kotlinc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Donovan LaDuke 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # UI Eventing Android Demo 2 | 3 | ### Overview 4 | A Demo app built to show off an assortment of options for handling UI or One Time Events on Android (e.g. showing a snackbar or prompting navigation) 5 | 6 | Demonstrated Methods 7 | - [Callbacks](#Callbacks) 8 | - [Mark on Send](#Mark-on-Send) 9 | - [Fire and Forget](#Fire-and-Forget) 10 | - [Mark on Consume](#Mark-on-Consume) 11 | - [Events as State](#Events-as-State) 12 | 13 | ## Callbacks 14 | - Passing an implementation of a Callback Interface from the View to the ViewModel 15 | - **Considerations** 16 | - Tight Coupling 17 | - Requires Full Implementation 18 | - No Guarantees of Call 19 | - Need to Ensure Life-Cycle Aware 20 | 21 | ## Mark on Send 22 | - Once the Event has been sent, the ViewModel records that the event has been sent without View confirmation 23 | - **Considerations** 24 | - Loose Coupling 25 | - No Guarantee of Consumption 26 | - Flexibility in Determining Sent 27 | - Verbose 28 | 29 | ## Fire and Forget 30 | - The ViewModel sends the event immediately upon creation, neither the View or ViewModel tracks the event 31 | - **Considerations** 32 | - Loose Coupling 33 | - No Guarantee of Consumption 34 | - No Flexibility Determining Sent 35 | - Low Effort to Implement 36 | 37 | ## Mark on Consume 38 | - The ViewModel maintains the sent event until the View notifies the ViewModel that the event has been handled 39 | - **Considerations** 40 | - Loose Coupling 41 | - Guarantee of Consumption 42 | - Flexibility Determining Sent 43 | - Verbose 44 | 45 | 46 | ## Events as State 47 | - The ViewModel doesn't maintain the idea of events, but instead treats everything as state, the View calls the ViewModel to notify it if state needs changed 48 | - **Considerations** 49 | - Loose Coupling 50 | - Highly Reusable 51 | - Guarantee of Consumption 52 | - Verbose 53 | 54 | 55 | 56 | ### Other Resources 57 | - [Android Developers - UI events](https://developer.android.com/topic/architecture/ui-layer/events) 58 | - [Android SingleLiveEvent Redux with Kotlin Flow](https://proandroiddev.com/android-singleliveevent-redux-with-kotlin-flow-b755c70bb055) 59 | - [ViewModel: One-off event antipatterns](https://medium.com/androiddevelopers/viewmodel-one-off-event-antipatterns-16a1da869b95) 60 | - [Sending ViewModel Events to the UI in Android](https://proandroiddev.com/sending-view-model-events-to-the-ui-eef76bdd632c) 61 | 62 | -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'org.jetbrains.kotlin.android' 4 | } 5 | 6 | android { 7 | namespace 'com.dladukedev.uievents' 8 | compileSdk 33 9 | 10 | defaultConfig { 11 | applicationId "com.dladukedev.uievents" 12 | minSdk 28 13 | targetSdk 33 14 | versionCode 1 15 | versionName "1.0" 16 | 17 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 18 | vectorDrawables { 19 | useSupportLibrary true 20 | } 21 | } 22 | 23 | buildTypes { 24 | release { 25 | minifyEnabled false 26 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 27 | } 28 | } 29 | compileOptions { 30 | sourceCompatibility JavaVersion.VERSION_1_8 31 | targetCompatibility JavaVersion.VERSION_1_8 32 | } 33 | kotlinOptions { 34 | jvmTarget = '1.8' 35 | } 36 | buildFeatures { 37 | compose true 38 | } 39 | composeOptions { 40 | kotlinCompilerExtensionVersion '1.3.2' 41 | } 42 | packagingOptions { 43 | resources { 44 | excludes += '/META-INF/{AL2.0,LGPL2.1}' 45 | } 46 | } 47 | } 48 | 49 | dependencies { 50 | 51 | implementation 'androidx.core:core-ktx:1.9.0' 52 | implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.3.1' 53 | implementation 'androidx.activity:activity-compose:1.5.1' 54 | implementation platform('androidx.compose:compose-bom:2022.10.00') 55 | implementation 'androidx.compose.ui:ui' 56 | implementation 'androidx.compose.ui:ui-graphics' 57 | implementation 'androidx.compose.ui:ui-tooling-preview' 58 | implementation 'androidx.compose.material3:material3' 59 | testImplementation 'junit:junit:4.13.2' 60 | androidTestImplementation 'androidx.test.ext:junit:1.1.5' 61 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1' 62 | androidTestImplementation platform('androidx.compose:compose-bom:2022.10.00') 63 | androidTestImplementation 'androidx.compose.ui:ui-test-junit4' 64 | debugImplementation 'androidx.compose.ui:ui-tooling' 65 | implementation "androidx.navigation:navigation-compose:2.5.3" 66 | debugImplementation 'androidx.compose.ui:ui-test-manifest' 67 | } -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /app/src/androidTest/java/com/dladukedev/uievents/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import androidx.test.ext.junit.runners.AndroidJUnit4 5 | 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | import org.junit.Assert.* 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * See [testing documentation](http://d.android.com/tools/testing). 15 | */ 16 | @RunWith(AndroidJUnit4::class) 17 | class ExampleInstrumentedTest { 18 | @Test 19 | fun useAppContext() { 20 | // Context of the app under test. 21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 22 | assertEquals("com.dladukedev.uievents", appContext.packageName) 23 | } 24 | } -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 15 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents 2 | 3 | import android.os.Bundle 4 | import androidx.activity.ComponentActivity 5 | import androidx.activity.compose.setContent 6 | import androidx.compose.material3.MaterialTheme 7 | import com.dladukedev.uievents.ui.core.Router 8 | 9 | class MainActivity : ComponentActivity() { 10 | override fun onCreate(savedInstanceState: Bundle?) { 11 | super.onCreate(savedInstanceState) 12 | setContent { 13 | MaterialTheme { 14 | Router() 15 | } 16 | } 17 | } 18 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/domain/LogAnalyticsUseCase.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.domain 2 | 3 | import android.util.Log 4 | 5 | interface LogAnalyticsUseCase { 6 | operator fun invoke(message: String) 7 | } 8 | class LogcatLogAnalyticsUseCase: LogAnalyticsUseCase { 9 | override fun invoke(message: String) { 10 | Log.i("Analytics", message) 11 | } 12 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/core/DetailsScreen.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.core 2 | 3 | import androidx.compose.material3.Text 4 | import androidx.compose.runtime.Composable 5 | 6 | @Composable 7 | fun DetailsScreen(id: String) { 8 | Text(text = "Details for id - $id") 9 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/core/EventScreen.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.core 2 | 3 | import androidx.compose.foundation.layout.Column 4 | import androidx.compose.foundation.layout.padding 5 | import androidx.compose.material3.Button 6 | import androidx.compose.material3.ExperimentalMaterial3Api 7 | import androidx.compose.material3.Scaffold 8 | import androidx.compose.material3.SnackbarHost 9 | import androidx.compose.material3.SnackbarHostState 10 | import androidx.compose.material3.Text 11 | import androidx.compose.runtime.Composable 12 | import androidx.compose.ui.Modifier 13 | 14 | @OptIn(ExperimentalMaterial3Api::class) 15 | @Composable 16 | fun EventScreen(snackbarHostState: SnackbarHostState, onDetailsSelected: (Int) -> Unit, onToastRequested: () -> Unit) { 17 | Scaffold(snackbarHost = { SnackbarHost(snackbarHostState) }) { paddingValues -> 18 | Column(modifier = Modifier.padding(paddingValues)) { 19 | Button(onClick = { onDetailsSelected(1) }) { 20 | Text(text = "Go to Details 1") 21 | } 22 | Button(onClick = { onDetailsSelected(2) }) { 23 | Text(text = "Go to Details 2") 24 | } 25 | Button(onClick = { onToastRequested() }) { 26 | Text(text = "Show Snackbar") 27 | } 28 | } 29 | } 30 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/core/HomeScreen.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.core 2 | 3 | import androidx.compose.foundation.layout.Column 4 | import androidx.compose.material3.Button 5 | import androidx.compose.material3.Text 6 | import androidx.compose.runtime.Composable 7 | 8 | @Composable 9 | fun HomeScreen( 10 | onClickCallbacks: () -> Unit, 11 | onClickMarkOnSend: () -> Unit, 12 | onClickFireAndForget: () -> Unit, 13 | onClickMarkOnConsume: () -> Unit, 14 | onClickState: () -> Unit, 15 | ) { 16 | Column { 17 | Button(onClick = onClickCallbacks) { 18 | Text(text = "Callbacks") 19 | } 20 | Button(onClick = onClickMarkOnSend) { 21 | Text(text = "Mark on Send") 22 | } 23 | Button(onClick = onClickFireAndForget) { 24 | Text(text = "Fire and Forget") 25 | } 26 | Button(onClick = onClickMarkOnConsume) { 27 | Text(text = "Mark on Consume") 28 | } 29 | Button(onClick = onClickState) { 30 | Text(text = "State") 31 | } 32 | } 33 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/core/Router.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.core 2 | 3 | import androidx.compose.runtime.Composable 4 | import androidx.navigation.NavHostController 5 | import androidx.navigation.compose.NavHost 6 | import androidx.navigation.compose.composable 7 | import androidx.navigation.compose.rememberNavController 8 | import com.dladukedev.uievents.ui.events.CallbacksScreen 9 | import com.dladukedev.uievents.ui.events.FireAndForgetScreen 10 | import com.dladukedev.uievents.ui.events.MarkOnConsumeScreen 11 | import com.dladukedev.uievents.ui.events.MarkOnSendScreen 12 | import com.dladukedev.uievents.ui.events.StateScreen 13 | 14 | @Composable 15 | fun Router(navHostController: NavHostController = rememberNavController()) { 16 | NavHost(navController = navHostController, startDestination = "home") { 17 | composable(route = "home") { 18 | HomeScreen( 19 | onClickCallbacks = { navHostController.navigate("callbacks") }, 20 | onClickMarkOnSend = { navHostController.navigate("mark-on-send") }, 21 | onClickFireAndForget = { navHostController.navigate("fire-and-forget") }, 22 | onClickMarkOnConsume = { navHostController.navigate("mark-on-consume") }, 23 | onClickState = { navHostController.navigate("state") }) 24 | } 25 | composable(route = "callbacks") { 26 | CallbacksScreen(goToDetails = { id -> navHostController.navigate("details/$id") }) 27 | } 28 | composable(route = "mark-on-send") { 29 | MarkOnSendScreen(goToDetails = { id -> navHostController.navigate("details/$id") }) 30 | } 31 | composable(route = "fire-and-forget") { 32 | FireAndForgetScreen(goToDetails = { id -> navHostController.navigate("details/$id") }) 33 | } 34 | composable(route = "mark-on-consume") { 35 | MarkOnConsumeScreen(goToDetails = { id -> navHostController.navigate("details/$id") }) 36 | } 37 | composable(route = "state") { 38 | StateScreen(goToDetails = { id -> navHostController.navigate("details/$id") }) 39 | } 40 | 41 | composable(route = "details/{id}") { 42 | it.arguments?.getString("id")?.let { id -> 43 | DetailsScreen(id = id) 44 | } 45 | } 46 | } 47 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/events/CallbacksScreen.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.events 2 | 3 | import androidx.compose.material3.SnackbarHostState 4 | import androidx.compose.runtime.Composable 5 | import androidx.compose.runtime.DisposableEffect 6 | import androidx.compose.runtime.remember 7 | import androidx.compose.runtime.rememberCoroutineScope 8 | import androidx.lifecycle.ViewModel 9 | import androidx.lifecycle.viewmodel.compose.viewModel 10 | import com.dladukedev.uievents.domain.LogAnalyticsUseCase 11 | import com.dladukedev.uievents.domain.LogcatLogAnalyticsUseCase 12 | import com.dladukedev.uievents.ui.core.EventScreen 13 | import kotlinx.coroutines.launch 14 | 15 | class CallbacksViewModel( 16 | private val logAnalytics: LogAnalyticsUseCase = LogcatLogAnalyticsUseCase() 17 | ) : ViewModel() { 18 | private var callbacks: Callbacks? = null 19 | 20 | fun onDetailsSelected(detailsId: Int) { 21 | logAnalytics("Selected Details $detailsId") 22 | callbacks?.onDetailsCallback(detailsId) 23 | } 24 | 25 | fun onShowToast() { 26 | logAnalytics("Show Toast") 27 | callbacks?.onShowToastCallback() 28 | } 29 | 30 | fun registerCallbacks(newCallbacks: Callbacks) { 31 | callbacks = newCallbacks 32 | } 33 | 34 | fun unregisterCallbacks() { 35 | callbacks = null 36 | } 37 | 38 | interface Callbacks { 39 | fun onShowToastCallback() 40 | fun onDetailsCallback(id: Int) 41 | } 42 | } 43 | 44 | @Composable 45 | fun CallbacksScreen(goToDetails: (Int) -> Unit, vm: CallbacksViewModel = viewModel()) { 46 | val snackbarHostState = remember { SnackbarHostState() } 47 | val scope = rememberCoroutineScope() 48 | 49 | DisposableEffect(Unit) { 50 | vm.registerCallbacks(object : CallbacksViewModel.Callbacks { 51 | override fun onShowToastCallback() { 52 | scope.launch { snackbarHostState.showSnackbar(message = "Snackbar Test") } 53 | } 54 | 55 | override fun onDetailsCallback(id: Int) { 56 | goToDetails(id) 57 | } 58 | }) 59 | 60 | onDispose { 61 | vm.unregisterCallbacks() 62 | } 63 | } 64 | 65 | EventScreen( 66 | snackbarHostState = snackbarHostState, 67 | onDetailsSelected = vm::onDetailsSelected, 68 | onToastRequested = vm::onShowToast 69 | ) 70 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/events/FireAndForgetScreen.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.events 2 | 3 | import androidx.compose.material3.SnackbarHostState 4 | import androidx.compose.runtime.Composable 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.runtime.remember 7 | import androidx.compose.runtime.rememberCoroutineScope 8 | import androidx.lifecycle.ViewModel 9 | import androidx.lifecycle.viewModelScope 10 | import androidx.lifecycle.viewmodel.compose.viewModel 11 | import com.dladukedev.uievents.domain.LogAnalyticsUseCase 12 | import com.dladukedev.uievents.domain.LogcatLogAnalyticsUseCase 13 | import com.dladukedev.uievents.ui.core.EventScreen 14 | import kotlinx.coroutines.channels.Channel 15 | import kotlinx.coroutines.flow.receiveAsFlow 16 | import kotlinx.coroutines.launch 17 | 18 | class FireAndForgetViewModel ( 19 | private val logAnalytics: LogAnalyticsUseCase = LogcatLogAnalyticsUseCase() 20 | ) : ViewModel() { 21 | private val _events = Channel(Channel.BUFFERED) 22 | val events = _events.receiveAsFlow() 23 | 24 | sealed class Event { 25 | object ShowToast : Event() 26 | data class ShowDetails(val id: Int) : Event() 27 | } 28 | 29 | fun onDetailsSelected(detailsId: Int) { 30 | logAnalytics("Selected Details $detailsId") 31 | viewModelScope.launch { 32 | _events.send(Event.ShowDetails(detailsId)) 33 | } 34 | } 35 | 36 | fun onShowToast() { 37 | logAnalytics("Show Toast") 38 | viewModelScope.launch { 39 | _events.send(Event.ShowToast) 40 | } 41 | } 42 | } 43 | 44 | @Composable 45 | fun FireAndForgetScreen(goToDetails: (Int) -> Unit, vm: FireAndForgetViewModel = viewModel()) { 46 | val snackbarHostState = remember { SnackbarHostState() } 47 | val scope = rememberCoroutineScope() 48 | 49 | LaunchedEffect(key1 = Unit) { 50 | scope.launch { 51 | vm.events.collect { event -> 52 | when (event) { 53 | is FireAndForgetViewModel.Event.ShowDetails -> goToDetails(event.id) 54 | FireAndForgetViewModel.Event.ShowToast -> launch { 55 | snackbarHostState.showSnackbar(message = "Snackbar Test") 56 | } 57 | } 58 | } 59 | } 60 | } 61 | 62 | EventScreen( 63 | snackbarHostState = snackbarHostState, 64 | onDetailsSelected = vm::onDetailsSelected, 65 | onToastRequested = vm::onShowToast 66 | ) 67 | 68 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/events/MarkOnConsumeScreen.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.events 2 | 3 | import androidx.compose.material3.SnackbarHostState 4 | import androidx.compose.runtime.Composable 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.runtime.remember 7 | import androidx.compose.runtime.rememberCoroutineScope 8 | import androidx.lifecycle.ViewModel 9 | import androidx.lifecycle.viewmodel.compose.viewModel 10 | import com.dladukedev.uievents.domain.LogAnalyticsUseCase 11 | import com.dladukedev.uievents.domain.LogcatLogAnalyticsUseCase 12 | import com.dladukedev.uievents.ui.core.EventScreen 13 | import kotlinx.coroutines.flow.MutableStateFlow 14 | import kotlinx.coroutines.flow.asStateFlow 15 | import kotlinx.coroutines.flow.filterNotNull 16 | import kotlinx.coroutines.flow.map 17 | import kotlinx.coroutines.flow.update 18 | import kotlinx.coroutines.launch 19 | import kotlin.random.Random 20 | 21 | class MarkOnConsumeViewModel( 22 | private val logAnalytics: LogAnalyticsUseCase = LogcatLogAnalyticsUseCase() 23 | ) : ViewModel() { 24 | private val _events = MutableStateFlow>(emptyList()) 25 | val events = _events.asStateFlow() 26 | 27 | sealed class Event { 28 | open var eventId: Int? = null 29 | 30 | object ShowToast : Event() 31 | data class ShowDetails(val id: Int) : Event() 32 | } 33 | 34 | fun onDetailsSelected(detailsId: Int) { 35 | logAnalytics("Selected Details $detailsId") 36 | postEvent(Event.ShowDetails(detailsId)) 37 | } 38 | 39 | fun onShowToast() { 40 | logAnalytics("Show Toast") 41 | postEvent(Event.ShowToast) 42 | } 43 | 44 | private fun postEvent(event: Event) { 45 | event.eventId = Random.nextInt() 46 | _events.update { current -> current + event } 47 | } 48 | 49 | fun markEventHandled(event: Event) { 50 | _events.update { current -> 51 | current.filterNot { it.eventId == event.eventId } 52 | } 53 | } 54 | 55 | } 56 | 57 | @Composable 58 | fun MarkOnConsumeScreen(goToDetails: (Int) -> Unit, vm: MarkOnConsumeViewModel = viewModel()) { 59 | val snackbarHostState = remember { SnackbarHostState() } 60 | val scope = rememberCoroutineScope() 61 | 62 | LaunchedEffect(key1 = Unit) { 63 | vm.events 64 | .map { events -> events.firstOrNull() } 65 | .filterNotNull() 66 | .collect { event -> 67 | when (event) { 68 | is MarkOnConsumeViewModel.Event.ShowDetails -> goToDetails(event.id) 69 | MarkOnConsumeViewModel.Event.ShowToast -> scope.launch { 70 | snackbarHostState.showSnackbar(message = "Snackbar Test") 71 | } 72 | } 73 | vm.markEventHandled(event) 74 | } 75 | } 76 | 77 | EventScreen( 78 | snackbarHostState = snackbarHostState, 79 | onDetailsSelected = vm::onDetailsSelected, 80 | onToastRequested = vm::onShowToast 81 | ) 82 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/events/MarkOnSendScreen.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.events 2 | 3 | import androidx.compose.material3.SnackbarHostState 4 | import androidx.compose.runtime.Composable 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.runtime.collectAsState 7 | import androidx.compose.runtime.getValue 8 | import androidx.compose.runtime.remember 9 | import androidx.compose.runtime.rememberCoroutineScope 10 | import androidx.lifecycle.ViewModel 11 | import androidx.lifecycle.viewmodel.compose.viewModel 12 | import com.dladukedev.uievents.domain.LogAnalyticsUseCase 13 | import com.dladukedev.uievents.domain.LogcatLogAnalyticsUseCase 14 | import com.dladukedev.uievents.ui.core.EventScreen 15 | import kotlinx.coroutines.flow.MutableStateFlow 16 | import kotlinx.coroutines.flow.asStateFlow 17 | import kotlinx.coroutines.flow.transform 18 | import kotlinx.coroutines.flow.update 19 | import kotlinx.coroutines.launch 20 | 21 | class MarkOnSendViewModel( 22 | private val logAnalytics: LogAnalyticsUseCase = LogcatLogAnalyticsUseCase() 23 | ) : ViewModel() { 24 | private val _showSnackbarEvent = MutableStateFlow(false) 25 | private val _showDetailsEvent = MutableStateFlow(null) 26 | 27 | val showSnackbarEvent = _showSnackbarEvent.asStateFlow() 28 | .transform { showSnackbar -> 29 | if(showSnackbar) { 30 | _showSnackbarEvent.value = false 31 | emit(true) 32 | } 33 | } 34 | 35 | val showDetailsEvent = _showDetailsEvent.asStateFlow() 36 | .transform {detailsId -> 37 | if(detailsId != null) { 38 | _showDetailsEvent.value = null 39 | emit(detailsId) 40 | } 41 | } 42 | 43 | fun onDetailsSelected(detailsId: Int) { 44 | logAnalytics("Selected Details $detailsId") 45 | _showDetailsEvent.update { detailsId } 46 | } 47 | 48 | fun onShowToast() { 49 | logAnalytics("Show Toast") 50 | _showSnackbarEvent.update { true } 51 | } 52 | } 53 | 54 | @Composable 55 | fun MarkOnSendScreen(goToDetails: (Int) -> Unit, vm: MarkOnSendViewModel = viewModel()) { 56 | val showSnackbar by vm.showSnackbarEvent.collectAsState(false) 57 | val showDetails by vm.showDetailsEvent.collectAsState(null) 58 | 59 | val snackbarHostState = remember { SnackbarHostState() } 60 | val scope = rememberCoroutineScope() 61 | 62 | LaunchedEffect(key1 = showSnackbar) { 63 | if (showSnackbar) { 64 | scope.launch { 65 | snackbarHostState.showSnackbar(message = "Snackbar Test") 66 | } 67 | } 68 | } 69 | LaunchedEffect(key1 = showDetails) { 70 | showDetails?.let { detailsId -> 71 | goToDetails(detailsId) 72 | } 73 | } 74 | 75 | EventScreen( 76 | snackbarHostState = snackbarHostState, 77 | onDetailsSelected = vm::onDetailsSelected, 78 | onToastRequested = vm::onShowToast 79 | ) 80 | } -------------------------------------------------------------------------------- /app/src/main/java/com/dladukedev/uievents/ui/events/StateScreen.kt: -------------------------------------------------------------------------------- 1 | package com.dladukedev.uievents.ui.events 2 | 3 | import androidx.compose.material3.SnackbarHostState 4 | import androidx.compose.runtime.Composable 5 | import androidx.compose.runtime.LaunchedEffect 6 | import androidx.compose.runtime.collectAsState 7 | import androidx.compose.runtime.getValue 8 | import androidx.compose.runtime.remember 9 | import androidx.compose.runtime.rememberCoroutineScope 10 | import androidx.lifecycle.ViewModel 11 | import androidx.lifecycle.viewmodel.compose.viewModel 12 | import com.dladukedev.uievents.domain.LogAnalyticsUseCase 13 | import com.dladukedev.uievents.domain.LogcatLogAnalyticsUseCase 14 | import com.dladukedev.uievents.ui.core.EventScreen 15 | import kotlinx.coroutines.flow.MutableStateFlow 16 | import kotlinx.coroutines.flow.asStateFlow 17 | import kotlinx.coroutines.flow.update 18 | import kotlinx.coroutines.launch 19 | 20 | class StateViewModel( 21 | private val logAnalytics: LogAnalyticsUseCase = LogcatLogAnalyticsUseCase() 22 | ) : ViewModel() { 23 | private val _state = MutableStateFlow(State()) 24 | val state = _state.asStateFlow() 25 | 26 | data class State( 27 | val showToast: Boolean = false, 28 | val selectedDetails: Int? = null, 29 | ) 30 | 31 | fun onDetailsSelected(detailsId: Int) { 32 | logAnalytics("Selected Details $detailsId") 33 | _state.update { current -> current.copy(selectedDetails = detailsId) } 34 | } 35 | 36 | fun onShowToast() { 37 | logAnalytics("Show Toast") 38 | _state.update { current -> current.copy(showToast = true) } 39 | } 40 | 41 | fun unselectDetails() { 42 | _state.update { current -> current.copy(selectedDetails = null) } 43 | } 44 | 45 | fun unshowToast() { 46 | _state.update { current -> current.copy(showToast = false) } 47 | } 48 | } 49 | 50 | @Composable 51 | fun StateScreen(goToDetails: (Int) -> Unit, vm: StateViewModel = viewModel()) { 52 | val state by vm.state.collectAsState() 53 | 54 | val snackbarHostState = remember { SnackbarHostState() } 55 | val scope = rememberCoroutineScope() 56 | 57 | LaunchedEffect(key1 = state) { 58 | val currentState = state 59 | when { 60 | currentState.showToast -> { 61 | scope.launch { 62 | snackbarHostState.showSnackbar(message = "Snackbar Test") 63 | } 64 | vm.unshowToast() 65 | } 66 | 67 | currentState.selectedDetails != null -> { 68 | goToDetails(currentState.selectedDetails) 69 | vm.unselectDetails() 70 | } 71 | } 72 | } 73 | 74 | EventScreen( 75 | snackbarHostState = snackbarHostState, 76 | onDetailsSelected = vm::onDetailsSelected, 77 | onToastRequested = vm::onShowToast 78 | ) 79 | } -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-hdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-mdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-xhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dladukedev/ui-eventing-android-demo/b9a9a306c058418294a5b3542d220504aaea5b4a/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Ui Events 3 | -------------------------------------------------------------------------------- /app/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |