streamich/react-use

useLockBodyScroll doesn't restore scroll position

Open

#840 opened on Dec 16, 2019

View on GitHub
 (7 comments) (0 reactions) (1 assignee)TypeScript (43,979 stars) (3,273 forks)batch import
bughelp wanted

Description

What is the current behavior?

When useLockBodyScroll is passed a value of false, it does re-enable scrolling, however any previous scroll position is not restored.

What is the expected behavior?

The previous scroll position should be restored to the scrolled element.

A little about versions:

  • OS:
  • Browser (vendor and version):
  • React: 16.11.0
  • react-use: 13.10.1

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic React hooksJavaScript event handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The bug is in the useLockBodyScroll hook in react use. To fix, you need to save the scroll position when scrolling is locked and restore it when unlocked. Look at the hook implementation in https://github.com/streamich/react use/blob/master/src/useLockBodyScroll.ts. The current code likely sets overflow hidden but does not store/restore scrollLeft/scrollTop. Review existing comments and the assignee's work to avoid duplication.