docs-bug(COMPONENT): Insufficient documentation of MatRecycleRows directive
- Dominant language
- TypeScript
- Stars
- 25k
- Forks
- 6.8k
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 91
Description
### Documentation Feedback
There is *some* documentation on MatRecycleRows:
- In the api section we find the following description of MatRecycleRows: "Enables the recycle view repeater strategy"
- In the examples we find a "Table that uses the recycle view repeater strategy." example. But in the example we only see the standard example code with the extra directive 'recycleRows'. It is not clear at all what is the impact of the directive.
Nowhere in the docs I find what exactly is the purpose of this directive; in what scenarios I should use this. I have the *impression* you should use this when implementing infinite scroll, but I am not sure at all.
### Affected documentation page
https://material.angular.io/cdk/table/overview
Contributor guide
Research direction
Start at the CDK table overview page, reading the MatRecycleRows API description and the table example that uses the recycleRows directive. Update the documentation to explain the directive's purpose, its effect on table behavior, and when it should be used; done means a newcomer can understand whether it applies to their scenario.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100