@wordpress/components
Version:
UI components for WordPress.
59 lines (58 loc) • 1.79 kB
JavaScript
import { useEffect } from "@wordpress/element";
// packages/components/src/scroll-lock/index.tsx
let previousScrollTop = 0;
function setLocked(locked) {
const scrollingElement = document.scrollingElement || document.body;
if (locked) previousScrollTop = scrollingElement.scrollTop;
const methodName = locked ? "add" : "remove";
scrollingElement.classList[methodName]("lockscroll");
document.documentElement.classList[methodName]("lockscroll");
if (!locked) scrollingElement.scrollTop = previousScrollTop;
}
let lockCounter = 0;
/**
* ScrollLock is a content-free React component for declaratively preventing
* scroll bleed from modal UI to the page body. This component applies a
* `lockscroll` class to the `document.documentElement` and
* `document.scrollingElement` elements to stop the body from scrolling. When it
* is present, the lock is applied.
*
* ```jsx
* import { ScrollLock, Button } from '@wordpress/components';
* import { useState } from '@wordpress/element';
*
* const MyScrollLock = () => {
* const [ isScrollLocked, setIsScrollLocked ] = useState( false );
*
* const toggleLock = () => {
* setIsScrollLocked( ( locked ) => ! locked ) );
* };
*
* return (
* <div>
* <Button variant="secondary" onClick={ toggleLock }>
* Toggle scroll lock
* </Button>
* { isScrollLocked && <ScrollLock /> }
* <p>
* Scroll locked:
* <strong>{ isScrollLocked ? 'Yes' : 'No' }</strong>
* </p>
* </div>
* );
* };
* ```
*/
function ScrollLock() {
useEffect(() => {
if (lockCounter === 0) setLocked(true);
++lockCounter;
return () => {
if (lockCounter === 1) setLocked(false);
--lockCounter;
};
}, []);
return null;
}
export { ScrollLock, ScrollLock as default };
//# sourceMappingURL=index.mjs.map