Redocly/redoc

Redoc navigation doesn't work inside iframe

Open

#2.151 aberto em 5 de set. de 2022

Ver no GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (2.272 forks)batch import
help wantedinvestigation

Métricas do repositório

Stars
 (21.877 stars)
Métricas de merge de PR
 (Mesclagem média 3h 40m) (11 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue o comportamento de navegação do Redoc dentro de um iframe. O problema provavelmente decorre do mecanismo de roteamento (por exemplo, react router) não lidar adequadamente com eventos de navegação quando dentro de um iframe. Verifique o componente Sidebar (provavelmente em src/components/Sidebar.tsx) e como ele trata cliques em links. Considere usar window.location.replace ou um método de navegação diferente que funcione cross origin. Também revise o comentário existente para mais contexto.
Pilha de tecnologia
typescriptreact
Domain
documentationfrontend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic ReactUnderstanding of iframe navigation
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
45