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

PropTypeDescription
onPointerDownOutside(event) => voidFired on click outside. Call event.preventDefault() to prevent dismiss.
onFocusOutside(event) => voidFired when focus moves outside
onInteractOutside(event) => voidFired for any outside interaction
onEscapeKeyDown(event) => voidFired on Escape press
onDismiss() => voidCalled when the layer should be dismissed
disableOutsidePointerEventsbooleanBlock pointer events on elements outside this layer

DismissableLayerBranch