Scrim
Material scrim presentation with passive and dismissible forms while modal state, focus, portals, and stacking remain overlay-owned.
A scrim visually obscures content behind a modal or elevated surface. Scrim deliberately implements only that Material visual/dismiss layer; it is not a complete modal manager.
import { Scrim } from '@m3-ui/ui';
<Scrim />When to use
Use Scrim inside a custom overlay composition when you need the Material obscuring layer and the overlay owner already handles focus, portals, stacking, scroll, and dismissal lifecycle. Prefer Dialog or ModalBottomSheet when their higher-level contracts match the UI.
Passive scrim
Without onDismiss, the scrim is presentation-only and hidden from the accessibility tree. This is appropriate when another control owns dismissal or when the layer is purely visual.
Dismissible scrim
Supplying onDismiss makes the layer an explicit dismissal action and requires an accessible name.
<Scrim aria-label="Dismiss dialog" onDismiss={closeDialog} />The full-screen dismiss action stays out of the normal tab sequence so it does not become an unexpected keyboard stop. The surrounding overlay still owns the actual modal relationship.
Modal ownership boundary
Scrim does not create a portal, trap focus, lock document scroll, handle Escape, restore focus, or choose stacking order. A real modal composition must own those responsibilities.
Do not combine a custom scrim with a second independent modal/focus manager around Dialog or ModalBottomSheet. Those components already own their browser overlay lifecycle.
Styling and animation
containerColor, containerOpacity, and alpha are presentation hooks. alpha can follow an animation progress value without changing whether the surrounding surface is semantically modal or dismissed.
Accessibility
A passive scrim should remain hidden from assistive technology. A dismissible scrim needs a clear action name that identifies the surface it dismisses, while keyboard users must still have an explicit reachable dismissal path within the overlay content.
API reference
Scrim
Material 3 visual scrim primitive. The owner remains responsible for portals, stacking, focus trapping and Escape handling. A dismissible scrim is intentionally removed from the tab order so it does not compete with modal content, while native button semantics keep the dismiss action available to assistive technology.
Scrim({ onDismiss, containerColor, containerOpacity, alpha, className, style, "aria-label": ariaLabel, ...props }: ScrimProps): JSX.ElementProps
| Name | Type | Default | Description | Origin |
|---|---|---|---|---|
alpha | number | undefined | — | Additional renderer alpha multiplied by the generated Material container opacity. | @m3-ui/ui |
aria-label | string | undefined | — | — | @m3-ui/ui |
containerColor | Property.BackgroundColor | undefined | — | — | @m3-ui/ui |
containerOpacity | number | undefined | — | — | @m3-ui/ui |
onDismiss | (() => void) | undefined | — | Accessible action exposed when the scrim dismisses a modal surface. Passive scrims are decorative and expose no click semantics. | @m3-ui/ui |
Inherited React / web props (271)
| 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-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-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<HTMLElement> | undefined | — | — | @types/react |
onAbortCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onAnimationEnd | AnimationEventHandler<HTMLElement> | undefined | — | — | @types/react |
onAnimationEndCapture | AnimationEventHandler<HTMLElement> | undefined | — | — | @types/react |
onAnimationIteration | AnimationEventHandler<HTMLElement> | undefined | — | — | @types/react |
onAnimationIterationCapture | AnimationEventHandler<HTMLElement> | undefined | — | — | @types/react |
onAnimationStart | AnimationEventHandler<HTMLElement> | undefined | — | — | @types/react |
onAnimationStartCapture | AnimationEventHandler<HTMLElement> | undefined | — | — | @types/react |
onAuxClick | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onAuxClickCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onBeforeInput | InputEventHandler<HTMLElement> | undefined | — | — | @types/react |
onBeforeInputCapture | InputEventHandler<HTMLElement> | undefined | — | — | @types/react |
onBeforeToggle | ToggleEventHandler<HTMLElement> | undefined | — | — | @types/react |
onBlur | FocusEventHandler<HTMLElement> | undefined | — | — | @types/react |
onBlurCapture | FocusEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCanPlay | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCanPlayCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCanPlayThrough | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCanPlayThroughCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onChange | ChangeEventHandler<HTMLElement, Element> | undefined | — | — | @types/react |
onChangeCapture | ChangeEventHandler<HTMLElement, Element> | undefined | — | — | @types/react |
onClickCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCompositionEnd | CompositionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCompositionEndCapture | CompositionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCompositionStart | CompositionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCompositionStartCapture | CompositionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCompositionUpdate | CompositionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCompositionUpdateCapture | CompositionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onContextMenu | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onContextMenuCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCopy | ClipboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCopyCapture | ClipboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCut | ClipboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onCutCapture | ClipboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDoubleClick | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDoubleClickCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDrag | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragCapture | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragEnd | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragEndCapture | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragEnter | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragEnterCapture | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragExit | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragExitCapture | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragLeave | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragLeaveCapture | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragOver | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragOverCapture | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragStart | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDragStartCapture | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDrop | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDropCapture | DragEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDurationChange | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onDurationChangeCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onEmptied | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onEmptiedCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onEncrypted | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onEncryptedCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onEnded | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onEndedCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onError | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onErrorCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onFocus | FocusEventHandler<HTMLElement> | undefined | — | — | @types/react |
onFocusCapture | FocusEventHandler<HTMLElement> | undefined | — | — | @types/react |
onGotPointerCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onGotPointerCaptureCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onInput | InputEventHandler<HTMLElement> | undefined | — | — | @types/react |
onInputCapture | InputEventHandler<HTMLElement> | undefined | — | — | @types/react |
onInvalid | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onInvalidCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onKeyDown | KeyboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onKeyDownCapture | KeyboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onKeyPress | KeyboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onKeyPressCapture | KeyboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onKeyUp | KeyboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onKeyUpCapture | KeyboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLoad | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLoadCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLoadedData | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLoadedDataCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLoadedMetadata | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLoadedMetadataCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLoadStart | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLoadStartCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLostPointerCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onLostPointerCaptureCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseDown | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseDownCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseEnter | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseLeave | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseMove | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseMoveCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseOut | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseOutCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseOver | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseOverCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseUp | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onMouseUpCapture | MouseEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPaste | ClipboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPasteCapture | ClipboardEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPause | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPauseCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPlay | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPlayCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPlaying | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPlayingCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerCancel | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerCancelCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerDown | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerDownCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerEnter | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerLeave | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerMove | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerMoveCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerOut | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerOutCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerOver | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerOverCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerUp | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onPointerUpCapture | PointerEventHandler<HTMLElement> | undefined | — | — | @types/react |
onProgress | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onProgressCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onRateChange | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onRateChangeCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onReset | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onResetCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onScroll | UIEventHandler<HTMLElement> | undefined | — | — | @types/react |
onScrollCapture | UIEventHandler<HTMLElement> | undefined | — | — | @types/react |
onScrollEnd | UIEventHandler<HTMLElement> | undefined | — | — | @types/react |
onScrollEndCapture | UIEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSeeked | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSeekedCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSeeking | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSeekingCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSelect | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSelectCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onStalled | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onStalledCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSubmit | SubmitEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSubmitCapture | SubmitEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSuspend | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onSuspendCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTimeUpdate | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTimeUpdateCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onToggle | ToggleEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTouchCancel | TouchEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTouchCancelCapture | TouchEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTouchEnd | TouchEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTouchEndCapture | TouchEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTouchMove | TouchEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTouchMoveCapture | TouchEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTouchStart | TouchEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTouchStartCapture | TouchEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTransitionCancel | TransitionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTransitionCancelCapture | TransitionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTransitionEnd | TransitionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTransitionEndCapture | TransitionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTransitionRun | TransitionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTransitionRunCapture | TransitionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTransitionStart | TransitionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onTransitionStartCapture | TransitionEventHandler<HTMLElement> | undefined | — | — | @types/react |
onVolumeChange | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onVolumeChangeCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onWaiting | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onWaitingCapture | ReactEventHandler<HTMLElement> | undefined | — | — | @types/react |
onWheel | WheelEventHandler<HTMLElement> | undefined | — | — | @types/react |
onWheelCapture | WheelEventHandler<HTMLElement> | 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 |
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 |
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/Scrim/Scrim.tsx:42
Material fidelity and web adaptation
- Family
- Scrim
- Provenance
- compose: Compose Material3 contract · web: Browser and React Aria semantics · adaptation: m3-ui web adaptation
- Compose mapping
- Scrim · ScrimDefaults
- Visual fidelity
- partial: Legacy visual fidelity has not received an explicit reviewed disposition. Current implementation evidence: Implements the token-backed Material scrim color and alpha contract in passive and dismissible forms. The primitive only renders the obscuring layer and optional dismissal action.
- Behavior fidelity
- adapted: A passive scrim is aria-hidden. Supplying onDismiss renders a native button with an accessible name, but the scrim still does not own a portal, focus trap, Escape handling, modal state, or stacking policy; those belong to the surrounding overlay composition.
- Semantics fidelity
- adapted: A passive scrim is aria-hidden. Supplying onDismiss renders a native button with an accessible name, but the scrim still does not own a portal, focus trap, Escape handling, modal state, or stacking policy; those belong to the surrounding overlay composition.
- Adaptations
- A passive scrim is aria-hidden. Supplying onDismiss renders a native button with an accessible name, but the scrim still does not own a portal, focus trap, Escape handling, modal state, or stacking policy; those belong to the surrounding overlay composition.
Material supplies scrim color/opacity and obscuring-layer intent. Optional native button-style dismissal is a web interaction adaptation; portal, focus containment, Escape, scroll lock, restoration, and z-index remain the overlay owner's responsibility.
Related components
- Dialog — complete browser modal dialog composition.
- Bottom sheets — modal and non-modal sheet surfaces.
- Surface — general Material surface composition.