angular/components

[CdkScrollable] Add more documentation and demo examples

Open

#9594 opened on Jan 25, 2018

View on GitHub
 (8 comments) (45 reactions) (0 assignees)TypeScript (24,044 stars) (6,650 forks)batch import
P4area: cdk/scrollingdocshelp wanted

Description

i'm trying to put together the test of how to put a "scrollspy" together. but unfortunately i did not find any help in the documentation.

can you expect a user manual? thanks!

Contributor guide

Tech stack
typescript
Domain
documentationfrontend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
AngularCDK Scrolling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing documentation at https://material.angular.io/cdk/scrolling/overview and the test file at src/cdk/scrolling/scroll dispatcher.spec.ts to understand current coverage. Review comments in the issue for any maintainer guidance. Then propose new documentation examples, including a 'scrollspy' pattern, and potentially update the scroll dispatcher spec file to demonstrate the feature.