IssueTracker

API Request

Expose the height, or offsetFromBottom of the bottomSheet as part of the bottomSheetState API.

UseCase

Placing content at a certain margin from the top of the bottom sheet. For an example, see the attached screen recording from Google Maps running on an Android emulator. The "Directions" button is placed at a certain margin from the top of the bottom sheet.

Description

BottomSheetState extends SwipeableState and hence we have access to the offset property of SwipeableState. The API docs for offset say:

You should use this state to offset your content accordingly. The recommended way is to use Modifier.offsetPx

When you have a bottom sheet you often want to place some content above the sheet itself (i.e., with a Y coordinate that is less than the offset of the bottom sheet). Modifier.offsetPx is not very convenient because it requires you to take the height of the button into account.

A cleaner and easier way to achieve the same result would be to place the "Directions" button at an offset from the bottom of the screen. There are multiple ways to achieve this depending on how the screen is being built (for example a ConstraintLayout, or simply using a Column adding a Spacer after the "Directions" button etc). However all of these require you to know the height of the bottom sheet (or its offset from the bottom).

There exist 2 work-arounds:

1. We can use Modifier.onGloballyPositioned to keep track of the bottom sheet height ourselves
2. We can use the screen height and subtract the offset from it to obtain the height of the bottom sheet

However both of these are work-arounds. The BottomSheet already maintains its own height and it would make the consumer code much simpler if this was exposed as part of the API.