Redocly/redoc

Redoc navigation doesn't work inside iframe

Aperta

#2151 aperta il 5 set 2022

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

Metriche repository

Star
 (21.877 stelle)
Metriche merge PR
 (Nessuna PR mergiata 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 la gestione della navigazione in Redoc quando viene caricato all'interno di un iframe. Cerca listener di eventi, comportamento dei link anchor e potenziali restrizioni dalle impostazioni cross origin dell'iframe. Verifica se la navigazione utilizza l'API history del browser o modifiche all'hash, e come vengono bloccate o influenzate in un contesto iframe.
Tech stack
typescriptreact
Dominio
frontenddocumentation
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitJavaScriptTypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70