Expose the host's safe area insets in HostConfiguration. #913
Conversation
colinrtwhite
force-pushed
the
colin/safe_area_insets
branch
from
919a7dd
to
c35c6b1
Compare
There was a problem hiding this comment.
I'm okay with moving forward with this as-is for now. The tests and support for all platforms is great!
However, long term, I think we should change the approach to be more like Compose UI. This would mean two things:
- The insets are available as their own composition local within pure Redwood (not Treehouse).
- The insets are consumable rather than static so that they reflect the composables position in the native UI toolkit view hierarchy.
Maybe we can track that in an issue and figure out the right way to do it over time.
redwood-treehouse-host/src/commonMain/kotlin/app/cash/redwood/treehouse/SequentialStateFlow.kt
Outdated
Show resolved
Hide resolved
…treehouse/SequentialStateFlow.kt Co-authored-by: Jake Wharton <[email protected]>
Co-authored-by: Jake Wharton <[email protected]>
| @Composable | ||
| public actual fun safeAreaInsets(): Margin { | ||
| val layoutDirection = LocalLayoutDirection.current | ||
| return WindowInsets.systemBars.asPaddingValues().toMargin(layoutDirection) |
There was a problem hiding this comment.
Probably want to use safeDrawing insets here (link). System bars only contains the nav/status bars, but we also need to handle IME and cutouts.
| // Temporary constructor before migrating everything to doubles. | ||
| @Stable | ||
| public fun Margin( | ||
| left: Double = 0.0, |
There was a problem hiding this comment.
Meta comment: no start/end?
There was a problem hiding this comment.
Yep! Will fix this soon. I changed this to left/right as I'm pretty sure we're not handling LTR properly in some spots.
There was a problem hiding this comment.
For context, there was a bit of a discussion about it here
...ost/src/androidInstrumentedTest/kotlin/app/cash/redwood/treehouse/TreehouseWidgetViewTest.kt
Show resolved
Hide resolved
|
+1 to Jake's comment about making these consumable in the long term. I'm personally not a huge fan of the way that Compose UI exposes this though, but we can work out the mechanics later |
|
Sounds good! I'll file an issue to track better support for this. For the moment this unblocks one of our current screens that needs to know the status bar size to avoid accidentally drawing under it.
Makes sense, though I'm curious what the API would look like for consuming them. Also I think we'll need to avoid applying them as a |
* trunk: Ensure children lambda type returns Unit (#932) Respect event type nullability (#931) Update kotlin monorepo to v1.8.20 (#889) No default for embedded Zipline code (#926) Annotate schema properties, not parameters (#924) Propagate network failures in Emoji Search (#927) Cancel HTTP call on coroutine cancellation in Emoji Search (#928) Remove empty lambda from jvm target declaration (#925) Add LazyListScope#itemsIndexed (#917) Parse and generate deprecations from the schema (#922) Add LazyListScope#items(Array<T>, …) and LazyListScope#itemsIndexed(Array<T>, …) (#918) Add LazyListScope#item (#916) Expose the host's safe area insets in HostConfiguration. (#913) Move LazyListScope to LazyDsl.kt (#915) Update jbCompose to v1.4.0 (#904) Update dependency com.vanniktech:gradle-maven-publish-plugin to v0.25.2 (#914) Update dependency com.android.tools.lint:lint to v31 (#911) Build treehouse-lazylayout-compose on all platforms (#909) Add instructions for building the Counter app for iOS/Android. (#906)
Adds a new
safeAreaInsetsproperty toHostConfiguration. This lets us modify the UI to account for a device's reserved system UI area if necessary. It can be combined with the other layout components like so:Eventually we can add an argument to automatically inset the
TreehouseViewbased on the device's insets, however I opted not to implement that yet as we'll probably need to do it withoutredwood-layoutandSpacer.