MUI Core

**MUI Core** contains foundational React UI component libraries for shipping new features faster. - [_Material UI_](https://mui.com/material-ui/getting-started/overview/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://material.io/design/introduction/) system. - [_Joy UI_](https://mui.com/joy-ui/getting-started/overview/) is a beautifully designed library of React UI components. - [_MUI Base_](https://mui.com/base/getting-started/overview/) is our library of "unstyled" components and low-level hooks. With Base, you gain complete control over your app's CSS and accessibility features. - [_MUI System_](https://mui.com/system/getting-started/overview/) is a collection of CSS utilities to help you rapidly lay out custom designs.

**[Stable channel v5](https://mui.com/)** [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE) [![npm latest package](https://img.shields.io/npm/v/@mui/material/latest.svg)](https://www.npmjs.com/package/@mui/material) [![npm next package](https://img.shields.io/npm/v/@mui/material/next.svg)](https://www.npmjs.com/package/@mui/material) [![npm downloads](https://img.shields.io/npm/dm/@mui/material.svg)](https://www.npmjs.com/package/@mui/material) [![CircleCI](https://circleci.com/gh/mui/material-ui/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/mui/material-ui?branch=master) [![Coverage Status](https://img.shields.io/codecov/c/github/mui/material-ui/master.svg)](https://codecov.io/gh/mui/material-ui/branch/master) [![Follow on Twitter](https://img.shields.io/twitter/follow/MUI_hq.svg?label=follow+MUI)](https://twitter.com/MUI_hq) [![Renovate status](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/mui/material-ui/issues/27062) [![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/mui/material-ui.svg)](https://isitmaintained.com/project/mui/material-ui 'Average time to resolve an issue') [![Crowdin](https://badges.crowdin.net/material-ui-docs/localized.svg)](https://translate.mui.com/project/material-ui-docs) [![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/mui)](https://opencollective.com/mui)

## Installation ### Material UI Material UI is available as an [npm package](https://www.npmjs.com/package/@mui/material). **npm:** ```sh npm install @mui/material @emotion/react @emotion/styled ``` **yarn:** ```sh yarn add @mui/material @emotion/react @emotion/styled ```

Older versions

- **[v4.x](https://v4.mui.com/)** ([Migration from v4 to v5](https://mui.com/material-ui/migration/migration-v4/)) - **[v3.x](https://v3.mui.com/)** ([Migration from v3 to v4](https://mui.com/material-ui/migration/migration-v3/)) - **[v0.x](https://v0.mui.com/)** ([Migration to v1](https://mui.com/material-ui/migration/migration-v0x/))

**Note:** `@next` only points to pre-releases. Use `@latest` for the latest stable release. ### MUI Base MUI Base is available as an [npm package](https://www.npmjs.com/package/@mui/base). **npm:** ```sh npm install @mui/base ``` **yarn:** ```sh yarn add @mui/base ``` **Note**: MUI Base is still in alpha. We are adding new components regularly and you're welcome to contribute! ### MUI System MUI System is available as an [npm package](https://www.npmjs.com/package/@mui/system). **npm:** ```sh npm install @mui/system @emotion/react @emotion/styled ``` **yarn:** ```sh yarn add @mui/system @emotion/react @emotion/styled ``` Or if you want to use `styled-components` as a styling engine: **npm:** ```sh npm install @mui/material @mui/styled-engine-sc styled-components ``` **yarn:** ```sh yarn add @mui/material @mui/styled-engine-sc styled-components ``` Visit our [`styled-engine` guide](https://mui.com/material-ui/guides/styled-engine/) for more information about how to configure `styled-components` as the style engine. ## Sponsors ### Diamond 💎

Diamond Sponsors are those who have pledged \$1,500/month or more to MUI. ### Gold 🏆 via [OpenCollective](https://opencollective.com/mui) or via [Patreon](https://www.patreon.com/oliviertassinari)

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/). ## Getting started with Material UI Here is an example of a basic app using Material UI's `Button` component: ```jsx import * as React from 'react'; import Button from '@mui/material/Button'; function App() { return ; } ``` In the interactive demo below, try changing the code and see how it affects the output. (Hint: change `variant` to `"outlined"` and `color` to `"secondary"`. For more options, see the [`Button` component page](https://mui.com/material-ui/react-button/) in our docs.) [![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/material-ui-u9sy1h) ## Questions For how-to questions that don't involve making changes to the code base, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/mui) instead of GitHub issues. Use the "mui" tag on Stack Overflow to make it easier for the community to find your question. ## Examples Our documentation features [a collection of example projects using Material UI](https://mui.com/material-ui/getting-started/example-projects/). ## Documentation - [Material UI](https://mui.com/material-ui/getting-started/overview/) - [Joy UI](https://mui.com/joy-ui/getting-started/overview/) - [MUI Base](https://mui.com/base/getting-started/overview/) - [MUI System](https://mui.com/system/getting-started/overview/) ## Premium themes 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 to MUI Core is about more than just issues and pull requests! There are many other ways to [support MUI](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) 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 our [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 of supported versions and contact details for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/blob/master/SECURITY.md). ## Sponsoring services These great services sponsor MUI's core infrastructure:

[GitHub](https://github.com/) lets us host the Git repository and coordinate contributions.

[Netlify](https://www.netlify.com/) lets us distribute the documentation.

[Crowdin](https://crowdin.com/) lets us translate the documentation.

[BrowserStack](https://www.browserstack.com/) lets us test in real browsers.

[CodeCov](https://about.codecov.io/) lets us monitor test coverage.