Redocly/redoc

Hash navigation is colliding with the existing hash navigation

Open

#655 建立於 2018年9月26日

在 GitHub 查看
 (5 留言) (1 反應) (0 負責人)TypeScript (21,877 star) (2,272 fork)batch import
Type: Enhancementhelp wanted

描述

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

貢獻者指南

技術棧
typescriptreact
領域
frontenddocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
React experienceRedoc integrationSPA routing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.