Skip to main content

Dismissable Layer

Handles click-outside and Escape-to-dismiss behavior for overlay components.

import { DismissableLayer, DismissableLayerBranch } from '@gentleduck/primitives/dismissable-layer'
import { DismissableLayer, DismissableLayerBranch } from '@gentleduck/primitives/dismissable-layer'

Props

PropTypeDefaultDescription
onPointerDownOutside(event) => void-Fired on click outside. Call event.preventDefault() to prevent dismiss.
onFocusOutside(event) => void-Fired when focus moves outside
onInteractOutside(event) => void-Fired for any outside interaction
onEscapeKeyDown(event) => void-Fired on Escape press
onDismiss() => void-Called when the layer should be dismissed
disableOutsidePointerEventsbooleanfalseBlock pointer events on elements outside this layer

DismissableLayerBranch