Skip to main content

useModalWithoutPreventScroll

function useModalWithoutPreventScroll(isOpen): object;

Alternative to useModal that does not use useModalOverlay.

Provides modal behavior (focus trapping, outside interaction blocking, dismiss handling) without preventing scroll. This is useful on mobile Safari where usePreventScroll (used in implementation of useModalOverlay) causes the virtual keyboard to cover focused inputs.

Parameters

ParameterType
isOpenboolean

Returns

object

NameTypeDefault value
refRefObject<HTMLDivElement | null>-
modalPropsDOMAttributes<FocusableElement>overlayProps