google / google/material-design-lite

Ensure each component has a properly documented API

Open
#1,733 0 comments 0 reactions 0 assignees View on GitHub
2.0 Big Themes P0
Dominant language
HTML
Stars
32.2k
Forks
4.9k
PR merge metrics
No merged PRs in 30d

Description

While most of our components have an API for programmatic usage, there's much we should do to improve things. In order of decreasing priority:
- Create proper reference documentation for API methods.
- Ensure method names and signatures are consistent across components.
- Ensure all major use cases are covered (`mdl-data-table` is missing important methods for adding and removing rows, for example).
- Add a factory method for every component, that knows how to build the DOM structure for a new instance of the component.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.