Redoc navigation doesn't work inside iframe · Redocly/redoc#2151

(1 留言) (2 反應) (0 負責人)TypeScript (21,877 star) (2,272 fork)batch import

help wantedinvestigation

描述

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.

貢獻者指南

技術棧: typescriptreact
領域: documentationfrontend
議題類型: bug
難度: 3
預計時間: 1-3 hours
活動狀態: stale
清晰度: clear
前置要求: Basic ReactUnderstanding of iframe navigation
新手友善度: 45
研究方向: Investigate the navigation behavior of Redoc within an iframe. The issue likely stems from the routing mechanism (e.g., react router) not properly handling navigation events when inside an iframe. Check the Sidebar component (likely in src/components/Sidebar.tsx) and how it handles link clicks. Consider using window.location.replace or a different navigation method that works cross origin. Also review the existing comment for further context.