Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
180 lines
9.3 KiB
Markdown
180 lines
9.3 KiB
Markdown
<!-- #host-reference -->
|
||
<!-- markdownlint-disable-next-line -->
|
||
<p align="center">
|
||
<a href="https://mui.com/core/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="Material UI logo"></a>
|
||
</p>
|
||
|
||
<h1 align="center">Material UI</h1>
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/mui/material-ui/blob/HEAD/LICENSE)
|
||
[](https://www.npmjs.com/package/@mui/material)
|
||
[](https://www.npmjs.com/package/@mui/material)
|
||
[](https://www.npmjs.com/package/@mui/material)
|
||
[](https://github.com/mui/material-ui/commits/HEAD/)
|
||
[](https://app.codecov.io/gh/mui/material-ui/)
|
||
[](https://x.com/MaterialUI)
|
||
[](https://github.com/mui/material-ui/issues/27062)
|
||
[](https://isitmaintained.com/project/mui/material-ui 'Average time to resolve an issue')
|
||
[](https://opencollective.com/mui-org)
|
||
[](https://www.bestpractices.dev/projects/1320)
|
||
|
||
</div>
|
||
|
||
[Material UI](https://mui.com/material-ui/) is a comprehensive library of React components that features our independent implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.
|
||
It's trusted by some of the world's greatest product teams because it's been rigorously battle-tested through more than a decade of development by thousands of open-source contributors.
|
||
|
||
Material UI's core functionality is extended by [MUI X](https://github.com/mui/mui-x), a suite of complex components for advanced use cases.
|
||
|
||
## Documentation
|
||
|
||
Get started in the [Material UI documentation](https://mui.com/material-ui/getting-started/).
|
||
|
||
<details>
|
||
<summary>Older versions</summary>
|
||
|
||
- **[v5.x](https://v5.mui.com/)** ([Upgrading from v5 to v6](https://mui.com/material-ui/migration/upgrade-to-v6/))
|
||
- **[v4.x](https://v4.mui.com/)** ([Upgrading from v4 to v5](https://mui.com/material-ui/migration/migration-v4/))
|
||
- **[v3.x](https://v3.mui.com/)** ([Upgrading from v3 to v4](https://mui.com/material-ui/migration/migration-v3/))
|
||
- **[v0.x](https://v0.mui.com/)** ([Upgrading to v1](https://mui.com/material-ui/migration/migration-v0x/))
|
||
|
||
</details>
|
||
|
||
**Note:** `@next` points to pre-releases.
|
||
Use `@latest` for the latest stable release.
|
||
|
||
## Joy UI
|
||
|
||
This repository also contains Joy UI, an experimental component library that implements our own in-house Joy Design.
|
||
Joy UI is in beta and _development is currently on hold_.
|
||
When starting a new project from scratch, we recommend Material UI over Joy UI because we can guarantee ongoing support.
|
||
|
||
Keep in mind that the maintainers are primarily focused on other projects and may not be able to respond in a timely manner to issues or pull requests related to Joy UI.
|
||
|
||
View the [Joy UI documentation](https://mui.com/joy-ui/getting-started/).
|
||
|
||
## Sponsors
|
||
|
||
### Diamond 💎
|
||
|
||
<p>
|
||
<a href="https://www.doit.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="128" width="128" src="https://mui.com/static/sponsors/doit-square.svg" alt="doit" title="Management Platform for Google Cloud and AWS" loading="lazy" /></a>
|
||
</p>
|
||
|
||
Diamond sponsors are those who have pledged \$1,500/month or more to MUI.
|
||
|
||
### Gold 🏆
|
||
|
||
via [Open Collective](https://opencollective.com/mui-org) or via [Patreon](https://www.patreon.com/oliviertassinari)
|
||
|
||
<p>
|
||
<a href="https://tidelift.com/" rel="noopener sponsored" target="_blank"><img height="96" width="96" src="https://avatars.githubusercontent.com/u/30204434?s=288" alt="tidelift.com" title="Tidelift: Enterprise-ready open-source software." loading="lazy" /></a>
|
||
|
||
<a href="https://www.dialmycalls.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank"><img height="96" width="96" src="https://images.opencollective.com/dialmycalls/f5ae9ab/avatar/288.png" alt="dialmycalls.com" title="DialMyCalls: Send text messages, calls, and emails." loading="lazy" /></a>
|
||
|
||
<a href="https://ref.wisprflow.ai/ZSPYrru?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://mui.com/static/sponsors/wispr-square-dark.svg">
|
||
<source media="(prefers-color-scheme: light)" srcset="https://mui.com/static/sponsors/wispr-square-light.svg">
|
||
<img height="96" width="96" src="https://mui.com/static/sponsors/wispr-square-light.svg" alt="wisprflow" title="AI Dictation: from speech to clear, polished text." loading="lazy" />
|
||
</picture>
|
||
</a>
|
||
|
||
</p>
|
||
|
||
<p>
|
||
<a href="https://goread.io/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">Goread.io</a>
|
||
|
||
<a href="https://buzzoid.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">Buzzoid</a>
|
||
|
||
<a href="https://twicsy.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">Twicsy</a>
|
||
|
||
<a href="https://views4you.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">Views4You</a>
|
||
|
||
<a href="https://poprey.com/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">Poprey</a>
|
||
|
||
<a href="https://www.socialwick.com/instagram/followers/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">SocialWick</a>
|
||
|
||
<a href="https://www.follower24.de/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">Follower24</a>
|
||
|
||
<a href="https://reputationmanage.co/?utm_source=mui.com&utm_medium=referral&utm_content=readme" rel="noopener sponsored" target="_blank">Reputation Manage</a>
|
||
|
||
</p>
|
||
|
||
Gold sponsors are those who have pledged \$500/month or more to MUI.
|
||
|
||
### More backers
|
||
|
||
See the full list of [our backers](https://mui.com/material-ui/discover-more/backers/).
|
||
|
||
## Questions
|
||
|
||
For how-to questions that don't involve making changes to the code base, please use [Stack Overflow](https://stackoverflow.com/questions/) instead of GitHub issues.
|
||
|
||
## Examples
|
||
|
||
<!-- #target-branch-reference -->
|
||
|
||
Our documentation features [a collection of example projects](https://github.com/mui/material-ui/tree/master/examples).
|
||
|
||
## Premium templates
|
||
|
||
You can find complete templates and themes in the [MUI Store](https://mui.com/store/?utm_source=docs&utm_medium=referral&utm_campaign=readme-store).
|
||
|
||
## Contributing
|
||
|
||
Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.
|
||
|
||
Contributing is about more than just issues and pull requests!
|
||
There are many other ways to [support Material UI](https://mui.com/material-ui/getting-started/faq/#mui-is-an-awesome-organization-how-can-i-support-it) beyond contributing to the code base.
|
||
|
||
## Changelog
|
||
|
||
The [changelog](https://github.com/mui/material-ui/releases) is regularly updated to reflect what's changed in each new release.
|
||
|
||
## Roadmap
|
||
|
||
Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/material-ui/discover-more/roadmap/).
|
||
|
||
## License
|
||
|
||
This project is licensed under the terms of the [MIT license](/LICENSE).
|
||
|
||
## Security
|
||
|
||
For details on supported versions and contact information for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/security/policy).
|
||
|
||
## Sponsoring services
|
||
|
||
These great services sponsor MUI's core infrastructure:
|
||
|
||
<div>
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://mui.com/static/readme/github-darkmode.svg">
|
||
<source media="(prefers-color-scheme: light)" srcset="https://mui.com/static/readme/github-lightmode.svg">
|
||
<img alt="GitHub logo" src="https://mui.com/static/readme/github-lightmode.svg" width="80" height="43">
|
||
</picture>
|
||
|
||
[GitHub](https://github.com/) lets us host the Git repository and coordinate contributions.
|
||
|
||
</div>
|
||
|
||
<div>
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://mui.com/static/readme/netlify-darkmode.svg">
|
||
<source media="(prefers-color-scheme: light)" srcset="https://mui.com/static/readme/netlify-lightmode.svg">
|
||
<img alt="Netlify logo" src="https://mui.com/static/readme/netlify-lightmode.svg" width="100" height="27">
|
||
</picture>
|
||
|
||
[Netlify](https://www.netlify.com/) lets us distribute the documentation.
|
||
|
||
</div>
|
||
|
||
<div>
|
||
<img loading="lazy" alt="CodeCov logo" src="https://avatars.githubusercontent.com/u/8226205?s=105" width="35" height="35">
|
||
|
||
[CodeCov](https://about.codecov.io/) lets us monitor test coverage.
|
||
|
||
</div>
|