Skip to content

Add documentation for CDK Collections #18818

@mikejunt

Description

@mikejunt

Bug, feature request, or proposal:

The cdk/Material table and especially the Material Paginator/Sort need dataSource classes to function correctly with complex data objects. However, they currently have circular documentation that leads nowhere. Material Table references the CDK table, which references the datasource, which, like all cdk Collections classes, is completely undocumented.

Is there anything else we should know?

I would suggest some official documentation around the Collections classes and DataSource objects in particular to understand what kind of inputs they are looking for and how they should be modified for complex objects to function with the sort/Paginator functions without extensive trial and error.

Metadata

Metadata

Assignees

Labels

P4A relatively minor issue that is not relevant to core functionsarea: cdk/collectionsdocsThis issue is related to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions