# scroll-locker

**Repository Path**: mirrors_Jam3/scroll-locker

## Basic Information

- **Project Name**: scroll-locker
- **Description**: Lock and unlock scroll on elements or document. Note that disabling scroll on body/document will propagate to all contained elements.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2026-03-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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

## Syntax
```javascript
scrollLocker(element [, disableKeyboardArrowsFlag]);
```

## API
* ```lock``` - disable elemen't scroll
* ```unlock``` - enable elemen't scroll


## Example
```javascript
import scrollLock from 'scroll-locker';

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

...
scroll.unlock();

```

## Install
```sh
npm install scroll-locker --save
``` 

## Test
```sh
npm t
``` 

## License
MIT, see [LICENSE.md](http://github.com/Jam3/scroll-locker/blob/master/LICENSE) for details.