storybookjs/storybook

Scroll position does not reset when switching between long docs

Open

#12,497 opened on Sep 16, 2020

View on GitHub
 (11 comments) (2 reactions) (1 assignee)TypeScript (89,909 stars) (10,058 forks)batch import
addon: docsbuggood first issuehelp wantedtriage:reviewed

Description

Describe the bug With multiple pure-documentation MDX docs, the scroll position of the preview window does not reset when switching between docs.

To Reproduce Steps to reproduce the behavior:

  1. Create at least two MDX docs without stories, with content long enough to result in a scroll bar.
  2. Select the first doc in the sidebar.
  3. Scroll down the first document.
  4. Select the second doc in the sidebar.

The second doc loads with the scroll position already partially down the page.

Expected behavior Selecting a doc should always start with the scroll position at the top of the page.

Screenshots Screen Recording 2020-09-16 at 14 57 46

Code snippets https://github.com/zolk/storybook-mdx-scroll-bug

System: Reproducible in Storybook 6.0.21.

Contributor guide

Tech stack
typescriptreact
Domain
frontenddeveloper experience
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React componentsDOM scroll behaviorStorybook addon documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the scroll behavior in the preview window when switching between MDX documents. Look at the component that renders the document content and ensure that the scroll position is reset to top on document change. The reproduction repository at https://github.com/zolk/storybook mdx scroll bug can be used to test. Also, check existing comments on the issue for any proposed solutions.