Add ScrollSpy component
Open
Nobody has claimed this yet.
scope: new proposal
type: new feature
waiting for 👍
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
- This is not a v0.x issue.
- I have searched the issues of this repository and believe that this is not a duplicate.
Expected Behavior 🤔
Like zurb's Magellan. highlight navbar item based on scroll and/or based if element is in viewport
Examples 🌈
See link above
Context 🔦
I would like to create this component for MUI! I'm happy to submit a PR with some guidance :)
Benchmark
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 reviewing the linked Zurb Magellan, Bootstrap Scrollspy, Reactstrap, and superprops examples to compare expected behavior. The issue names no repository files or tests, so first locate MUI's existing navigation and component patterns; done should include a ScrollSpy component that highlights navigation items based on scroll position or viewport visibility, with the behavior clarified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100