Redocly/redoc

Redoc navigation doesn't work inside iframe

Open

#2151 opened on Sep 5, 2022

View on GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
help wantedinvestigation

Description

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.

Contributor guide

Tech stack
typescriptreact
Domain
documentationfrontend
Issue type
bug
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-3 hours
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.
clear
Prerequisites
Basic ReactUnderstanding of iframe navigation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
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.