ScrollLock Edit

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.

Usage

Declare scroll locking as part of modal UI.

import { ScrollLock } from '@wordpress/components';
import { withState } from '@wordpress/compose';

const MyScrollLock = withState( {
    isScrollLocked: false,
} )( ( { isScrollLocked, setState } ) => {
    const toggleLock = () => {
        setState( ( state ) => ( { isScrollLocked: ! state.isScrollLocked } ) );
    };
    return (
        <div>
            <Button isSecondary onClick={ toggleLock }>
                Toggle scroll lock
            </Button>
            { isScrollLocked && <ScrollLock /> }
            <p>Scroll locked: <strong>{ isScrollLocked ? 'Yes' : 'No' }</strong></p>
        </div>
    );
} );