Redocly/redoc

Suggestion: configuration option to specify scrolling context/container

Open

#727 aperta il 28 nov 2018

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)TypeScript (2272 fork)batch import
Type: Enhancementhelp wanted

Metriche repository

Star
 (21.877 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

I am trying to use ReDoc in a SPA inside a somewhat complex nested view (angular app using ui-router). The problem is the scroll handler in ReDoc seems to be relative to the window object, so in my case it doesn't trigger at all. So menu links are not automatically activated on scrolling etc.

My suggestion is to provide a configuration option to specify the parent scrolling context/container, similar to what other libraries that support scroll detection events have (like waypoints.js, wow.js etc.)

This would help a lot with embedding ReDoc in SPAs in general I think.

Guida contributor

Direzione di ricerca
Esplora l'implementazione del gestore di scorrimento di ReDoc, probabilmente nei file del codice sorgente relativi allo scorrimento o all'attivazione del menu. Identifica dove vengono ascoltati gli eventi di scorrimento della finestra e come potrebbe essere iniettato un contenitore configurabile.
Tech stack
typescript
Dominio
frontend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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
TypeScriptJavaScriptDOM scroll events
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60