Bottom sheet scaffold
Public Material 3 BottomSheetScaffold composition with persistent sheet state, Scaffold-owned screen chrome, and explicit non-modal web behavior.
BottomSheetScaffold is the public application-scaffold composition for a persistent Material bottom sheet that shares the screen with main content. It combines the existing Scaffold, BottomSheet, and SheetState contracts rather than introducing a second sheet implementation.
The scaffold is intentionally non-modal. Main content remains part of the local composition and is not placed behind a modal focus scope or dismissing scrim.
import { BottomSheetScaffold } from '@m3-ui/ui';
<BottomSheetScaffold
sheetContent={<QueueDetails />}
topBar={<AppTopBar />}
>
<PlayerContent />
</BottomSheetScaffold>When to use
Use BottomSheetScaffold when a screen needs persistent supplemental content that can move between a partially expanded and expanded sheet state while the application body remains available.
Use BottomSheet directly when the sheet belongs to a smaller local composition and you do not need screen-scaffold coordination. Use ModalBottomSheet when the sheet should own a modal overlay, focus containment, outside dismissal, and modal background treatment.
Do not use this scaffold as an adaptive pane/navigation system. Window-size policy, pane allocation, and navigation-surface selection belong to the Adaptive layout guide.
Screen composition
BottomSheetScaffold forwards screen-level slots such as topBar and snackbarHost into the shared Scaffold. The sheet is layered above that screen content while the body remains in the same application composition.
The scaffold reserves the sheet's partial/peek region at the block end of scrollable body content so ordinary content is not hidden behind the persistent sheet edge. The current visible sheet height also moves the scaffold-owned snackbar host above the settled sheet edge.
Those are layout responsibilities of this composition. The application still owns its content hierarchy, routing, and any nested scroll behavior inside body or sheet content.
Sheet state
The scaffold reuses the public SheetState model from the bottom-sheet family. With the default internal state, the persistent sheet starts in its partially expanded presentation and supports the enabled persistent states.
Provide a state when application logic needs explicit control:
import {
BottomSheetScaffold,
SheetValue,
useSheetState,
} from '@m3-ui/ui';
function DetailsScreen() {
const sheetState = useSheetState({
enabledValues: [SheetValue.PartiallyExpanded, SheetValue.Expanded],
initialValue: SheetValue.PartiallyExpanded,
});
return (
<BottomSheetScaffold
state={sheetState}
sheetContent={<Details />}
>
<Content />
</BottomSheetScaffold>
);
}Use the same public state operations documented by the bottom-sheet family, such as expansion or partial expansion, rather than keeping a second boolean that can drift from the actual sheet state.
Peek height and sheet sizing
peekHeight controls the visible sheet height associated with the partially expanded scaffold state. maxSheetWidth constrains the sheet's inline size. These are scaffold/sheet geometry inputs; they do not create window-size breakpoints.
The canonical default geometry remains owned by the component implementation and generated token/runtime evidence rather than copied into this guide as a second numeric specification.
Swipe and drag-handle behavior
Pointer swiping can be disabled with isSwipeEnabled without disabling programmatic state transitions or the standard handle action. dragHandle can replace the standard handle or be set to null when a product intentionally removes it.
The scaffold delegates settling, anchors, drag behavior, and sheet accessibility semantics to the same BottomSheet/SheetState engine used by the standalone component.
Insets and app content
The embedded Scaffold remains responsible for screen chrome and safe-area behavior. BottomSheetScaffold adds the persistent sheet reservation on top of that composition instead of redefining global window insets.
If application content introduces another nested inset-aware scaffold, continue to follow the normal Scaffold consumed-inset rules. Do not compensate for the sheet with hard-coded page padding outside the scaffold unless the application intentionally overrides the composition.
Accessibility
Because this scaffold is non-modal, main application content remains available to keyboard and assistive-technology users. The sheet must therefore be treated as a persistent complementary surface, not as a dialog that temporarily makes the rest of the screen inert.
BottomSheet owns its handle and state semantics. Interactive controls inside sheetContent keep their own native/React Aria semantics. Give the sheet content a clear heading or local structure when users need context for what the persistent surface contains.
If your interaction requires focus containment, modal outside dismissal, or a scrim that blocks interaction with the body, use ModalBottomSheet instead of layering those behaviors manually onto BottomSheetScaffold.
API reference
BottomSheetScaffold
Material 3 standard/persistent bottom-sheet scaffold. BottomSheet and SheetState remain the owners of drag settling, anchors and accessibility semantics. This composition supplies AndroidX's explicit peek-height anchor and positions Scaffold content/snackbars around the persistent sheet. It intentionally does not create modal focus containment or a second state model.
BottomSheetScaffold({ sheetContent, children, topBar, snackbarHost, state, peekHeight, maxSheetWidth, isSwipeEnabled, dragHandle, containerColor, contentColor, sheetContainerColor, sheetContentColor, sheetStyle, sheetClassName, className, style, ...props }: BottomSheetScaffoldProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
children | ReactNode | — | Main screen content. | @m3-ui/ui |
containerColor | Property.BackgroundColor | undefined | — | Scaffold container color. | @m3-ui/ui |
contentColor | Property.Color | undefined | — | Scaffold content color. | @m3-ui/ui |
dragHandle | ReactNode | — | Replace the standard drag handle; pass null to remove it. | @m3-ui/ui |
isSwipeEnabled | boolean | undefined | true | Disables pointer swiping without disabling handle/programmatic state changes. | @m3-ui/ui |
maxSheetWidth | Property.MaxWidth<string | number> | undefined | bottomSheetScaffoldDefaults.maxSheetWidth | Maximum inline size of the sheet. | @m3-ui/ui |
peekHeight | number | undefined | bottomSheetScaffoldDefaults.peekHeight | Visible sheet height while partially expanded, in CSS pixels. | @m3-ui/ui |
sheetClassName | string | undefined | — | Class name applied to the BottomSheet itself. | @m3-ui/ui |
sheetContainerColor | Property.BackgroundColor | undefined | — | Bottom sheet container color. | @m3-ui/ui |
sheetContent* | ReactNode | — | Persistent sheet content rendered alongside the main body. | @m3-ui/ui |
sheetContentColor | Property.Color | undefined | — | Bottom sheet content color. | @m3-ui/ui |
sheetStyle | CSSProperties | undefined | — | Styles applied to the BottomSheet itself. | @m3-ui/ui |
snackbarHost | ReactNode | — | Optional snackbar host; it tracks the current settled sheet edge. | @m3-ui/ui |
state | SheetState | undefined | — | Reuses the standard BottomSheet SheetState controller. | @m3-ui/ui |
topBar | ReactNode | — | Optional app bar passed through to Scaffold. | @m3-ui/ui |
Inherited React / web props (276)
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
about | string | undefined | — | — | @types/react |
accessKey | string | undefined | — | — | @types/react |
aria-activedescendant | string | undefined | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | @types/react |
aria-atomic | Booleanish | undefined | — | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | @types/react |
aria-autocomplete | "none" | "list" | "inline" | "both" | undefined | — | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | @types/react |
aria-braillelabel | string | undefined | — | Defines a string value that labels the current element, which is intended to be converted into Braille. | @types/react |
aria-brailleroledescription | string | undefined | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. | @types/react |
aria-busy | Booleanish | undefined | — | — | @types/react |
aria-checked | boolean | "true" | "false" | "mixed" | undefined | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | @types/react |
aria-colcount | number | undefined | — | Defines the total number of columns in a table, grid, or treegrid. | @types/react |
aria-colindex | number | undefined | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | @types/react |
aria-colindextext | string | undefined | — | Defines a human readable text alternative of aria-colindex. | @types/react |
aria-colspan | number | undefined | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | @types/react |
aria-controls | string | undefined | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. | @types/react |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined | — | Indicates the element that represents the current item within a container or set of related elements. | @types/react |
aria-describedby | string | undefined | — | Identifies the element (or elements) that describes the object. | @types/react |
aria-description | string | undefined | — | Defines a string value that describes or annotates the current element. | @types/react |
aria-details | string | undefined | — | Identifies the element that provides a detailed, extended description for the object. | @types/react |
aria-disabled | Booleanish | undefined | — | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | @types/react |
aria-dropeffect | "none" | "link" | "copy" | "execute" | "move" | "popup" | undefined | — | Indicates what functions can be performed when a dragged object is released on the drop target. | @types/react |
aria-errormessage | string | undefined | — | Identifies the element that provides an error message for the object. | @types/react |
aria-expanded | Booleanish | undefined | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | @types/react |
aria-flowto | string | undefined | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | @types/react |
aria-grabbed | Booleanish | undefined | — | Indicates an element's "grabbed" state in a drag-and-drop operation. | @types/react |
aria-haspopup | boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | @types/react |
aria-hidden | Booleanish | undefined | — | Indicates whether the element is exposed to an accessibility API. | @types/react |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | undefined | — | Indicates the entered value does not conform to the format expected by the application. | @types/react |
aria-keyshortcuts | string | undefined | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | @types/react |
aria-label | string | undefined | — | Defines a string value that labels the current element. | @types/react |
aria-labelledby | string | undefined | — | Identifies the element (or elements) that labels the current element. | @types/react |
aria-level | number | undefined | — | Defines the hierarchical level of an element within a structure. | @types/react |
aria-live | "off" | "assertive" | "polite" | undefined | — | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | @types/react |
aria-modal | Booleanish | undefined | — | Indicates whether an element is modal when displayed. | @types/react |
aria-multiline | Booleanish | undefined | — | Indicates whether a text box accepts multiple lines of input or only a single line. | @types/react |
aria-multiselectable | Booleanish | undefined | — | Indicates that the user may select more than one item from the current selectable descendants. | @types/react |
aria-orientation | "horizontal" | "vertical" | undefined | — | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | @types/react |
aria-owns | string | undefined | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | @types/react |
aria-placeholder | string | undefined | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | @types/react |
aria-posinset | number | undefined | — | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | @types/react |
aria-pressed | boolean | "true" | "false" | "mixed" | undefined | — | Indicates the current "pressed" state of toggle buttons. | @types/react |
aria-readonly | Booleanish | undefined | — | Indicates that the element is not editable, but is otherwise operable. | @types/react |
aria-relevant | "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined | — | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | @types/react |
aria-required | Booleanish | undefined | — | Indicates that user input is required on the element before a form may be submitted. | @types/react |
aria-roledescription | string | undefined | — | Defines a human-readable, author-localized description for the role of an element. | @types/react |
aria-rowcount | number | undefined | — | Defines the total number of rows in a table, grid, or treegrid. | @types/react |
aria-rowindex | number | undefined | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | @types/react |
aria-rowindextext | string | undefined | — | Defines a human readable text alternative of aria-rowindex. | @types/react |
aria-rowspan | number | undefined | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | @types/react |
aria-selected | Booleanish | undefined | — | Indicates the current "selected" state of various widgets. | @types/react |
aria-setsize | number | undefined | — | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | @types/react |
aria-sort | "none" | "ascending" | "descending" | "other" | undefined | — | Indicates if items in a table or grid are sorted in ascending or descending order. | @types/react |
aria-valuemax | number | undefined | — | Defines the maximum allowed value for a range widget. | @types/react |
aria-valuemin | number | undefined | — | Defines the minimum allowed value for a range widget. | @types/react |
aria-valuenow | number | undefined | — | Defines the current value for a range widget. | @types/react |
aria-valuetext | string | undefined | — | Defines the human readable text alternative of aria-valuenow for a range widget. | @types/react |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | undefined | — | — | @types/react |
autoCorrect | string | undefined | — | — | @types/react |
autoFocus | boolean | undefined | — | — | @types/react |
autoSave | string | undefined | — | — | @types/react |
className | string | undefined | — | — | @types/react |
content | string | undefined | — | — | @types/react |
contentEditable | "inherit" | Booleanish | "plaintext-only" | undefined | — | — | @types/react |
contextMenu | string | undefined | — | — | @types/react |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | undefined | — | — | @types/react |
datatype | string | undefined | — | — | @types/react |
defaultChecked | boolean | undefined | — | — | @types/react |
defaultValue | string | number | readonly string[] | undefined | — | — | @types/react |
dir | string | undefined | — | — | @types/react |
draggable | Booleanish | undefined | — | — | @types/react |
enterKeyHint | "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined | — | — | @types/react |
exportparts | string | undefined | — | — | @types/react |
hidden | boolean | undefined | — | — | @types/react |
id | string | undefined | — | — | @types/react |
inert | boolean | undefined | — | — | @types/react |
inlist | any | — | — | @types/react |
inputMode | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined | — | Hints at the type of data that might be entered by the user while editing the element or its contents | @types/react |
is | string | undefined | — | Specify that a standard HTML element should behave like a defined custom built-in element | @types/react |
itemID | string | undefined | — | — | @types/react |
itemProp | string | undefined | — | — | @types/react |
itemRef | string | undefined | — | — | @types/react |
itemScope | boolean | undefined | — | — | @types/react |
itemType | string | undefined | — | — | @types/react |
lang | string | undefined | — | — | @types/react |
nonce | string | undefined | — | — | @types/react |
onAbort | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAbortCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAuxClick | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBeforeInput | InputEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBeforeInputCapture | InputEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBlur | FocusEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onBlurCapture | FocusEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCanPlay | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onChange | ChangeEventHandler<HTMLDivElement, Element> | undefined | — | — | @types/react |
onChangeCapture | ChangeEventHandler<HTMLDivElement, Element> | undefined | — | — | @types/react |
onClick | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onClickCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onContextMenu | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCopy | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCut | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDoubleClick | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDrag | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragEnd | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragEndCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragEnter | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragExit | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragExitCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragLeave | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragOver | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragOverCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragStart | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDragStartCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDrop | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDropCapture | DragEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDurationChange | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEmptied | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEncrypted | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEnded | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onEndedCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onError | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onErrorCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onFocus | FocusEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onFocusCapture | FocusEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onInput | InputEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onInputCapture | InputEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onInvalid | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onInvalidCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoad | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadedData | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadStart | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseDown | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseEnter | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseLeave | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseMove | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseOut | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseOver | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseUp | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPaste | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPause | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPauseCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPlay | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPlayCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPlaying | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerCancel | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerDown | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerEnter | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerLeave | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerMove | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerOut | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerOver | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerUp | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onProgress | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onProgressCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onRateChange | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onReset | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onResetCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onScroll | UIEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onScrollCapture | UIEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onScrollEnd | UIEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onScrollEndCapture | UIEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSeeked | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSeeking | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSelect | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSelectCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onStalled | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onStalledCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSubmit | SubmitEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSubmitCapture | SubmitEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSuspend | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onToggle | ToggleEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchCancel | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchEnd | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchMove | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchStart | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onVolumeChange | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onWaiting | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onWheel | WheelEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
onWheelCapture | WheelEventHandler<HTMLDivElement> | undefined | — | — | @types/react |
part | string | undefined | — | — | @types/react |
popover | "" | "auto" | "manual" | "hint" | undefined | — | — | @types/react |
popoverTarget | string | undefined | — | — | @types/react |
popoverTargetAction | "toggle" | "show" | "hide" | undefined | — | — | @types/react |
prefix | string | undefined | — | — | @types/react |
property | string | undefined | — | — | @types/react |
radioGroup | string | undefined | — | — | @types/react |
rel | string | undefined | — | — | @types/react |
resource | string | undefined | — | — | @types/react |
results | number | undefined | — | — | @types/react |
rev | string | undefined | — | — | @types/react |
role | AriaRole | undefined | — | — | @types/react |
security | string | undefined | — | — | @types/react |
slot | string | undefined | — | — | @types/react |
spellCheck | Booleanish | undefined | — | — | @types/react |
style | CSSProperties | undefined | — | — | @types/react |
suppressContentEditableWarning | boolean | undefined | — | — | @types/react |
suppressHydrationWarning | boolean | undefined | — | — | @types/react |
tabIndex | number | undefined | — | — | @types/react |
title | string | undefined | — | — | @types/react |
translate | "yes" | "no" | undefined | — | — | @types/react |
typeof | string | undefined | — | — | @types/react |
unselectable | "off" | "on" | undefined | — | — | @types/react |
vocab | string | undefined | — | — | @types/react |
Source: packages/ui/src/components/BottomSheetScaffold/BottomSheetScaffold.tsx:109
Material fidelity and web adaptation
AndroidX Material3 BottomSheetScaffold is the reference evidence for the persistent sheet/scaffold composition and explicit peek-height relationship. m3-ui maps that model to the browser by composing its existing Scaffold, BottomSheet, and SheetState APIs.
Browser scroll containers, CSS safe areas, focus behavior, and ResizeObserver-backed geometry are implementation mechanisms. They do not change the Material distinction between a persistent scaffold sheet and a modal bottom sheet.
Related components
- Bottom sheet — standalone non-modal and modal sheet surfaces plus shared
SheetState. - Scrim — visual overlay primitive; not required for this non-modal scaffold.
- Adaptive layout and navigation — window-level scaffold, pane, and navigation policy.