summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Stillwell <mjs@beebo.org>2024-04-17 10:00:50 +0100
committerGitHub <noreply@github.com>2024-04-17 10:00:50 +0100
commit1f1cab1c5e670858b2719bc6c1978b3e04da5ed3 (patch)
treef037f52c6781d11007b0415c776fa5270205f614
parent6ab03f29120309e3277e7268264dca8889c3819a (diff)
downloadhorologist-1f1cab1c5e670858b2719bc6c1978b3e04da5ed3.tar.gz
Expand on description of AmbientAware parameter (#2195)
-rw-r--r--docs/compose-layout.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/compose-layout.md b/docs/compose-layout.md
index 72b92f23..304c66ed 100644
--- a/docs/compose-layout.md
+++ b/docs/compose-layout.md
@@ -124,8 +124,10 @@ fun WearApp() {
}
```
-If you need some screens to use always-on, and others not to, then you can use the additional
-argument supplied to `AmbientAware`.
+If you need some screens to use always-on, and others not to, then you can use
+the additional argument supplied to `AmbientAware` to indicate whether a
+recomposition should be triggered when the system goes into ambient mode (i.e.
+whether the composable wants to handle ambient mode or not).
For example, in a workout app, it is desirable that the main workout screen uses always-on, but the
workout summary at the end does not. See the [`ExerciseClient`][exercise-client]