Suggestion: configuration option to specify scrolling context/container
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing ReDoc's scroll handler and the menu-link activation behavior described in the issue. Compare how the Angular SPA's nested scrolling container differs from the window context, then define the configuration behavior and verify that menu links activate while scrolling inside the configured container.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100