Skip to content

docs(mobile): document the bottom sheet fit detent #594

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

Open
jubianchi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(mobile): document the bottom sheet fit detent #594

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
34 changes: 34 additions & 0 deletions resources/views/docs/mobile/4/edge-components/bottom-sheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Per Material 3, the container color resolves from `theme.surface`. For a custom
- `medium`
- `large`
- `full` (100% of screen)
- `fit` (exactly as tall as the sheet's content, measured on the device and capped at `large`)
- A numeric fraction `0.0`–`1.0` for a custom height (e.g. `"0.4"` for 40%)
- `a11y-label` - Accessibility label (optional)
- `a11y-hint` - Accessibility hint (optional)
Expand Down Expand Up @@ -136,6 +137,39 @@ Accepts any EDGE elements as children. The children are rendered inside the shee
```
@endverbatim

### Fit to content

Your PHP code doesn't know the screen's height, so a fraction can't size a sheet to its content. Use `fit` instead:
the sheet is measured on the device and opens exactly as tall as its content, capped at `large`.

@verbatim
```blade
@php $showConfirm = false; @endphp

<native:column class="w-full gap-3 items-start">
<native:button label="Delete" @press="$showConfirm = true" />

<native:bottom-sheet :visible="$showConfirm" @dismiss="$showConfirm = false" detents="fit">
<native:column class="w-full p-4 gap-3 pb-8">
<native:text class="text-xl font-bold text-theme-on-surface-variant">Delete this item?</native:text>
<native:text class="text-base text-theme-on-surface-variant">This can't be undone.</native:text>
<native:button label="Delete" @press="$showConfirm = false" />
</native:column>
</native:bottom-sheet>
</native:column>
```
@endverbatim

On iOS, `fit` combines with the other detents: `detents="fit,large"` opens at the content's height and drags up to
`large`. The sheet also follows its content's height when it changes.

<aside>

Android's sheet only has a fixed half-screen partial stop, so a `fit` sheet opens at its content's height there and
ignores the other detents listed beside it.

</aside>

<aside>

Always handle the `@dismiss` event to update your component state. If you don't, the `visible` property will be out
Expand Down