docs/components/navigation/BottomSheet

BottomSheet

Mobile bottom sheet overlay.

import { BottomSheet } from '@ybouhjira/hyperkit';

#Playground

Edit the code — the preview recompiles and re-renders as you type.

Live playground
Loading preview…

#Props

PropTypeDefaultDescription
open *booleanWhether the sheet is open.
onOpenChange *(open: boolean) => voidCalled when open state changes (ESC, backdrop click, swipe-down).
snapPointsnumber[]Snap points as a fraction of viewport height (0-1). The sheet sizes to the largest snap. Users can swipe between snaps; swiping below the smallest dismisses. Default: [0.5, 0.9] (half and almost-full).
maxWidthstring'640px'Maximum width in CSS when viewport is wider than 640px. On mobile, the sheet is always full-width.
showHandlebooleantrueShow the drag handle at the top.
swipeToDismissbooleantrueAllow swipe-down gesture to dismiss.
dismissiblebooleantrueClose when the backdrop is clicked or ESC is pressed.
'aria-label'stringAccessible label for the sheet region.
children *JSX.ElementSheet body content.
classstringAdditional CSS class for the sheet content surface.
styleJSX.CSSPropertiesInline styles applied to the sheet content surface.

* required prop.