O3 Framework / useBodyScrollLock
useBodyScrollLock(
active):void
Defined in: packages/framework/esm-react-utils/src/useBodyScrollLock.ts:22
A React hook that prevents scrolling on the document body when active. Useful for modals, overlays, or any full-screen UI that should prevent background scrolling. The original overflow style is restored when the hook becomes inactive or the component unmounts.
boolean
Whether to lock the body scroll. When true, sets
document.body.style.overflow to ‘hidden’.
void
import { useBodyScrollLock } from '@openmrs/esm-framework';
function Modal({ isOpen }) {
useBodyScrollLock(isOpen);
return isOpen ? <div className="modal">...</div> : null;
}