Redocly / Redocly/redoc

Left navigation auto scrolling and link changing on scrolling is not working

Open
#1,235 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted Type: Bug
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Hi

We found a bug while integrating ReDoc into our application. While scrolling the left navigation bar is not scrolling or auto collapsed or even highlighted and even the link in the navigation bar is not changing. Please check the video

Our application is a SPA built using react and the redoc version we are using is 2.0.0-rc.26.

const APIRef = props => {
  return (
    <div id="redoc">
      <RedocStandalone
        spec={petStoreSpec}
        onLoaded={error => {
          if (error) {
            console.log(error);
          }
        }}
      />
    </div>
  );
};

The only warning we could see in the console is
image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with the RedocStandalone entry point in the provided React SPA example and observe the left navigation while scrolling. Done means the navigation auto-scrolls or collapses as needed, highlights the current section, and updates its link during scrolling.

Written by the indexing model from the issue text.

Assessment

Tech stack
react
Domain
frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.