Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 638 Bytes

README.md

File metadata and controls

37 lines (27 loc) · 638 Bytes

Lock and unlock scroll on elements or document. Note that disabling scroll on body/document will propagate to all contained elements.

Syntax

scrollLocker(element [, disableKeyboardArrowsFlag]);

API

  • lock - disable elemen't scroll
  • unlock - enable elemen't scroll

Example

import scrollLock from 'scroll-locker';

const scroll = scrollLock(container);
scroll.lock();

...
scroll.unlock();

Install

npm install scroll-locker --save

Test

npm t

License

MIT, see LICENSE.md for details.