Redocly/redoc

Suggestion: configuration option to specify scrolling context/container

Open

#727 opened on Nov 28, 2018

View on GitHub
 (6 comments) (0 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
Type: Enhancementhelp wanted

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

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
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-2 days
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
Familiarity with React scroll eventsUnderstanding of Redoc's configuration system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how ReDoc handles scrolling currently, likely in the ScrollWrapper component. Look for window scroll listeners and identify where to inject a custom scroll container via a configuration option. Review existing configuration options in the codebase to follow the pattern. The issue is a feature request from 2018 with no linked PRs, so the implementation approach is open ended. Consider making the scroll container configurable via a React context or prop.