Redocly/redoc

Redoc navigation doesn't work inside iframe

Open

#2151 aperta il 5 set 2022

Vedi su GitHub
 (1 commento) (2 reazioni) (0 assegnatari)TypeScript (2272 fork)batch import
help wantedinvestigation

Metriche repository

Star
 (21.877 star)
Metriche merge PR
 (Merge medio 3h 40m) (11 PR mergiate in 30 g)

Descrizione

Describe the bug We have added redoc to our doc site. Due to style conflicts, we decided to render redoc inside an iframe and embed the iframe in doc site. The redoc content from the given OpenAPI file is loaded correctly, but the sidebar navigation is broken. Clicking on any link doesn't navigate the user to corresponding API resource definition.

Expected behavior Navigation between API endpoint definitions should work.

Minimal reproducible OpenAPI snippet(if possible) This problem is independent of the OpenAPI snippet

Screenshots N/A

Additional context Add any other context about the problem here.

Guida contributor

Direzione di ricerca
Indaga sul comportamento di navigazione di Redoc all'interno di un iframe. Il problema probabilmente deriva dal meccanismo di routing (ad es. react router) che non gestisce correttamente gli eventi di navigazione quando si è all'interno di un iframe. Controlla il componente Sidebar (probabilmente in src/components/Sidebar.tsx) e come gestisce i clic sui link. Considera l'uso di window.location.replace o di un metodo di navigazione diverso che funzioni cross origin. Rivedi anche il commento esistente per ulteriore contesto.
Tech stack
typescriptreact
Dominio
documentationfrontend
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Basic ReactUnderstanding of iframe navigation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45