-
-
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
[docs] Add 'Supported Components' section #6329
Conversation
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.
💯 for this new section in the documentation. We might forget to update it from time to time.
# Supported Components | ||
|
||
The following list of Material Design components and features highlights | ||
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.
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: ✓
- **[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 comment
The 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.
At least, this is not a real link once rendered by the documentation.
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.
Oops, missed deleting that one (they're left over from the original issue #2863).
Well, we aren't adding any more components or features to |
@mbrookes is the new app bar: bottom inset fab (https://material.io/design/components/app-bars-bottom.html#anatomy) available? In the MUI docs I find the simple app bar only. |
No. You could certainly compose it if you didn’t need the scroll animation, but it isn’t there out of the box. Fell free to submit a PR to show that variant as unsupported. |
tests/ docs demo, and is linted.This PR is currently just for discussion.
Generic markdown doesn't support the GitHub checklist such as that above, so I have used bold to highlight supported components. Unfortunately it isn't as clear as in the issue I created for
master
for the same purposes (#2863).I'm open to suggestions as to how better format this page.
Edit: Also contains some snark about the guidelines - happy to take that out, but it would be nice if there was some other avenue for feedback to Google to get some of the more obvious issues fixed!