Redocly/redoc

Hash navigation is colliding with the existing hash navigation

Open

#655 opened on Sep 26, 2018

View on GitHub
 (5 comments) (1 reaction) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
Type: Enhancementhelp wanted

Description

Using ReDoc as not a stand alone application, but a part of a framework that's an SPA. I am using ant.design, a react application as a boiler plate. I want to integrate ReDoc on one of its tab. I already have a route provider in the application (ex: localhost:8000/#/dashboard/workspace). now while I am trying to use ReDoc component RedocStandalone, while navigating, it already uses this # string, which is causing problem while navigation.

I want something, so that I could access the ReDoc app such after my URL - localhost:8000/#/dashboard/workspace/#section/Authentication, where I need to replace second # with encoded # to navigate smoothly!

Or is there any other way of implementing this, I am unaware of? Please help.

@RomanGotsiy

Contributor guide

Tech stack
typescriptreact
Domain
frontenddocumentation
Issue type
feature
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-2 days
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.
mostly clear
Prerequisites
React experienceRedoc integrationSPA routing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the navigation handling in ReDoc, specifically the RedocStandalone component and any hash based routing logic. Look at the source code for how the `#` is used for section navigation and consider options like a configurable prefix or encoding the second `#`. Check existing discussions or comments for any proposed solutions. The goal is to allow ReDoc to coexist with an existing SPA hash router without collision.