Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add Component name section to API docs #20434

Merged
merged 5 commits into from
Apr 7, 2020

Conversation

Josh-Weston
Copy link
Contributor

@Josh-Weston Josh-Weston commented Apr 5, 2020

Fixes #17245

generateName() function added to generateMarkdonw.js to create "Component Name" entry in each component's .md file. If the component does not have styling available there will be no entry. "Style sheet" name line has been removed from generateProps() as it is now redundant. Markdown files updated and reviewed. Added function styleNameError() to throw an error when the component is missing a style name. The same error is thrown in the recently added generateName() function, so the error was consolidated to avoid DRY.

generateName() function adds the "Component Name" entry to a component's .md file. If the component does not have styling available there will be no entry. Style sheet name has been removed from generateProps as it is redundant.
Added function styleNameError() to throw an error when the component is missing a style name. The same error is thrown in the recently added generateName() function, so the error was consolidated to avoid DRY.
@mui-pr-bot
Copy link

mui-pr-bot commented Apr 5, 2020

Details of bundle changes.

Comparing: a2b2463...9e4ead4

Details of page changes
bundle Size Change Size Gzip Change Gzip
/api-docs/card-action-area ▲ +50 B (+3.79% ) 1.37 kB -- -1 B
/api-docs/snackbar-content ▲ +50 B (+3.68% ) 1.41 kB -- -1 B
/api-docs/stepper ▲ +50 B (+3.13% ) 1.65 kB -- -1 B
/api-docs/alert-title ▲ +40 B (+3.51% ) 1.18 kB -- -1 B
/api-docs/alert ▲ +40 B (+1.86% ) 2.19 kB -- -1 B
/api-docs/autocomplete ▲ +40 B (+0.99% ) 4.09 kB -- -1 B
/api-docs/backdrop ▲ +40 B (+2.90% ) 1.42 kB -- -1 B
/api-docs/badge ▲ +40 B (+2.13% ) 1.92 kB -- -1 B
/api-docs/bottom-navigation ▲ +40 B (+2.80% ) 1.47 kB -- -1 B
/api-docs/button-group ▲ +40 B (+2.05% ) 1.99 kB -- -1 B
/api-docs/button ▲ +40 B (+1.72% ) 2.36 kB -- -1 B
/api-docs/card-actions ▲ +40 B (+3.28% ) 1.26 kB -- -1 B
/api-docs/card ▲ +40 B (+3.20% ) 1.29 kB -- -1 B
/api-docs/checkbox ▲ +40 B (+1.95% ) 2.09 kB -- -1 B
/api-docs/chip ▲ +40 B (+1.83% ) 2.23 kB -- -1 B
/api-docs/circular-progress ▲ +40 B (+2.22% ) 1.84 kB -- -1 B
/api-docs/css-baseline ▲ +40 B (+3.51% ) 1.18 kB -- -1 B
/api-docs/dialog-actions ▲ +40 B (+3.28% ) 1.26 kB -- -1 B
/api-docs/dialog-content-text ▲ +40 B (+3.25% ) 1.27 kB -- -1 B
/api-docs/dialog-content ▲ +40 B (+3.33% ) 1.24 kB -- -1 B
/api-docs/divider ▲ +40 B (+2.58% ) 1.59 kB -- -1 B
/api-docs/drawer ▲ +40 B (+2.14% ) 1.91 kB -- -1 B
/api-docs/expansion-panel-actions ▲ +40 B (+3.25% ) 1.27 kB -- -1 B
/api-docs/expansion-panel-details ▲ +40 B (+3.45% ) 1.2 kB -- -1 B
/api-docs/expansion-panel-summary ▲ +40 B (+2.74% ) 1.5 kB -- -1 B
/api-docs/form-group ▲ +40 B (+3.08% ) 1.34 kB -- -1 B
/api-docs/grid-list-tile ▲ +40 B (+2.74% ) 1.5 kB -- -1 B
/api-docs/grid ▲ +40 B (+1.75% ) 2.33 kB -- -1 B
/api-docs/icon-button ▲ +40 B (+2.16% ) 1.89 kB -- -1 B
/api-docs/input-label ▲ +40 B (+2.20% ) 1.86 kB -- -1 B
/api-docs/linear-progress ▲ +40 B (+2.25% ) 1.82 kB -- -1 B
/api-docs/link ▲ +40 B (+2.38% ) 1.72 kB -- -1 B
/api-docs/list-item-avatar ▲ +40 B (+3.20% ) 1.29 kB -- -1 B
/api-docs/list-item-icon ▲ +40 B (+3.15% ) 1.31 kB -- -1 B
/api-docs/list-item ▲ +40 B (+2.00% ) 2.04 kB -- -1 B
/api-docs/list-subheader ▲ +40 B (+2.65% ) 1.55 kB -- -1 B
/api-docs/menu-item ▲ +40 B (+2.70% ) 1.52 kB -- -1 B
/api-docs/menu ▲ +40 B (+1.88% ) 2.17 kB -- -1 B
/api-docs/mobile-stepper ▲ +40 B (+2.40% ) 1.71 kB -- -1 B
/api-docs/pagination-item ▲ +40 B (+2.34% ) 1.75 kB -- -1 B
/api-docs/pagination ▲ +40 B (+2.02% ) 2.02 kB -- -1 B
/api-docs/paper ▲ +40 B (+2.48% ) 1.65 kB -- -1 B
/api-docs/radio ▲ +40 B (+2.14% ) 1.91 kB -- -1 B
/api-docs/scoped-css-baseline ▲ +40 B (+3.48% ) 1.19 kB -- -1 B
/api-docs/select ▲ +40 B (+1.51% ) 2.69 kB -- -1 B
/api-docs/slider ▲ +40 B (+1.40% ) 2.89 kB -- -1 B
/api-docs/snackbar ▲ +40 B (+1.63% ) 2.5 kB -- -1 B
/api-docs/speed-dial-action ▲ +40 B (+2.40% ) 1.71 kB -- -1 B
/api-docs/speed-dial-icon ▲ +40 B (+3.10% ) 1.33 kB -- -1 B
/api-docs/speed-dial ▲ +40 B (+1.95% ) 2.09 kB -- -1 B
/api-docs/step-button ▲ +40 B (+2.90% ) 1.42 kB -- -1 B
/api-docs/step-connector ▲ +40 B (+3.10% ) 1.33 kB -- -1 B
/api-docs/step-icon ▲ +40 B (+3.01% ) 1.37 kB -- -1 B
/api-docs/step-label ▲ +40 B (+2.44% ) 1.68 kB -- -1 B
/api-docs/step ▲ +40 B (+2.90% ) 1.42 kB -- -1 B
/api-docs/tab ▲ +40 B (+2.30% ) 1.78 kB -- -1 B
/api-docs/table-body ▲ +40 B (+3.31% ) 1.25 kB -- -1 B
/api-docs/table-head ▲ +40 B (+3.31% ) 1.25 kB -- -1 B
/api-docs/table-row ▲ +40 B (+2.80% ) 1.47 kB -- -1 B
/api-docs/table-sort-label ▲ +40 B (+2.55% ) 1.61 kB -- -1 B
/api-docs/toggle-button-group ▲ +40 B (+2.56% ) 1.6 kB -- -1 B
/api-docs/tree-item ▲ +40 B (+2.61% ) 1.57 kB -- -1 B
/api-docs/typography ▲ +40 B (+1.72% ) 2.37 kB -- -1 B
/api-docs/svg-icon ▲ +30 B (+1.49% ) 2.04 kB -- -1 B
/api-docs/app-bar ▲ +30 B (+1.78% ) 1.72 kB -- -1 B
/api-docs/avatar-group ▲ +30 B (+2.38% ) 1.29 kB -- -1 B
/api-docs/avatar ▲ +30 B (+1.86% ) 1.64 kB -- -1 B
/api-docs/bottom-navigation-action ▲ +30 B (+1.94% ) 1.58 kB -- -1 B
/api-docs/breadcrumbs ▲ +30 B (+1.89% ) 1.62 kB -- -1 B
/api-docs/button-base ▲ +30 B (+1.44% ) 2.11 kB -- -1 B
/api-docs/card-content ▲ +30 B (+2.50% ) 1.23 kB -- -1 B
/api-docs/card-header ▲ +30 B (+1.96% ) 1.56 kB -- -1 B
/api-docs/card-media ▲ +30 B (+2.10% ) 1.46 kB -- -1 B
/api-docs/collapse ▲ +30 B (+1.70% ) 1.79 kB -- -1 B
/api-docs/container ▲ +30 B (+1.85% ) 1.65 kB -- -1 B
/api-docs/dialog-title ▲ +30 B (+2.40% ) 1.28 kB -- -1 B
/api-docs/dialog ▲ +30 B (+1.21% ) 2.51 kB -- -1 B
/api-docs/expansion-panel ▲ +30 B (+1.76% ) 1.73 kB -- -1 B
/api-docs/fab ▲ +30 B (+1.61% ) 1.89 kB -- -1 B
/api-docs/filled-input ▲ +30 B (+1.13% ) 2.68 kB -- -1 B
/api-docs/form-control-label ▲ +30 B (+1.73% ) 1.76 kB -- -1 B
/api-docs/form-control ▲ +30 B (+1.42% ) 2.15 kB -- -1 B
/api-docs/form-helper-text ▲ +30 B (+1.81% ) 1.69 kB -- -1 B
/api-docs/form-label ▲ +30 B (+1.89% ) 1.62 kB -- -1 B
/api-docs/grid-list-tile-bar ▲ +30 B (+1.95% ) 1.57 kB -- -1 B
/api-docs/grid-list ▲ +30 B (+2.19% ) 1.4 kB -- -1 B
/api-docs/icon ▲ +30 B (+1.95% ) 1.57 kB -- -1 B
/api-docs/input-adornment ▲ +30 B (+1.79% ) 1.71 kB -- -1 B
/api-docs/input-base ▲ +30 B (+1.09% ) 2.77 kB -- -1 B
/api-docs/input ▲ +30 B (+1.15% ) 2.64 kB -- -1 B
/api-docs/list-item-secondary-action ▲ +30 B (+2.46% ) 1.25 kB -- -1 B
/api-docs/list-item-text ▲ +30 B (+1.95% ) 1.57 kB -- -1 B
/api-docs/list ▲ +30 B (+2.08% ) 1.47 kB -- -1 B
/api-docs/native-select ▲ +30 B (+1.64% ) 1.86 kB -- -1 B
/api-docs/outlined-input ▲ +30 B (+1.09% ) 2.79 kB -- -1 B
/api-docs/popover ▲ +30 B (+1.20% ) 2.53 kB -- -1 B
/api-docs/rating ▲ +30 B (+1.33% ) 2.28 kB -- -1 B
/api-docs/skeleton ▲ +30 B (+1.97% ) 1.55 kB -- -1 B
/api-docs/step-content ▲ +30 B (+2.04% ) 1.5 kB -- -1 B
/api-docs/switch ▲ +30 B (+1.35% ) 2.25 kB -- -1 B
/api-docs/table-cell ▲ +30 B (+1.60% ) 1.9 kB -- -1 B
/api-docs/table-container ▲ +30 B (+2.46% ) 1.25 kB -- -1 B
/api-docs/table-footer ▲ +30 B (+2.46% ) 1.25 kB -- -1 B
/api-docs/table-pagination ▲ +30 B (+1.36% ) 2.24 kB -- -1 B
/api-docs/table ▲ +30 B (+2.10% ) 1.46 kB -- -1 B
/api-docs/tabs ▲ +30 B (+1.32% ) 2.31 kB -- -1 B
/api-docs/text-field ▲ +30 B (+1.02% ) 2.97 kB -- -1 B
/api-docs/toggle-button ▲ +30 B (+1.94% ) 1.58 kB -- -1 B
/api-docs/toolbar ▲ +30 B (+2.14% ) 1.43 kB -- -1 B
/api-docs/tooltip ▲ +30 B (+1.30% ) 2.33 kB -- -1 B
/api-docs/tree-view ▲ +30 B (+1.80% ) 1.7 kB -- -1 B
/api-docs/grow ▲ +10 B (+0.81% ) 1.24 kB -- -1 B
/api-docs/menu-list ▼ -10 B (-0.74% ) 1.35 kB -- -1 B
/performance/table-emotion ▼ -10 B (-0.34% ) 2.96 kB -- -1 B
/api-docs/textarea-autosize ▲ +1 B (+0.11% ) 909 B -- -1 B
/_app -- 33.7 kB -- -1 B
/api-docs/click-away-listener -- 1.23 kB -- -1 B
/api-docs/fade -- 1.17 kB -- -1 B
/api-docs/hidden -- 1.32 kB -- -1 B
/api-docs/modal -- 2.14 kB -- -1 B
/api-docs/no-ssr -- 1.09 kB -- -1 B
/api-docs/popper -- 1.76 kB -- -1 B
/api-docs/portal -- 1.12 kB -- -1 B
/api-docs/radio-group -- 1.23 kB -- -1 B
/api-docs/root-ref -- 1.2 kB -- -1 B
/api-docs/slide -- 1.31 kB -- -1 B
/api-docs/swipeable-drawer -- 1.78 kB -- -1 B
/api-docs/zoom -- 1.2 kB -- -1 B
/blog/2019-developer-survey-results -- 5.98 kB -- -1 B
/blog/2019 -- 3.87 kB -- -1 B
/blog/2020-introducing-sketch -- 3.1 kB -- -1 B
/blog/april-2019-update -- 2.76 kB -- -1 B
/blog/august-2019-update -- 1.87 kB -- -1 B
/blog/december-2019-update -- 2.01 kB -- -1 B
/blog/july-2019-update -- 1.77 kB -- -1 B
/blog/june-2019-update -- 1.63 kB -- -1 B
/blog/march-2019-update -- 2.17 kB -- -1 B
/blog/material-ui-v1-is-out -- 6.29 kB -- -1 B
/blog/material-ui-v4-is-out -- 9.32 kB -- -1 B
/blog/may-2019-update -- 1.96 kB -- -1 B
/blog/november-2019-update -- 2.37 kB -- -1 B
/blog/october-2019-update -- 2.12 kB -- -1 B
/blog/september-2019-update -- 2.3 kB -- -1 B
/company/about -- 1.56 kB -- -1 B
/company/contact -- 1.14 kB -- -1 B
/company/jobs -- 1.16 kB -- -1 B
/components/about-the-lab -- 5.55 kB -- -1 B
/components/alert -- 12.4 kB -- -1 B
/components/app-bar -- 30.9 kB -- -1 B
/components/autocomplete -- 105 kB -- -1 B
/components/avatars -- 8.44 kB -- -1 B
/components/backdrop -- 3.31 kB -- -1 B
/components/badges -- 15 kB -- -1 B
/components/bottom-navigation -- 6.21 kB -- -1 B
/components/box -- 7.95 kB -- -1 B
/components/breadcrumbs -- 14.3 kB -- -1 B
/components/button-group -- 6.65 kB -- -1 B
/components/buttons -- 24.3 kB -- -1 B
/components/cards -- 16.9 kB -- -1 B
/components/checkboxes -- 16.5 kB -- -1 B
/components/chips -- 21.5 kB -- -1 B
/components/click-away-listener -- 3.84 kB -- -1 B
/components/container -- 3.83 kB -- -1 B
/components/css-baseline -- 5.96 kB -- -1 B
/components/dialogs -- 42.1 kB -- -1 B
/components/dividers -- 12.2 kB -- -1 B
/components/drawers -- 29.7 kB -- -1 B
/components/expansion-panels -- 20 kB -- -1 B
/components/floating-action-button -- 10.3 kB -- -1 B
/components/grid-list -- 11.8 kB -- -1 B
/components/grid -- 33.9 kB -- -1 B
/components/hidden -- 10.5 kB -- -1 B
/components/icons -- 24.5 kB -- -1 B
/components/links -- 6.82 kB -- -1 B
/components/lists -- 25.9 kB -- -1 B
/components/material-icons -- 728 kB -- -1 B
/components/menus -- 23.4 kB -- -1 B
/components/modal -- 11.5 kB -- -1 B
/components/no-ssr -- 5.02 kB -- -1 B
/components/pagination -- 8.08 kB -- -1 B
/components/paper -- 3.33 kB -- -1 B
/components/pickers -- 38.2 kB -- -1 B
/components/popover -- 16.9 kB -- -1 B
/components/popper -- 22.5 kB -- -1 B
/components/portal -- 3.29 kB -- -1 B
/components/progress -- 21.7 kB -- -1 B
/components/radio-buttons -- 15.2 kB -- -1 B
/components/rating -- 11 kB -- -1 B
/components/selects -- 29.5 kB -- -1 B
/components/skeleton -- 10.1 kB -- -1 B
/components/slider -- 14.6 kB -- -1 B
/components/snackbars -- 24.8 kB -- -1 B
/components/speed-dial -- 14.4 kB -- -1 B
/components/steppers -- 36.1 kB -- -1 B
/components/switches -- 16 kB -- -1 B
/components/tables -- 174 kB -- -1 B
/components/tabs -- 19.2 kB -- -1 B
/components/text-fields -- 54.7 kB -- -1 B
/components/textarea-autosize -- 2.81 kB -- -1 B
/components/toggle-button -- 10.6 kB -- -1 B
/components/tooltips -- 17.3 kB -- -1 B
/components/transfer-list -- 9.22 kB -- -1 B
/components/transitions -- 10.8 kB -- -1 B
/components/tree-view -- 11.2 kB -- -1 B
/components/typography -- 9.7 kB -- -1 B
/components/use-media-query -- 13.1 kB -- -1 B
/customization/breakpoints -- 15.7 kB -- -1 B
/customization/color -- 21.5 kB -- -1 B
/customization/components -- 37.5 kB -- -1 B
/customization/default-theme -- 8.55 kB -- -1 B
/customization/density -- 9.14 kB -- -1 B
/customization/globals -- 4.65 kB -- -1 B
/customization/palette -- 11.9 kB -- -1 B
/customization/spacing -- 2.55 kB -- -1 B
/customization/theming -- 17 kB -- -1 B
/customization/typography -- 11.6 kB -- -1 B
/customization/z-index -- 3.05 kB -- -1 B
/discover-more/backers -- 2.88 kB -- -1 B
/discover-more/changelog -- 1.37 kB -- -1 B
/discover-more/languages -- 3.32 kB -- -1 B
/discover-more/related-projects -- 7.09 kB -- -1 B
/discover-more/roadmap -- 3.67 kB -- -1 B
/discover-more/showcase -- 13.5 kB -- -1 B
/discover-more/team -- 6.51 kB -- -1 B
/discover-more/vision -- 7.03 kB -- -1 B
/getting-started/example-projects -- 6.11 kB -- -1 B
/getting-started/faq -- 31.8 kB -- -1 B
/getting-started/installation -- 7.6 kB -- -1 B
/getting-started/learn -- 8.39 kB -- -1 B
/getting-started/support -- 7.84 kB -- -1 B
/getting-started/supported-components -- 6.19 kB -- -1 B
/getting-started/supported-platforms -- 5.69 kB -- -1 B
/getting-started/templates -- 8.55 kB -- -1 B
/getting-started/templates/album -- 5.58 kB -- -1 B
/getting-started/templates/blog -- 7.44 kB -- -1 B
/getting-started/templates/checkout -- 11.2 kB -- -1 B
/getting-started/templates/dashboard -- 8.47 kB -- -1 B
/getting-started/templates/pricing -- 7.79 kB -- -1 B
/getting-started/templates/sign-in-side -- 9.24 kB -- -1 B
/getting-started/templates/sign-in -- 9.48 kB -- -1 B
/getting-started/templates/sign-up -- 9.59 kB -- -1 B
/getting-started/templates/sticky-footer -- 1.54 kB -- -1 B
/getting-started/usage -- 9.37 kB -- -1 B
/guides/api -- 17.4 kB -- -1 B
/guides/composition -- 14.1 kB -- -1 B
/guides/flow -- 2.21 kB -- -1 B
/guides/interoperability -- 14.9 kB -- -1 B
/guides/localization -- 19.8 kB -- -1 B
/guides/migration-v0x -- 7.25 kB -- -1 B
/guides/migration-v3 -- 22.3 kB -- -1 B
/guides/minimizing-bundle-size -- 6.73 kB -- -1 B
/guides/responsive-ui -- 4.18 kB -- -1 B
/guides/right-to-left -- 6.69 kB -- -1 B
/guides/server-rendering -- 8.38 kB -- -1 B
/guides/testing -- 8.33 kB -- -1 B
/guides/typescript -- 13.4 kB -- -1 B
/performance/table-component -- 1.44 kB -- -1 B
/performance/table-hook -- 2.23 kB -- -1 B
/performance/table-mui -- 4.42 kB -- -1 B
/performance/table-raw -- 613 B -- -1 B
/performance/table-styled-components -- 2.61 kB -- -1 B
/premium-themes/onepirate -- 7.21 kB -- -1 B
/premium-themes/onepirate/forgot-password -- 1.01 kB -- -1 B
/premium-themes/onepirate/privacy -- 4.43 kB -- -1 B
/premium-themes/onepirate/sign-in -- 1.07 kB -- -1 B
/premium-themes/onepirate/sign-up -- 1.12 kB -- -1 B
/premium-themes/onepirate/terms -- 11.8 kB -- -1 B
/premium-themes/paperbase -- 8.71 kB -- -1 B
/styles/advanced -- 30.6 kB -- -1 B
/styles/api -- 16 kB -- -1 B
/styles/basics -- 17.6 kB -- -1 B
/system/api -- 5.85 kB -- -1 B
/system/basics -- 25.1 kB -- -1 B
/system/borders -- 4.04 kB -- -1 B
/system/display -- 6.51 kB -- -1 B
/system/flexbox -- 5.72 kB -- -1 B
/system/palette -- 4.28 kB -- -1 B
/system/positions -- 2.46 kB -- -1 B
/system/shadows -- 3.44 kB -- -1 B
/system/sizing -- 3.44 kB -- -1 B
/system/spacing -- 5.97 kB -- -1 B
/system/typography -- 4.22 kB -- -1 B
/versions -- 23.1 kB -- -1 B
docs:chunk:shared -- 68.3 kB -- -1 B
docs:shared:chunk/commons -- 5.99 kB -- -1 B
docs:shared:chunk/framework -- 42.3 kB -- -1 B
docs:shared:runtime/main -- 6.78 kB -- -1 B
docs:shared:runtime/webpack -- 1.24 kB -- -1 B
bundle Size Change Size Gzip Change Gzip
@material-ui/core -- 364 kB -- 100 kB
@material-ui/core[umd] -- 321 kB -- 93.2 kB
@material-ui/lab -- 203 kB -- 60.4 kB
@material-ui/styles -- 52 kB -- 15.6 kB
@material-ui/system -- 17.2 kB -- 4.52 kB
Alert -- 87.6 kB -- 27.8 kB
AlertTitle -- 68.9 kB -- 21.7 kB
AppBar -- 68.7 kB -- 21.6 kB
Autocomplete -- 136 kB -- 42.8 kB
Avatar -- 69.8 kB -- 21.9 kB
AvatarGroup -- 70.9 kB -- 22.5 kB
Backdrop -- 72.5 kB -- 22.4 kB
Badge -- 70 kB -- 21.8 kB
BottomNavigation -- 67.1 kB -- 21.1 kB
BottomNavigationAction -- 79.8 kB -- 25.3 kB
Box -- 73.6 kB -- 22.4 kB
Breadcrumbs -- 84.7 kB -- 26.9 kB
Button -- 84 kB -- 25.8 kB
ButtonBase -- 78.3 kB -- 24.6 kB
ButtonGroup -- 87.5 kB -- 27.1 kB
Card -- 67.5 kB -- 21.2 kB
CardActionArea -- 79.4 kB -- 25.1 kB
CardActions -- 66.7 kB -- 20.9 kB
CardContent -- 66.7 kB -- 20.9 kB
CardHeader -- 69.7 kB -- 22 kB
CardMedia -- 67 kB -- 21.1 kB
Checkbox -- 86.5 kB -- 27.4 kB
Chip -- 87 kB -- 26.8 kB
CircularProgress -- 68.8 kB -- 21.7 kB
ClickAwayListener -- 4.04 kB -- 1.63 kB
Collapse -- 72.7 kB -- 22.5 kB
colorManipulator -- 3.88 kB -- 1.52 kB
Container -- 67.9 kB -- 21.3 kB
CssBaseline -- 66.7 kB -- 21 kB
Dialog -- 87.5 kB -- 27.4 kB
DialogActions -- 66.8 kB -- 21 kB
DialogContent -- 66.9 kB -- 21 kB
DialogContentText -- 68.7 kB -- 21.6 kB
DialogTitle -- 69 kB -- 21.7 kB
Divider -- 67.4 kB -- 21.2 kB
docs:/ -- 10.7 kB -- -1 B
docs:/_app -- 33.7 kB -- -1 B
Drawer -- 89.2 kB -- 27.2 kB
ExpansionPanel -- 76.3 kB -- 24.1 kB
ExpansionPanelActions -- 66.8 kB -- 20.9 kB
ExpansionPanelDetails -- 66.6 kB -- 20.9 kB
ExpansionPanelSummary -- 82.4 kB -- 26.2 kB
Fab -- 81.1 kB -- 25.4 kB
Fade -- 28.4 kB -- 9.47 kB
FilledInput -- 78.2 kB -- 24.4 kB
FormControl -- 69.1 kB -- 21.6 kB
FormControlLabel -- 70.2 kB -- 22.1 kB
FormGroup -- 66.7 kB -- 20.8 kB
FormHelperText -- 68 kB -- 21.2 kB
FormLabel -- 68.1 kB -- 21.2 kB
Grid -- 69.8 kB -- 21.9 kB
GridList -- 67.2 kB -- 21.1 kB
GridListTile -- 68.4 kB -- 21.5 kB
GridListTileBar -- 67.9 kB -- 21.3 kB
Grow -- 29 kB -- 9.68 kB
Hidden -- 70.6 kB -- 22.3 kB
Icon -- 67.5 kB -- 21.2 kB
IconButton -- 80.4 kB -- 25.2 kB
Input -- 77.2 kB -- 24.2 kB
InputAdornment -- 69.8 kB -- 22 kB
InputBase -- 75.3 kB -- 23.7 kB
InputLabel -- 70 kB -- 21.6 kB
LinearProgress -- 70 kB -- 21.7 kB
Link -- 71.3 kB -- 22.6 kB
List -- 67 kB -- 20.9 kB
ListItem -- 81.4 kB -- 25.6 kB
ListItemAvatar -- 66.8 kB -- 20.9 kB
ListItemIcon -- 66.9 kB -- 21 kB
ListItemSecondaryAction -- 66.7 kB -- 20.9 kB
ListItemText -- 69.7 kB -- 22 kB
ListSubheader -- 67.4 kB -- 21.2 kB
Menu -- 93.2 kB -- 28.8 kB
MenuItem -- 82.5 kB -- 25.9 kB
MenuList -- 70.7 kB -- 22.2 kB
MobileStepper -- 72.5 kB -- 22.8 kB
Modal -- 14.9 kB -- 5.23 kB
NativeSelect -- 81.5 kB -- 25.9 kB
NoSsr -- 2.18 kB -- 1.04 kB
OutlinedInput -- 79.3 kB -- 24.7 kB
Pagination -- 88.8 kB -- 27.4 kB
PaginationItem -- 85.1 kB -- 26.3 kB
Paper -- 67 kB -- 20.9 kB
Popover -- 87.6 kB -- 27.2 kB
Popper -- 28.7 kB -- 10.3 kB
Portal -- 2.87 kB -- 1.29 kB
Radio -- 87.5 kB -- 27.7 kB
RadioGroup -- 68.5 kB -- 21.3 kB
Rating -- 75.1 kB -- 24.2 kB
RootRef -- 4.62 kB -- 1.76 kB
ScopedCssBaseline -- 67.5 kB -- 21.2 kB
Select -- 120 kB -- 35.9 kB
Skeleton -- 67.7 kB -- 21.4 kB
Slide -- 30.4 kB -- 10.1 kB
Slider -- 80.5 kB -- 25.7 kB
Snackbar -- 80.2 kB -- 25.2 kB
SnackbarContent -- 68.2 kB -- 21.3 kB
SpeedDial -- 90.5 kB -- 28.7 kB
SpeedDialAction -- 122 kB -- 38.9 kB
SpeedDialIcon -- 69.2 kB -- 21.8 kB
Step -- 67.3 kB -- 21.2 kB
StepButton -- 86.6 kB -- 27.4 kB
StepConnector -- 67.4 kB -- 21.3 kB
StepContent -- 73.8 kB -- 23.1 kB
StepIcon -- 69.3 kB -- 21.6 kB
StepLabel -- 73.2 kB -- 22.7 kB
Stepper -- 69.5 kB -- 22 kB
styles/createMuiTheme -- 22.2 kB -- 7.69 kB
SvgIcon -- 67.7 kB -- 21.2 kB
SwipeableDrawer -- 96.7 kB -- 30.4 kB
Switch -- 85.7 kB -- 27 kB
Tab -- 80.6 kB -- 25.7 kB
Table -- 67.2 kB -- 21.1 kB
TableBody -- 66.8 kB -- 20.9 kB
TableCell -- 68.7 kB -- 21.7 kB
TableContainer -- 66.7 kB -- 20.9 kB
TableFooter -- 66.8 kB -- 20.9 kB
TableHead -- 66.8 kB -- 20.9 kB
TablePagination -- 147 kB -- 43.2 kB
TableRow -- 67.2 kB -- 21.1 kB
TableSortLabel -- 81.7 kB -- 25.9 kB
Tabs -- 89.6 kB -- 28.7 kB
TextareaAutosize -- 5.19 kB -- 2.17 kB
TextField -- 129 kB -- 37.9 kB
ToggleButton -- 80.5 kB -- 25.6 kB
ToggleButtonGroup -- 67.9 kB -- 21.4 kB
Toolbar -- 67 kB -- 21.1 kB
Tooltip -- 106 kB -- 33.6 kB
TreeItem -- 79.9 kB -- 25.4 kB
TreeView -- 73 kB -- 23 kB
Typography -- 68.3 kB -- 21.4 kB
useAutocomplete -- 16 kB -- 5.71 kB
useMediaQuery -- 2.56 kB -- 1.06 kB
Zoom -- 28.5 kB -- 9.59 kB

Generated by 🚫 dangerJS against 9e4ead4

@oliviertassinari oliviertassinari changed the title [docs] Added Component Name section to component documentation (#17245) [docs] Add Component Name section to API docs Apr 5, 2020
@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Apr 5, 2020
@oliviertassinari oliviertassinari changed the title [docs] Add Component Name section to API docs [docs] Add Component name section to API docs Apr 5, 2020
eps1lon
eps1lon previously requested changes Apr 6, 2020
@@ -344,7 +363,7 @@ function generateClasses(reactAPI) {
}

if (!reactAPI.styles.name) {
throw new Error(`Missing styles name on ${reactAPI.name} component`);
styleNameError(reactAPI.name);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need this indirection? Be aware that this adds another line to the stack trace.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. The generateClasses() and generateName() functions both throw the same custom error, and I wasn't sure on the preference for avoiding repetition, so I wrapped it in a function.

@oliviertassinari
Copy link
Member

@Josh-Weston It's a great first pull request on Material-UI 👌🏻. Thank you for working on it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document which component names can be used with theme.props
4 participants