StateFlow in Kotlin
On this page (12sections)
Introduction
StateFlow is a fundamental concept every Kotlin developer should understand. Flow streams values over time, similar to RxJava observables but with structured concurrency and coroutine integration.
StateFlow holds and emits latest state to collectors. In this tutorial you will learn the syntax, walk through a complete example program, study the sample output, and review best practices so you can apply the concept confidently in your own projects.
Definition
- StateFlow holds and emits latest state to collectors.
- It is hot flow with current value access through .value.
- Widely used for UI state in Android.
Syntax
MutableStateFlow(initial)
StateFlow in Kotlin Example Program in Kotlin
import kotlinx.coroutines.*
import kotlinx.coroutines.flow.*
fun main(args: Array<String>) = runBlocking {
val state = MutableStateFlow("Idle")
state.value = "Loading"
state.value = "Success"
println(state.value)
}
Sample Output
Success
When to use
Use Flow for streams of values over time — sensor readings, paginated API pages, or search-as-you-type results.
How it works
-
The program starts with a
mainfunction — the entry point that runs when you execute the file. -
val state = MutableStateFlow("Idle")assigns or updates a value used later in the program. -
state.value = "Loading"assigns or updates a value used later in the program. -
state.value = "Success"assigns or updates a value used later in the program. -
The
println(state.value)statement writes a line to the console — this produces part of the sample output below. -
StateFlow holds and emits latest state to collectors.
-
Run the program in IntelliJ IDEA, Android Studio, or with the Kotlin command-line compiler (
kotlinc/kotlin). Compare your console output with the sample output shown below.
Best Practices
- Understand the core idea: stateFlow holds and emits latest state to collectors.
- Prefer readable names and small functions so examples map directly to real projects.
- Run and modify the example — change values and observe how the output changes.
Common Mistakes
- Skipping the example and only reading the definition — hands-on practice cements the concept.
- Copying syntax without understanding nullable vs non-nullable types or scope rules.
- Ignoring compiler warnings that often point to safer alternatives.
Key Points
- StateFlow holds and emits latest state to collectors.
- It is hot flow with current value access through .value.
- Widely used for UI state in Android.
- Test the example locally and verify the output matches the sample.
- Experiment by changing input values to see how behaviour changes.
Notes
- Add the
kotlinx-coroutines-coredependency when running coroutine examples outside Android or IntelliJ. - Semicolons at the end of statements are optional in Kotlin.
Frequently Asked Questions
What is StateFlow in Kotlin?
When should I use StateFlow?
How is StateFlow different from Java?
How do I practice this topic?
Related Tutorials
Flow Operators in Kotlin
Learn Flow Operators in Kotlin with clear explanation, syntax, example program, sample output, best practices, and FAQs.
Read tutorialSharedFlow in Kotlin
Learn SharedFlow in Kotlin with clear explanation, syntax, example program, sample output, best practices, and FAQs.
Read tutorial