-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
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 'Supported Components' section #6329
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
# Supported Components | ||
|
||
The following list of Material Design components and features highlights | ||
those currently supported by Material-UI in bold. | ||
|
||
While we strive to follow the guidelines where practical (applying | ||
common sense where guidelines contadict - a more common occurence than | ||
one might expect), we do not expect to support every component, or every | ||
feature of every component, but rather to provide the building blocks to | ||
allow users to create compelling user interfaces and experiences. | ||
|
||
If you wish to add support for a component or feature not highlighted | ||
here, please search for the relevant [GitHub Issue](https://github.com/callemall/material-ui/issues), or create a new one | ||
to discuss the approach before submitting a PR. | ||
|
||
- **[App Bar](https://material.io/guidelines/layout/structure.html#structure-app-bar)** | ||
- [App shortcut icons](https://material.io/guidelines/style/icons.html#icons-app-shortcut-icons) | ||
- Icon | ||
- Avatar | ||
- Group avatar | ||
- **[Bottom navigation](https://www.google.com/design/spec/components/bottom-navigation.html)** | ||
- [Bottom sheets](https://www.google.com/design/spec/components/bottom-sheets.html) | ||
- **[Buttons](http://www.material-ui.com/#/components/buttons)** | ||
- **[Flat & raised buttons](https://www.google.com/design/spec/components/buttons.html#buttons-flat-raised-buttons)** | ||
- [Toggle buttons](https://www.google.com/design/spec/components/buttons.html#buttons-toggle-buttons) | ||
- **[Icon toggles](https://www.google.com/design/spec/components/buttons.html#buttons-toggle-buttons) (Custom Checkbox)** | ||
- [Dropdown: Mobile: Dropdown buttons](https://www.google.com/design/spec/components/buttons.html#buttons-dropdown-buttons) (DropDownMenu) | ||
- [Dropdown: Mobile: Generic overflow](https://www.google.com/design/spec/components/buttons.html#buttons-dropdown-buttons) | ||
- [Dropdown: Mobile: Segmented](https://www.google.com/design/spec/components/buttons.html#buttons-dropdown-buttons) | ||
- [Dropdown: Mobile: Editable segmented](https://www.google.com/design/spec/components/buttons.html#buttons-dropdown-buttons) | ||
- [Dropdown: Desktop: Dropdown buttons](https://www.google.com/design/spec/components/buttons.html#buttons-dropdown-buttons) | ||
- **[Buttons: Floating Action Button](https://www.google.com/design/spec/components/buttons-floating-action-button.html)** | ||
- **[Trigger](https://www.google.com/design/spec/components/buttons-floating-action-button.html#buttons-floating-action-button-transitions)** | ||
- [Toolbar](https://www.google.com/design/spec/components/buttons-floating-action-button.html#buttons-floating-action-button-transitions) | ||
- [Speed dial](https://www.google.com/design/spec/components/buttons-floating-action-button.html#buttons-floating-action-button-transitions) - #2851 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would avoid linking issues in the docs. I think that it would takes too much effort keeping it up to date. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oops, missed deleting that one (they're left over from the original issue #2863). |
||
- [Morph](http://www.google.com/design/spec/components/buttons-floating-action-button.html#buttons-floating-action-button-transitions) | ||
- [Full screen](http://www.google.com/design/spec/components/buttons-floating-action-button.html#buttons-floating-action-button-transitions) | ||
- **[Cards](https://www.google.com/design/spec/components/cards.html)** | ||
- **[Chips](https://www.google.com/design/spec/components/chips.html)** | ||
- **[Standard](https://www.google.com/design/spec/components/chips.html)** | ||
- [Contact](https://www.google.com/design/spec/components/chips.html#chips-contact-chips) | ||
- **[Data tables](https://www.google.com/design/spec/components/data-tables.html)** | ||
- **Sortable** | ||
- **Selectable** | ||
- Pagination | ||
- **[Dialogs](https://www.google.com/design/spec/components/dialogs.html)** | ||
- **[Alerts](https://www.google.com/design/spec/components/dialogs.html#dialogs-alerts)** | ||
- **[Simple menus](https://www.google.com/design/spec/components/dialogs.html#dialogs-simple-menus) (Menu)** | ||
- **[Simple dialogs](https://www.google.com/design/spec/components/dialogs.html#dialogs-simple-dialogs) (Can be constructed with Dialog and List.)** | ||
- **[Confirmation dialogs](https://www.google.com/design/spec/components/dialogs.html#dialogs-confirmation-dialogs)** | ||
- **[Full screen dialogs](https://www.google.com/design/spec/components/dialogs.html#dialogs-full-screen-dialogs)** | ||
- **[Dividers](https://www.google.com/design/spec/components/dividers.html)** | ||
- **[Full bleed](https://www.google.com/design/spec/components/dividers.html#dividers-types-of-dividers)** | ||
- **[Inset](https://www.google.com/design/spec/components/dividers.html#dividers-types-of-dividers)** | ||
- [Expansion Panels](https://www.google.com/design/spec/components/expansion-panels.html) | ||
- [Grid lists](https://www.google.com/design/spec/components/grid-lists.html) | ||
- **[Lists](https://www.google.com/design/spec/components/lists.html)** | ||
- **[Single line](https://www.google.com/design/spec/components/lists.html#lists-specs)** | ||
- **[Two line](https://www.google.com/design/spec/components/lists.html#lists-specs)** | ||
- [Three line](https://www.google.com/design/spec/components/lists.html#lists-specs) | ||
- **[Avatar](https://www.google.com/design/spec/components/lists.html#lists-specs)** | ||
- **[Icon](https://www.google.com/design/spec/components/lists.html#lists-specs)** | ||
- **[Lists: Controls](https://www.google.com/design/spec/components/lists-controls.html)** | ||
- **[Checkbox](https://www.google.com/design/spec/components/lists-controls.html#lists-controls-types-of-list-controls) (Primary only)** | ||
- **[Switch](https://www.google.com/design/spec/components/lists-controls.html#lists-controls-types-of-list-controls) (Toggle)** | ||
- [Reorder](https://www.google.com/design/spec/components/lists-controls.html#lists-controls-types-of-list-controls) | ||
- [Expand/collapse](https://www.google.com/design/spec/components/lists-controls.html#lists-controls-types-of-list-controls) | ||
- [Leave-behinds](https://www.google.com/design/spec/components/lists-controls.html#lists-controls-types-of-list-controls) | ||
- **[Menus](https://www.google.com/design/spec/components/menus.html)** | ||
- **[Button menu](https://www.google.com/design/spec/components/menus.html#menus-usage) (Can be constructed)** | ||
- [Scrollable](https://www.google.com/design/spec/components/menus.html#menus-usage) | ||
- [Cascade](https://www.google.com/design/spec/components/menus.html#menus-usage) | ||
- [Textfield dropdown](https://www.google.com/design/spec/components/menus.html#menus-behavior) (DropDownMenu) | ||
- [Contextual / App bar dropdown](https://www.google.com/design/spec/components/menus.html#menus-usage) (IconMenu) | ||
- **[Simple menus](https://www.google.com/design/spec/components/menus.html#menus-simple-menus) (Menu)** | ||
- [Pickers](https://www.google.com/design/spec/components/pickers.html) | ||
- [Date picker](https://www.google.com/design/spec/components/pickers.html#pickers-date-pickers) | ||
- [Time picker](https://www.google.com/design/spec/components/pickers.html#pickers-time-pickers) | ||
- **[Progress & activity](https://www.google.com/design/spec/components/progress-activity.html)** | ||
- **[Linear](https://www.google.com/design/spec/components/progress-activity.html#progress-activity-types-of-indicators)** | ||
- **[Circular](https://www.google.com/design/spec/components/progress-activity.html#progress-activity-types-of-indicators)** | ||
- **[Circular with integration](https://www.google.com/design/spec/components/progress-activity.html#progress-activity-types-of-indicators)** | ||
- **[Loading](https://www.google.com/design/spec/components/progress-activity.html#progress-activity-types-of-indicators)** | ||
- **[Selection controls](https://www.google.com/design/spec/components/selection-controls.html)** | ||
- **[Checkbox](https://www.google.com/design/spec/components/selection-controls.html#selection-controls-checkbox)** | ||
- **[Radio button](https://www.google.com/design/spec/components/selection-controls.html#selection-controls-radio-button)** | ||
- **[Switch](https://www.google.com/design/spec/components/selection-controls.html#selection-controls-switch)** | ||
- [Sliders](https://www.google.com/design/spec/components/sliders.html) | ||
- [Continuous](https://www.google.com/design/spec/components/sliders.html#sliders-continuous-slider) | ||
- [Discrete](https://www.google.com/design/spec/components/sliders.html#sliders-discrete-slider) | ||
- [Snackbars](https://www.google.com/design/spec/components/snackbars-toasts.html) | ||
- **[Subheaders](https://www.google.com/design/spec/components/subheaders.html)** | ||
- **[List](https://www.google.com/design/spec/components/subheaders.html#subheaders-list-subheaders)** | ||
- [Grid](https://www.google.com/design/spec/components/subheaders.html#subheaders-list-subheaders) | ||
- [Menu](https://www.google.com/design/spec/components/subheaders.html#subheaders-list-subheaders) | ||
- [Steppers](https://www.google.com/design/spec/components/steppers.html) | ||
- [Horizontal](https://www.google.com/design/spec/components/steppers.html#steppers-types-of-steppers) | ||
- [Vertical](https://www.google.com/design/spec/components/steppers.html#steppers-types-of-steppers) | ||
- **[Tabs](https://www.google.com/design/spec/components/tabs.html)** | ||
- Usage | ||
- **Mobile (Full width)** | ||
- **Desktop (Left aligned AKA Basic)** | ||
- **Centered** | ||
- [Dropdown](https://www.google.com/design/spec/components/tabs.html#tabs-usage) | ||
- [Overflow pagination](https://www.google.com/design/spec/components/tabs.html#tabs-usage) | ||
- Label | ||
- **[Text](https://www.google.com/design/spec/components/tabs.html#tabs-usage)** | ||
- **[Icon](https://www.google.com/design/spec/components/tabs.html#tabs-usage)** | ||
- **[Icon and text](https://www.google.com/design/spec/components/tabs.html#tabs-usage)** | ||
- **[Text fields](https://www.google.com/design/spec/components/text-fields.html)** | ||
- **[Single-line](https://www.google.com/design/spec/components/text-fields.html#text-fields-single-line-text-field)** | ||
- [Multi-line](https://www.google.com/design/spec/components/text-fields.html#text-fields-multi-line-text-field) | ||
- [Full-width](https://www.google.com/design/spec/components/text-fields.html#text-fields-multi-line-text-field) | ||
- [Character counter](https://www.google.com/design/spec/components/text-fields.html#text-fields-character-counter) | ||
- [Auto-complete](https://www.google.com/design/spec/components/text-fields.html#text-fields-auto-complete-text-field) | ||
- [Search filter](https://www.google.com/design/spec/components/text-fields.html#text-fields-search-filter) | ||
- [Password](https://www.google.com/design/spec/components/text-fields.html#text-fields-password-input) | ||
- [Toolbars](https://www.google.com/design/spec/components/toolbars.html) | ||
- [Tooltips](https://www.google.com/design/spec/components/tooltips.html) (IconButton & TableHeader only) | ||
- [Desktop](https://www.google.com/design/spec/components/tooltips.html#tooltips-tooltips-desktop-) | ||
- [Mobile](https://www.google.com/design/spec/components/tooltips.html#tooltips-tooltips-mobile-) | ||
- [Widgets](https://material.io/guidelines/components/widgets.html) | ||
- [Information widgets](https://material.io/guidelines/components/widgets.html#widgets-types-of-widgets) | ||
- [Collection widgets](https://material.io/guidelines/components/widgets.html#widgets-types-of-widgets) | ||
- [Control widgets](https://material.io/guidelines/components/widgets.html#widgets-types-of-widgets) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
those currently supported by Material-UI in **bold**.
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea, but bold is no substitute for the GutHub Markdown check-list. Is there a better alternative?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unicode to the rescue: ✓