Skip to content

Readme resizeWithCollapse update #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
flaringapp merged 1 commit into from
May 30, 2026
Merged

Readme resizeWithCollapse update #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,15 @@ CollapsingTopBarScaffold(
)
```

In some cases you may want a direct body child to resize together with collapse instead of using
the default fixed measurement strategy. For those cases, `CollapsingTopBarScaffold()` exposes
`CollapsingTopBarScaffoldBodyScope.resizeWithCollapse()`:
If a direct body child must resize together with collapse, `CollapsingTopBarScaffold()` has
`Modifier.resizeWithCollapse()`. Use it only as a targeted override: it causes body remeasurement
during collapse, so the default fixed measurement strategy remains preferred for scrollable content.

<details>
<summary>Resize a body child with collapse</summary>

Use `resizeWithCollapse()` for lightweight direct body children such as overlays or panels that
must track the currently visible body height.

```kotlin
CollapsingTopBarScaffold(
Expand All @@ -85,10 +91,7 @@ CollapsingTopBarScaffold(
)
```

Use `resizeWithCollapse()` as a targeted override, typically for lightweight direct children such
as overlays or panels that must track the currently visible body height. It may increase
remeasurement cost during collapse, so the default scaffold behavior remains the preferred choice
for scrollable content.
</details>

`CollapsingTopBarScaffold()` is flexible enough to cover a variety of use cases. However, there's
some extra room for customization: you can use `CollapsingTopBar()` as the actual collapsing header,
Expand Down
Loading