Redocly/redoc

Redoc navigation doesn't work inside iframe

Aberta

#2.151 aberto em 5 de set. de 2022

Ver no GitHubGuia do colaborador
 (1 comentário) (2 reações) (0 responsável)TypeScript (2.272 forks)batch import
help wantedinvestigation

Métricas do repositório

Stars
 (21.877 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada 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 tratamento de navegação no Redoc quando carregado dentro de um iframe. Procure por ouvintes de eventos, comportamento de links âncora e possíveis restrições das configurações de iframe entre origens. Verifique se a navegação usa a API history do navegador ou alterações de hash, e como elas são bloqueadas ou afetadas em um contexto de iframe.
Pilha de tecnologia
typescriptreact
Domain
frontenddocumentation
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitJavaScriptTypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70