Redocly/redoc

Suggestion: configuration option to specify scrolling context/container

Open

#727 opened on 2018年11月28日

GitHub で見る
 (6 comments) (0 reactions) (0 assignees)TypeScript (2,272 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (21,877 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

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.

コントリビューターガイド

調査方針
ReDocのスクロールハンドラの実装を調べます。スクロールやメニューアクティベーションに関連するソースコードファイルを探します。ウィンドウスクロールイベントがリッスンされている場所を特定し、設定可能なコンテナを注入する方法を見つけます。
技術スタック
typescript
領域
frontend
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
TypeScriptJavaScriptDOM scroll events
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60