angular/components

[CdkScrollable] Add more documentation and demo examples

Open

#9,594 opened on Jan 25, 2018

View on GitHubContributor guide
 (8 comments) (45 reactions) (0 assignees)TypeScript (6,650 forks)batch import
P4area: cdk/scrollingdocshelp wanted

Repository metrics

Stars
 (24,044 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Review the existing scroll dispatcher test file and the scrolling overview documentation. Then create a new guide or demo that demonstrates how to implement a scrollspy using CdkScrollable.
Tech stack
typescript
Domain
frontend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75