Suggestion: configuration option to specify scrolling context/container · Redocly/redoc#727

(6 留言) (0 反應) (0 負責人)TypeScript (21,877 star) (2,272 fork)batch import

Type: Enhancementhelp wanted

描述

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.

貢獻者指南

技術棧: typescriptreact
領域: frontend
議題類型: feature
難度: 3
預計時間: 1-2 days
活動狀態: stale
清晰度: clear
前置要求: Familiarity with React scroll eventsUnderstanding of Redoc's configuration system
新手友善度: 40
研究方向: 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.