-
-
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 "Overview" page to Material UI docs #32643
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
5833a12
material ui overview page first draft
78f05ab
prettier, i18n
9c1bb99
add material ui overview links to base overview, info callout
a2b1c54
Update docs/data/material/getting-started/overview/overview.md
samuelsycamore c6bd010
Update docs/data/material/getting-started/overview/overview.md
samuelsycamore 5a0a8bf
Update docs/data/material/getting-started/overview/overview.md
samuelsycamore 3947a73
Update docs/data/material/getting-started/overview/overview.md
samuelsycamore 587d093
fix formatting
oliviertassinari 227e8a7
official name
oliviertassinari c1a71b3
Update docs/data/base/getting-started/overview/overview.md
samuelsycamore f361de6
Update docs/data/base/getting-started/overview/overview.md
samuelsycamore 5f6f456
Update docs/data/material/getting-started/overview/overview.md
samuelsycamore a85baf6
Update docs/data/material/getting-started/overview/overview.md
samuelsycamore 6b11852
Update docs/data/material/getting-started/overview/overview.md
samuelsycamore 76a4354
Update docs/data/base/getting-started/overview/overview.md
samuelsycamore 918eb01
Update docs/data/base/getting-started/overview/overview.md
samuelsycamore e93175f
Update docs/data/base/getting-started/overview/overview.md
samuelsycamore 7d73d0d
merge master
samuelsycamore baf30f9
reviving, design kits, note about md v3
samuelsycamore ba673d2
revise md 3 note
samuelsycamore File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Material UI - Overview | ||
|
||
<p class="description">Material UI is library of React UI components that implements Google's Material Design.</p> | ||
|
||
## Introduction | ||
|
||
Material UI is an open-source React component library that implements Google's [Material Design](https://material.io/). | ||
|
||
It includes a comprehensive collection of prebuilt components that are ready for use in production right out of the box. | ||
|
||
Material UI is beautiful by design, and features a suite of customization options that make it easy to implement your own custom design system on top of our components. | ||
samuelsycamore marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
:::info | ||
Material UI currently supports Material Design v2. | ||
Adoption of v3 is tentatively planned for Material UI v6. | ||
You can follow [this GitHub issue](https://github.com/mui/material-ui/issues/29345) for future updates. | ||
::: | ||
|
||
samuelsycamore marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Advantages of Material UI | ||
|
||
- **Ship faster:** thousands of open-source contributors have poured countless hours into these components. Focus on your core business logic—we've got your UI covered. | ||
- **Beautiful by default:** we're meticulous about our implementation of Material Design, ensuring that every Material UI component meets the highest standards of form and function. | ||
samuelsycamore marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- **Cross-team collaboration:** Material UI's intuitive developer experience reduces the barrier to entry for back-end devs and less technical designers, empowering teams to collaborate more effectively. | ||
samuelsycamore marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- **Reliability:** Material UI is almost as old as React itself—its history stretches back to 2014—and we're in this for the long haul. When you build with Material UI, you can count on our community's support for years to come. | ||
- **Design kits:** streamline your workflow and boost consistency between designers and developers by using our [design kits](https://mui.com/design-kits/) in your favorite design tool. | ||
|
||
## Material UI vs. MUI Base | ||
|
||
Material UI and [MUI Base](/base/getting-started/overview/) feature many of the same UI components, but MUI Base comes without any default styles or styling solution. | ||
|
||
Material UI is _comprehensive_ in that it comes packaged with default styles, and is optimized to work with [Emotion](https://emotion.sh/docs/introduction) (or [styled-components](https://styled-components.com/)). | ||
|
||
MUI Base, by contrast, could be considered the "skeletal" or "headless" counterpart to Material UI—in fact, Material UI v6 will use MUI Base components and hooks for its foundational structure. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import * as React from 'react'; | ||
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; | ||
import { | ||
demos, | ||
docs, | ||
demoComponents, | ||
} from 'docs/data/material/getting-started/overview/overview.md?@mui/markdown'; | ||
|
||
export default function Page() { | ||
return <MarkdownDocs demos={demos} docs={docs} demoComponents={demoComponents} />; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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.
We take the risk to forget to update "version 2" with Material UI v6 which would cover Material Design v3 if everything goes smoothly.
If we really want to mention a version, then I think that we should rephrase it, in the current wording, it could sounds like v2 is our ultimate goal. Instead, we could say something around "currently v2". e.g.
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'm confused about what's the intended direction regarding Material's v3, it doesn't seem to exist alignment in this matter — see #32643 (comment)
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.
Here's what I've added based on my understanding of the situation—please correct me if I'm wrong:
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.
Alternatively: we could always just leave this out completely if we aren't prepared to say yes or no to v3 adoption. 😅