material-ui Documentation

Material UI: Comprehensive React component library that implements Google's Material Design. Free forever.

98,753 stars JavaScript JavaScript 1 file · ~2,698 tokens #design-system#material-design#material-ui#react#react-components
RAW Doc

1. Project Overview & Quickstart (mui/material-ui)

File: README.md

Material UI

Material UI is a comprehensive library of React components that features our independent implementation of Google's Material Design 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, a suite of complex components for advanced use cases.

Documentation

Get started in the Material UI documentation.

Older versions

Note: @next points to pre-releases.
Use @latest for the latest stable release.

Sponsors

Diamond 💎

Diamond sponsors are those who have pledged $1,500/month or more to MUI.

Gold 🏆

via Open Collective or via Patreon


 

 

Goread.io
 
Buzzoid
 
Twicsy
 
Poprey
 
SocialWick
 
Follower24
 
Views4You
 

Gold sponsors are those who have pledged $500/month or more to MUI.

More backers

See the full list of our backers.

Questions

For how-to questions that don't involve making changes to the code base, please use Stack Overflow instead of GitHub issues.

Examples

Our documentation features a collection of example projects.

Premium templates

You can find complete templates and themes in the MUI Store.

Contributing

Read the contributing guide 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 beyond contributing to the code base.

Changelog

The changelog 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.

License

This project is licensed under the terms of the MIT license.

Security

For details on supported versions and contact information for reporting security issues, please refer to the security policy.

Sponsoring services

These great services sponsor MUI's core infrastructure:

GitHub lets us host the Git repository and coordinate contributions.

Netlify lets us distribute the documentation.

CodeCov lets us monitor test coverage.


File: docs/README.md

Docs

This is the website of the company MUI and the documentation for Material UI.

To start the docs site in development mode, from the project root, run:

bash
pnpm docs:dev

If you do not have pnpm installed, select your OS and follow the instructions on the pnpm website.

Package managers other than pnpm (like npm or Yarn) are not supported and will not work.

How can I add a new demo to the documentation?

You can follow this guide
on how to get started contributing to MUI.

How do I help to improve the translations?

Please visit https://crowdin.com/project/material-ui-docs where you will be able to select a language and edit the translations.
Please don't submit pull requests directly.

2. Official Technical Reference & Guides (mui/material-ui-docs)

File: README.md

Material UI

Material UI is a comprehensive library of React components that features our independent implementation of Google's Material Design 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, a suite of complex components for advanced use cases.

Documentation

Get started in the Material UI documentation.

Older versions

Note: @next points to pre-releases.
Use @latest for the latest stable release.

Sponsors

Diamond 💎

Diamond sponsors are those who have pledged $1,500/month or more to MUI.

Gold 🏆

via Open Collective or via Patreon


 

 

Goread.io
 
Buzzoid
 
Twicsy
 
Poprey
 
SocialWick
 
Follower24
 
Views4You
 

Gold sponsors are those who have pledged $500/month or more to MUI.

More backers

See the full list of our backers.

Questions

For how-to questions that don't involve making changes to the code base, please use Stack Overflow instead of GitHub issues.

Examples

Our documentation features a collection of example projects.

Premium templates

You can find complete templates and themes in the MUI Store.

Contributing

Read the contributing guide 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 beyond contributing to the code base.

Changelog

The changelog 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.

License

This project is licensed under the terms of the MIT license.

Security

For details on supported versions and contact information for reporting security issues, please refer to the security policy.

Sponsoring services

These great services sponsor MUI's core infrastructure:

GitHub lets us host the Git repository and coordinate contributions.

Netlify lets us distribute the documentation.

CodeCov lets us monitor test coverage.


File: docs/README.md

Docs

This is the website of the company MUI and the documentation for Material UI.

To start the docs site in development mode, from the project root, run:

bash
pnpm docs:dev

If you do not have pnpm installed, select your OS and follow the instructions on the pnpm website.

Package managers other than pnpm (like npm or Yarn) are not supported and will not work.

How can I add a new demo to the documentation?

You can follow this guide
on how to get started contributing to MUI.

How do I help to improve the translations?

Please visit https://crowdin.com/project/material-ui-docs where you will be able to select a language and edit the translations.
Please don't submit pull requests directly.