Redocly / Redocly/redoc

Does not scroll to item on menu bar click

Open
#2,434 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Describe the bug
When I use the redoc standalone react component embedded in my SPA react app, the side menu functionality does not work. When I click on the section I want to go to, the URL is updated correctly but the UI does not jump to the right spot. When I manually refresh with the updated URL it goes to the correct location in the docs.

Expected behavior
When I click on an item in the side menu, I expect it to be navigated to in the UI

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

Reproduce the issue with the standalone React component embedded in a SPA, then trace the side-menu click and URL navigation behavior. The work is done when clicking a side-menu item updates the URL and moves the UI to the selected documentation section without a manual refresh.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.