UNPKG

8.21 kBMarkdownView Raw
1<p align="center">
2 <a href="https://material-ui.com/" rel="noopener" target="_blank"><img width="150" src="https://material-ui.com/static/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 for faster and easier web development. Build your own design system, or start with [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
30Material-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
35npm install @material-ui/core
36
37// with yarn
38yarn 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
45Please note that `@next` will only point to pre-releases; to get the latest stable release use `@latest` instead.
46
47## Who sponsors Material-UI?
48
49### Diamond 💎
50
51<p style="display: flex; justify-content: center;">
52 <a data-ga-event-category="sponsor" data-ga-event-action="logo" data-ga-event-label="sencha" href="https://www.sencha.com/products/extreact/extreact-for-material-ui/?utm_source=materialui&utm_medium=referral&utm_content=product-200429-extreactmaterialui" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img height="128" width="128" src="https://material-ui.com/static/in-house/sencha-256x256.png" alt="sencha" title="UI Components for Productive Dev Teams" loading="lazy" /></a>
53</p>
54
55Diamond Sponsors are those who have pledged $1,500/month or more to Material-UI.
56
57### Gold 🏆
58
59via [Patreon](https://www.patreon.com/oliviertassinari)
60
61<p style="display: flex; justify-content: center;">
62 <a data-ga-event-category="sponsor" data-ga-event-action="logo" data-ga-event-label="tidelift" href="https://tidelift.com/subscription/pkg/npm-material-ui?utm_source=npm-material-ui&utm_medium=referral&utm_campaign=homepage" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img height="96" width="96" src="https://github.com/tidelift.png?size=96" srcset="https://github.com/tidelift.png?size=192 2x" alt="tidelift" title="Enterprise-ready open source software" loading="lazy" /></a>
63 <a data-ga-event-category="sponsor" data-ga-event-action="logo" data-ga-event-label="bitsrc" href="https://bit.dev" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img height="96" width="96" src="https://github.com/teambit.png?size=96" srcset="https://github.com/teambit.png?size=192 2x" alt="bitsrc" title="The fastest way to share code" loading="lazy" /></a>
64</p>
65
66via [OpenCollective](https://opencollective.com/material-ui)
67
68<p style="display: flex; justify-content: center; flex-wrap: wrap;">
69 <a data-ga-event-category="sponsor" 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/callemall/a6946da/logo/96.png" srcset="https://images.opencollective.com/callemall/a6946da/logo/192.png 2x" alt="call-em-all" title="The easy way to message your group" height="96" width="96" loading="lazy"></a>
70 <a data-ga-event-category="sponsor" data-ga-event-action="logo" data-ga-event-label="canadacasino" href="https://www.canadacasino.ca/" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img height="96" width="96" src="https://images.opencollective.com/canadacasino/5b19004/logo/96.png" srcset="https://images.opencollective.com/canadacasino/5b19004/logo/192.png 2x" alt="bitsrc" title="" loading="lazy" /></a>
71</p>
72
73Gold Sponsors are those who have pledged $500/month or more to Material-UI.
74
75### There is more!
76
77See the full list of [our backers](https://material-ui.com/discover-more/backers/).
78
79## Usage
80
81Here is a quick example to get you started, **it's all you need**:
82
83```jsx
84import React from 'react';
85import ReactDOM from 'react-dom';
86import Button from '@material-ui/core/Button';
87
88function App() {
89 return (
90 <Button variant="contained" color="primary">
91 Hello World
92 </Button>
93 );
94}
95
96ReactDOM.render(<App />, document.querySelector('#app'));
97```
98
99Yes, it's really all you need to get started as you can see in this live and interactive demo:
100
101[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/4j7m47vlm4)
102
103## Questions
104
105For *how-to* questions and other non-issues,
106please use [StackOverflow](https://stackoverflow.com/questions/tagged/material-ui) instead of Github issues.
107There is a StackOverflow tag called "material-ui" that you can use to tag your questions.
108
109## Examples
110
111Are you looking for an example project to get started?
112[We host some](https://material-ui.com/getting-started/example-projects/).
113
114## Documentation
115
116Check out our [documentation website](https://material-ui.com/).
117
118## Premium Themes
119
120You can find complete templates & themes in the [Material-UI store](https://material-ui.com/store/?utm_source=docs&utm_medium=referral&utm_campaign=readme-store) .
121
122## Contributing
123
124Read 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.
125
126Notice that contributions go far beyond pull requests and commits.
127Although 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).
128
129## Changelog
130
131Recently Updated?
132Please read the [changelog](https://github.com/mui-org/material-ui/releases).
133
134## Roadmap
135
136The future plans and high priority features and enhancements can be found in the [roadmap](https://material-ui.com/discover-more/roadmap/) file.
137
138## License
139
140This project is licensed under the terms of the
141[MIT license](/LICENSE).