material-ui README

The project's README from github.com/mui/material-ui. As one markdown file: README.md.

Material UI logo

Material UI

license npm latest package npm next package npm downloads GitHub branch status Coverage Status Follow on X Renovate status Average time to resolve an issue Open Collective backers and sponsors OpenSSF Best Practices

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 💎

doit

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

Gold 🏆

via Open Collective or via Patreon

tidelift.com   dialmycalls.com  

Goread.io   Buzzoid   Twicsy   Poprey   SocialWick   Follower24   Views4You   DaoSMM  

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 logo

GitHub lets us host the Git repository and coordinate contributions.

Netlify logo

Netlify lets us distribute the documentation.

CodeCov logo

CodeCov lets us monitor test coverage.

material-ui (mui/material-ui)

Searching Database…

What is this?Material UI is a comprehensive library of React components implementing Google's Material Design system, used to build web UIs quickly with pre-built buttons, inputs, dialogs, and more.
Is it a framework or a component library?It's a component library, not a framework: you import ready-made React components into your own app rather than structuring your whole project around it. A separate suite, MUI X, extends it with more advanced components.
How do I add it to a project?Install it via your package manager and follow the getting-started guide in the Material UI documentation to import and use components in a React app.
Do I need anything besides React to use it?You need a React project; the repo itself is built and managed with pnpm (version 12.3.4) and Node >=22.23.2 for development, though consuming the library just requires npm/yarn/pnpm.
Is upgrading between major versions straightforward?No, each major version bump (v3 to v4, v4 to v5, v5 to v6) has its own dedicated upgrade guide, implying breaking changes between versions.
How mature is this project?It has been developed for over a decade with thousands of open-source contributors and is battle-tested by major product teams.
Where can I find full apps built with it?The documentation includes a collection of example projects, and the MUI Store offers complete premium templates and themes built with Material UI.
Where should I ask usage questions instead of filing GitHub issues?For how-to questions that don't require code changes, the project asks you to use Stack Overflow rather than GitHub issues.
Creator
mui
Size
730.7 MB
Stars
99.2K
Age
12y
Commits · 90 Days