React components that implement Google's Material Design.
Branch: next
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci [core] Use frozen-lockfile by default (#14433) Feb 6, 2019
.github [test] Back to 100% test coverage (#14458) Feb 8, 2019
docs [examples] Improve the Gastby integration (#14552) Feb 16, 2019
examples [examples] Improve the Gastby integration (#14552) Feb 16, 2019
modules [core] Fix the CDN release (#14172) Jan 14, 2019
packages [docs] Fix css anchor link (#14554) Feb 16, 2019
pages [docs] Fix css anchor link (#14554) Feb 16, 2019
scripts [core] Fix Prettier on next branch (#14524) Feb 14, 2019
static [docs] Add banner for next docs releases (#14497) Feb 12, 2019
test [core] Remove recompose (#14479) Feb 10, 2019
.browserslistrc [core] Drop node 6 support (#14379) Feb 2, 2019
.codecov.yml [core] Move to the packages structure (#11033) Apr 16, 2018
.editorconfig [.editorconfig] Add max_line_length (#9580) Dec 20, 2017
.eslintignore [docs] AppBar and Textfield demos in TypeScript (#13229) Jan 31, 2019
.eslintrc.js [utils] Add support for forwardRef components in getDisplayName (#14429) Feb 6, 2019
.gitattributes Add gitattributes Dec 12, 2014
.gitignore [examples] Improve the Gastby integration (#14552) Feb 16, 2019
.size-limit.js [Modal] Improve the focus logic (#14545) Feb 16, 2019
.tidelift.yml [test] Tidelift - skip checking nomnom & os-locale (#13157) Oct 8, 2018
.yarnrc [core] Use frozen-lockfile by default (#14433) Feb 6, 2019
BACKERS.md [docs] Add banner for next docs releases (#14497) Feb 12, 2019
CHANGELOG.md [docs] Update CHANGELOG.md (#14516) Feb 13, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Aug 9, 2017
CONTRIBUTING.md [core] Upgrade the dev dependencies (#14463) Feb 8, 2019
GOVERNANCE.md [test] Back to 100% test coverage (#14458) Feb 8, 2019
LICENSE Initial commit Aug 18, 2014
README.md [docs] next.material-ui.com Feb 12, 2019
ROADMAP.md [docs] More transparency around the release strategy (#12752) Sep 3, 2018
SUPPORT.md Update SUPPORT.md (#9702) Jan 2, 2018
babel.config.js [core] Improve tree-shakeability (#13391) Feb 3, 2019
crowdin.yml Update Crowdin configuration file Feb 6, 2019
docker-compose.yml [core] Prune dead dependencies (#10963) Apr 8, 2018
lerna.json @material-ui/styles (#13503) Nov 12, 2018
next.config.js [core] Upgrade dependencies and devDependencies (#14493) Feb 11, 2019
package.json [docs] Add banner for next docs releases (#14497) Feb 12, 2019
prettier.config.js [core] Remove parser specification to fix JSON issue (#11763) Jun 7, 2018
tsconfig.json [docs] AppBar and Textfield demos in TypeScript (#13229) Jan 31, 2019
tslint.json [typescript] Enable generic props for certain components (#13868) Feb 10, 2019
yarn.lock [core] Upgrade dependencies and devDependencies (#14493) Feb 11, 2019

README.md

Material-UI logo

Material-UI

React components that implement Google's Material Design.

npm package npm downloads CircleCI Gitter Coverage Status CII Best Practices Code style Follow on Twitter PeerDependencies Dependencies DevDependencies Average time to resolve an issue Crowdin

Installation

Material-UI is available as an npm package.

Stable channel v3

// with npm
npm install @material-ui/core

// with yarn
yarn add @material-ui/core

Next channel v4.0.0-alpha

// with npm
npm install @material-ui/core@next

// with yarn
yarn add @material-ui/core@next

v0.x (Migration to v1)

// with npm
npm install material-ui

// with yarn
yarn add material-ui

Please note that @next will only point to pre-releases; to get the latest stable release use @latest instead.

Supporting Material-UI

Material-UI is an MIT-licensed open source project. It's an independent project with ongoing development made possible thanks to the support of these awesome backers. If you'd like to join them, please consider:

What's the difference between Patreon and OpenCollective?

Funds donated via Patreon directly support Olivier Tassinari's work on Material-UI. Funds donated via OpenCollective are managed transparently and will be used for compensating work and expenses for core team members. Your name/logo will receive proper recognition and exposure by donating on either platform.

Gold Sponsors

Gold Sponsors are those who have pledged $500/month and more to Material-UI.

via Patreon

creative-tim tidelift bitsrc

via OpenCollective

callemall localize yakaz zinggrid

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" color="primary">
      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:

Edit Button

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.

Contributing

We'd greatly appreciate any contribution you make. :)

Changelog

Recently Updated? Please read the changelog.

Roadmap

The future plans and high priority features and enhancements can be found in the ROADMAP.md file.

Thanks

Material-UI is only made possible thanks to these great services that sponsor our 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.

License

This project is licensed under the terms of the MIT license.

Security

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.