11 KiB
Material-UI
React components for faster and simpler web development. Build your own design system, or start with Material Design.
Installation
Material-UI is available as an npm package.
// with npm
npm install @material-ui/core
// with yarn
yarn add @material-ui/core
⚠️ All ongoing work has moved to v5. The development of v4 is limited to important bug fixes, security patches and easing the upgrade path to v5.
// with npm
npm install @material-ui/core@next
// with yarn
yarn add @material-ui/core@next
Older versions
Please note that @next will only point to pre-releases; to get the latest stable release use @latest instead.
Who sponsors Material-UI?
Diamond 💎
Diamond Sponsors are those who have pledged $1,500/month or more to Material-UI.
Gold 🏆
via Patreon
via OpenCollective
Direct
Gold Sponsors are those who have pledged $500/month or more to Material-UI.
There is more!
See the full list of our backers.
Usage
Here is a quick example to get you started, it's all you need:
import React from 'react';
import ReactDOM from 'react-dom';
import Button from '@material-ui/core/Button';
function App() {
return <Button variant="contained">Hello World</Button>;
}
ReactDOM.render(<App />, document.querySelector('#app'));
Yes, it's really all you need to get started as you can see in this live and interactive demo:
Questions
For how-to questions and other non-issues, please use StackOverflow instead of GitHub issues. There is a StackOverflow tag called "material-ui" that you can use to tag your questions.
Examples
Are you looking for an example project to get started? We host some.
Documentation
Check out our documentation website.
Premium Themes
You can find complete templates & themes in the Material-UI store.
Contributing
Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Material-UI.
Notice that contributions go far beyond pull requests and commits. 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.
Changelog
If you have recently updated, please read the changelog for details of what has changed.
Roadmap
The future plans and high priority features and enhancements can be found in the roadmap file.
License
This project is licensed under the terms of the MIT license.
Sponsoring services
These great services sponsor Material-UI's core infrastructure:
GitHub allows us to host the Git repository.
CircleCI allows us to run the test suite.
Netlify allows us to distribute the documentation.
CrowdIn allows us to translate the documentation.
BrowserStack allows us to test in real browsers.
CodeCov allows us to monitor the test coverage.