useScrollLock
Lock scrolling of the element.
Examples
Basic Usage
State：Lock
Lorem ipsum dolor sit amet, consectetur adipisicing elit. A aspernatur atque, debitis ex excepturi explicabo iste iure labore molestiae neque optio perspiciatis
Aspernatur cupiditate, deleniti id incidunt mollitia omnis! A aspernatur assumenda consequuntur culpa cumque dignissimos enim eos, et fugit natus nemo nesciunt
Alias aut deserunt expedita, inventore maiores minima officia porro rem. Accusamus ducimus magni modi mollitia nihil nisi provident
Alias aut autem consequuntur doloremque esse facilis id molestiae neque officia placeat, quia quisquam repellendus reprehenderit.
Adipisci blanditiis facere nam perspiciatis sit soluta ullam! Architecto aut blanditiis, consectetur corporis cum deserunt distinctio dolore eius est exercitationem
Ab aliquid asperiores assumenda corporis cumque dolorum expedita
Culpa cumque eveniet natus totam! Adipisci, animi at commodi delectus distinctio dolore earum, eum expedita facilis
Quod sit, temporibus! Amet animi fugit officiis perspiciatis, quis unde. Cumque dignissimos distinctio, dolor eaque est fugit nisi non pariatur porro possimus, quas quasi
Basic Usage
Lock scrolling of the element.
API
const [isLocked, setLock] = useScrollLock( target: Element | Document | (() => Element), initialValue?: boolean,);
const [isLocked, setLock] = useScrollLock( target: Element | Document | (() => Element), initialValue?: boolean,);
Params
| Property | Description | Type | Default |
|---|---|---|---|
| target | DOM element | Element | Document | (() => Element) | document |
| initialValue | Controls whether to lock the scroll | boolean | false |
Result
| Property | Description | Type |
|---|---|---|
| isLocked | Whether the scroll element is locked | Accessor<boolean> |
| setLock | Set whether to lock scrolling | (lock: boolean) => void |