‏collectAsStateWithLifecycle

Your ViewModel exposes state as a Flow, and your Composable needs to turn that stream into a value Compose can read and react to.

Use collectAsStateWithLifecycle() to collect a StateFlow into Compose state while respecting the screen’s lifecycle. 🔋

Plain collectAsState() keeps collecting even when the app is in the background, wasting work. The lifecycle version pauses instead.

When your screen stops, collection stops too; when it returns to the foreground, collection resumes, saving battery and avoiding pointless updates.

The call returns a State you read with by, giving you a normal value that triggers recomposition whenever the flow emits.

This helper lives in a runtime artifact. Add lifecycle-runtime-compose so the function is available in your Composables.

By default collection is active while at least STARTED. You can lower the threshold, but STARTED is the safe, recommended choice.

It shines with StateFlow, which always holds a current value, so your screen has something to show the instant it appears.

Once collected, branch on the UiState to render loading, success, or error, all driven by the latest emission from your ViewModel.

It frees you from manually starting and cancelling collection. The helper ties the work to composition and lifecycle for you. ✨

For new Compose screens, collectAsStateWithLifecycle() is the recommended way to observe ViewModel state safely and efficiently.

Check why the lifecycle-aware collector is preferred.

Observe ViewModel state with collectAsStateWithLifecycle(): it collects a StateFlow into Compose state, pauses in the background, and is the modern default.