@wordpress/components
Version:
UI components for WordPress.
1 lines • 2.9 kB
Source Map (JSON)
{"version":3,"file":"index.mjs","names":[],"sources":["../../src/scroll-lock/index.tsx"],"sourcesContent":["import { useEffect } from '@wordpress/element';\n\n/*\n * Setting `overflow: hidden` on html and body elements resets body scroll in iOS.\n * Save scroll top so we can restore it after locking scroll.\n *\n * NOTE: It would be cleaner and possibly safer to find a localized solution such\n * as preventing default on certain touchmove events.\n */\nlet previousScrollTop = 0;\n\nfunction setLocked( locked: boolean ) {\n\tconst scrollingElement = document.scrollingElement || document.body;\n\n\tif ( locked ) {\n\t\tpreviousScrollTop = scrollingElement.scrollTop;\n\t}\n\n\tconst methodName = locked ? 'add' : 'remove';\n\tscrollingElement.classList[ methodName ]( 'lockscroll' );\n\n\t// Adding the class to the document element seems to be necessary in iOS.\n\tdocument.documentElement.classList[ methodName ]( 'lockscroll' );\n\n\tif ( ! locked ) {\n\t\tscrollingElement.scrollTop = previousScrollTop;\n\t}\n}\n\nlet lockCounter = 0;\n\n/**\n * ScrollLock is a content-free React component for declaratively preventing\n * scroll bleed from modal UI to the page body. This component applies a\n * `lockscroll` class to the `document.documentElement` and\n * `document.scrollingElement` elements to stop the body from scrolling. When it\n * is present, the lock is applied.\n *\n * ```jsx\n * import { ScrollLock, Button } from '@wordpress/components';\n * import { useState } from '@wordpress/element';\n *\n * const MyScrollLock = () => {\n * const [ isScrollLocked, setIsScrollLocked ] = useState( false );\n *\n * const toggleLock = () => {\n * setIsScrollLocked( ( locked ) => ! locked ) );\n * };\n *\n * return (\n * <div>\n * <Button variant=\"secondary\" onClick={ toggleLock }>\n * Toggle scroll lock\n * </Button>\n * { isScrollLocked && <ScrollLock /> }\n * <p>\n * Scroll locked:\n * <strong>{ isScrollLocked ? 'Yes' : 'No' }</strong>\n * </p>\n * </div>\n * );\n * };\n * ```\n */\nexport function ScrollLock(): null {\n\tuseEffect( () => {\n\t\tif ( lockCounter === 0 ) {\n\t\t\tsetLocked( true );\n\t\t}\n\n\t\t++lockCounter;\n\n\t\treturn () => {\n\t\t\tif ( lockCounter === 1 ) {\n\t\t\t\tsetLocked( false );\n\t\t\t}\n\n\t\t\t--lockCounter;\n\t\t};\n\t}, [] );\n\n\treturn null;\n}\n\nexport default ScrollLock;\n"],"mappings":";;AASA,IAAI,oBAAoB;AAExB,SAAS,UAAW,QAAkB;CACrC,MAAM,mBAAmB,SAAS,oBAAoB,SAAS;CAE/D,IAAK,QACJ,oBAAoB,iBAAiB;CAGtC,MAAM,aAAa,SAAS,QAAQ;CACpC,iBAAiB,UAAW,WAAY,CAAE,YAAa;CAGvD,SAAS,gBAAgB,UAAW,WAAY,CAAE,YAAa;CAE/D,IAAK,CAAE,QACN,iBAAiB,YAAY;AAE/B;AAEA,IAAI,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmClB,SAAgB,aAAmB;CAClC,gBAAiB;EAChB,IAAK,gBAAgB,GACpB,UAAW,IAAK;EAGjB,EAAE;EAEF,aAAa;GACZ,IAAK,gBAAgB,GACpB,UAAW,KAAM;GAGlB,EAAE;EACH;CACD,GAAG,CAAC,CAAE;CAEN,OAAO;AACR"}