|
| 1 | +## New Component Checklist (delete for other types of PRs) |
| 2 | + |
| 3 | +- [ ] - Overview article |
| 4 | + - [ ] General information on the purpose of the component. |
| 5 | + - [ ] Instruction on how to add the component to a razor component. |
| 6 | + - [ ] Basic configuration of the component - code snippet with a scenario that is both basic, and meaningful. |
| 7 | + - [ ] Provide information on the component's reference. |
| 8 | + - [ ] List the available features for the component and/or provide links (slugs) for the articles that explain them in details. For simpler components listing parameters might be enough, for more complex ones sections with a sentence or two that links corresponding articles might be more suitable. |
| 9 | + - [ ] Maybe some Example(s) - very common scenarios, notes, typical use case, etc. Not mandatory, depends on the component. |
| 10 | + |
| 11 | + |
| 12 | +- [ ] - Data binding article - applicable if data can be provided to the component. My be one article or a folder with several articles (examples - DropDownList and TreeView) |
| 13 | + |
| 14 | + |
| 15 | +- [ ] - Feature/component specific articles - those articles explain the component specific features, which do not suit in any of the before-mentioned articles. Examples of such articles are the [Navigator](https://docs.telerik.com/blazor-ui/components/stockchart/navigator) for the Stock Chart, the [Indeterminate](https://docs.telerik.com/blazor-ui/components/checkbox/indeterminate-state) state for the CheckBox and others. |
| 16 | + |
| 17 | + |
| 18 | +- [ ] - Selection article - applicable if the component exposes items selection. May be a folder. |
| 19 | + [ ] - Single item selection |
| 20 | + [ ] - Multiple item selection |
| 21 | + |
| 22 | + |
| 23 | +- [ ] - Templates - applicable if additional customization is allowed with Templates. Usually a folder, see the grid |
| 24 | + |
| 25 | + |
| 26 | +- [ ] - Events article - applicable if the component expose events. |
| 27 | +Examples of such events could be: |
| 28 | + * OnClick |
| 29 | + * OnChange |
| 30 | + * ValueChanged |
| 31 | + * SelectedItemsChanged |
| 32 | + * OnRead |
| 33 | + * etc. |
| 34 | + |
| 35 | +- [ ] Update Input Validation, Globalization, Keyboard Navigation, Accessibility Compliance articles as applicable. |
| 36 | + |
| 37 | +- [ ] Link from the Overview components list |
| 38 | + |
| 39 | + |
0 commit comments