1 | <p align="center">
|
2 | <a href="https://material-ui.com/" rel="noopener" target="_blank"><img width="150" src="https://material-ui.com/static/images/material-ui-logo.svg" alt="Material-UI logo"></a></p>
|
3 | </p>
|
4 |
|
5 | <h1 align="center">Material-UI</h1>
|
6 |
|
7 | <div align="center">
|
8 |
|
9 | [React](https://reactjs.org/) components that implement [Google's Material Design](https://material.io/design/introduction/).
|
10 |
|
11 | [![npm package](https://img.shields.io/npm/v/@material-ui/core/latest.svg)](https://www.npmjs.com/package/@material-ui/core)
|
12 | [![npm downloads](https://img.shields.io/npm/dm/@material-ui/core.svg)](https://www.npmjs.com/package/@material-ui/core)
|
13 | [![CircleCI](https://img.shields.io/circleci/project/github/mui-org/material-ui/master.svg)](https://circleci.com/gh/mui-org/material-ui/tree/master)
|
14 | [![Build Status](https://dev.azure.com/mui-org/Material-UI/_apis/build/status/mui-org.material-ui?branchName=master)](https://dev.azure.com/mui-org/Material-UI/_build/latest?definitionId=1&branchName=master)
|
15 | [![Coverage Status](https://img.shields.io/codecov/c/github/mui-org/material-ui/master.svg)](https://codecov.io/gh/mui-org/material-ui/branch/master)
|
16 | [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1320/badge)](https://bestpractices.coreinfrastructure.org/projects/1320)
|
17 | ![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)
|
18 | [![Follow on Twitter](https://img.shields.io/twitter/follow/MaterialUI.svg?label=follow+Material-UI)](https://twitter.com/MaterialUI)
|
19 | [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=mui-org/material-ui)](https://dependabot.com)
|
20 | [![PeerDependencies](https://david-dm.org/mui-org/material-ui/master/peer-status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?type=peer&path=packages/material-ui)
|
21 | [![Dependencies](https://david-dm.org/mui-org/material-ui/master/status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?path=packages/material-ui)
|
22 | [![DevDependencies](https://david-dm.org/mui-org/material-ui/master/dev-status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?type=dev)
|
23 | [![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/mui-org/material-ui.svg)](https://isitmaintained.com/project/mui-org/material-ui "Average time to resolve an issue")
|
24 | [![Crowdin](https://d322cqt584bo4o.cloudfront.net/material-ui-docs/localized.svg?cache=v1)](https://translate.material-ui.com/project/material-ui-docs)
|
25 |
|
26 | </div>
|
27 |
|
28 | ## Installation
|
29 |
|
30 | Material-UI is available as an [npm package](https://www.npmjs.com/package/@material-ui/core).
|
31 |
|
32 | **[Stable channel v4](https://material-ui.com/)**
|
33 | ```sh
|
34 | // with npm
|
35 | npm install @material-ui/core
|
36 |
|
37 | // with yarn
|
38 | yarn add @material-ui/core
|
39 | ```
|
40 |
|
41 | **[v3.x](https://v3.material-ui.com/)** ([Migration from v3 to v4](https://material-ui.com/guides/migration-v3/))
|
42 |
|
43 | **[v0.x](https://v0.material-ui.com/)** ([Migration to v1](https://material-ui.com/guides/migration-v0x/))
|
44 |
|
45 | Please note that `@next` will only point to pre-releases; to get the latest stable release use `@latest` instead.
|
46 |
|
47 | ## Supporting Material-UI
|
48 |
|
49 | Material-UI is an MIT-licensed open source project. It's an independent project with ongoing development helped by the support of these awesome [backers](https://material-ui.com/discover-more/backers/). If you'd like to join them, please consider:
|
50 | - [Become a backer or sponsor on Patreon](https://www.patreon.com/oliviertassinari).
|
51 | - [Become a backer or sponsor on OpenCollective](https://opencollective.com/material-ui).
|
52 |
|
53 | #### What's the difference between Patreon and OpenCollective?
|
54 |
|
55 | Funds donated via Patreon directly support [Olivier Tassinari](https://github.com/oliviertassinari)'s work on Material-UI.
|
56 | Funds donated via OpenCollective are managed transparently and will be used for compensating work and expenses for core team members.
|
57 | Your name/logo will receive proper recognition and exposure by donating on either platform.
|
58 |
|
59 | ### Gold Sponsors
|
60 |
|
61 | Gold Sponsors are those who have pledged $500/month and more to Material-UI.
|
62 |
|
63 | via [Patreon](https://www.patreon.com/oliviertassinari)
|
64 |
|
65 | <p style="display: flex; justify-content: center;">
|
66 | <a data-ga-event-category="sponsors" data-ga-event-action="logo" data-ga-event-label="creative-tim" href="https://www.creative-tim.com/?partner=104080" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img width="126" src="https://github.com/creativetimofficial.png?size=126" alt="creative-tim" title="Premium Themes"></a>
|
67 | <a data-ga-event-category="sponsors" data-ga-event-action="logo" data-ga-event-label="tidelift" href="https://tidelift.com/subscription/pkg/npm-material-ui?utm_source=material_ui&utm_medium=referral&utm_campaign=homepage" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img width="96" src="https://github.com/tidelift.png?size=96" alt="tidelift" title="Get Professionally Supported Material-UI"></a>
|
68 | <a data-ga-event-category="sponsors" data-ga-event-action="logo" data-ga-event-label="bitsrc" href="https://bit.dev" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img width="96" src="https://github.com/teambit.png?size=96" alt="bitsrc" title="The fastest way to share code"></a>
|
69 | </p>
|
70 |
|
71 | via [OpenCollective](https://opencollective.com/material-ui)
|
72 |
|
73 | <p style="display: flex; justify-content: center; flex-wrap: wrap;">
|
74 | <a data-ga-event-category="sponsors" data-ga-event-action="logo" data-ga-event-label="callemall" href="https://www.call-em-all.com" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img src="https://images.opencollective.com/proxy/images?src=https%3A%2F%2Fopencollective-production.s3-us-west-1.amazonaws.com%2Ff4053300-e0ea-11e7-acf0-0fa7c0509f4e.png&height=100" alt="callemall" title="The easy way to message your group" width="100" loading="lazy"></a>
|
75 | <a data-ga-event-category="sponsors" data-ga-event-action="logo" data-ga-event-label="callemall" href="https://www.crosswordsolver.com" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img src="https://images.opencollective.com/crosswordsolver/avatar.png" alt="crosswordsolver" title="Crossword Puzzle Solver" width="100" loading="lazy"></a>
|
76 | </p>
|
77 |
|
78 | ### There is more!
|
79 |
|
80 | See the full list of [our backers](https://material-ui.com/discover-more/backers/).
|
81 |
|
82 | ## Usage
|
83 |
|
84 | Here is a quick example to get you started, **it's all you need**:
|
85 |
|
86 | ```jsx
|
87 | import React from 'react';
|
88 | import ReactDOM from 'react-dom';
|
89 | import Button from '@material-ui/core/Button';
|
90 |
|
91 | function App() {
|
92 | return (
|
93 | <Button variant="contained" color="primary">
|
94 | Hello World
|
95 | </Button>
|
96 | );
|
97 | }
|
98 |
|
99 | ReactDOM.render(<App />, document.querySelector('#app'));
|
100 | ```
|
101 |
|
102 | Yes, it's really all you need to get started as you can see in this live and interactive demo:
|
103 |
|
104 | [![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/4j7m47vlm4)
|
105 |
|
106 | ## Questions
|
107 |
|
108 | For *how-to* questions and other non-issues,
|
109 | please use [StackOverflow](https://stackoverflow.com/questions/tagged/material-ui) instead of Github issues.
|
110 | There is a StackOverflow tag called "material-ui" that you can use to tag your questions.
|
111 |
|
112 | ## Examples
|
113 |
|
114 | Are you looking for an example project to get started?
|
115 | [We host some](https://material-ui.com/getting-started/example-projects/).
|
116 |
|
117 | ## Documentation
|
118 |
|
119 | Check out our [documentation website](https://material-ui.com/).
|
120 |
|
121 | ## Premium Themes
|
122 |
|
123 | You can find complete templates & themes in our [premium themes](https://themes.material-ui.com/) section.
|
124 |
|
125 | ## Contributing
|
126 |
|
127 | Read our [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Material-UI.
|
128 |
|
129 | Notice that contributions go far beyond pull requests and commits.
|
130 | Although we love giving you the opportunity to put your stamp on Material-UI, we also are thrilled to receive a variety of [other contributions](https://material-ui.com/getting-started/faq/#material-ui-is-awesome-how-can-i-support-the-project).
|
131 |
|
132 | ## Changelog
|
133 |
|
134 | Recently Updated?
|
135 | Please read the [changelog](https://github.com/mui-org/material-ui/releases).
|
136 |
|
137 | ## Roadmap
|
138 |
|
139 | The future plans and high priority features and enhancements can be found in the [roadmap](https://material-ui.com/discover-more/roadmap/) file.
|
140 |
|
141 | ## Thanks
|
142 |
|
143 | Material-UI is only made possible thanks to these great services that sponsor our core infrastructure:
|
144 |
|
145 | [<img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png" width="100">](https://github.com/)
|
146 |
|
147 | GitHub allows us to host the Git repository.
|
148 |
|
149 | [<img src="https://assets.brandfolder.com/otz6k5-cj8pew-e4rk9u/element.png?v=1501538594" width="120">](https://circleci.com/)
|
150 |
|
151 | CircleCI allows us to run the test suite.
|
152 |
|
153 | [<img src="https://cdn.netlify.com/15ecf59b59c9d04b88097c6b5d2c7e8a7d1302d0/1b6d6/img/press/logos/full-logo-light.svg" width="120">](https://www.netlify.com/)
|
154 |
|
155 | Netlify allows us to distribute the documentation.
|
156 |
|
157 | [<img src="https://support.crowdin.com/assets/logos/crowdin-logo1-small.png" width="120">](https://crowdin.com/)
|
158 |
|
159 | CrowdIn allows us to translate the documentation.
|
160 |
|
161 | [<img src="https://www.browserstack.com/images/mail/browserstack-logo-footer.png" width="120">](https://www.browserstack.com/)
|
162 |
|
163 | BrowserStack allows us to test in real browsers.
|
164 |
|
165 | [<img src="https://raw.githubusercontent.com/codecov/media/master/logos/icon-50.png" height="30">](https://codecov.io/)
|
166 |
|
167 | CodeCov allows us to monitor the test coverage.
|
168 |
|
169 | ## License
|
170 |
|
171 | This project is licensed under the terms of the
|
172 | [MIT license](/LICENSE).
|