material-components / material-components-web

Modular and customizable Material Design UI components for the web
https://material.io/develop/web
MIT License
17.14k stars 2.15k forks source link

Feedback and suggest #7959

Open CarlosEGuerraSilva opened 1 year ago

CarlosEGuerraSilva commented 1 year ago

The problem

Web Platform needs to improve its documentation, there are so many lack of visual examples and javascript behavior for a static-js implementation, like bootstrap, there was so many times that I have to visit several github issues to have a guide of how to use almost all components, so I hope new MD iterations have more attention to this.

Additional info and screenshots

In the implementation part of Card component only one screenshot is provided to have a visual guidance, the rest of variants and settings of Cards doesn't have other visual help image

Proposed solution

Add visual examples and live demos to every component, avoid using custom css to samples that are not included on the package image It would also be appropriate to provide javascript code examples to manipulate elements statically, for example the Dialog component does not have any example code to control this component statically, in short, it should not be necessary to search external pages for information that should be in the documentation