JavaScript TypeScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci [core] Move to the packages structure (#11033) Apr 16, 2018
.github [github] Update the issue template (#11488) May 19, 2018
docs [ButtonBase] Improve enter & space handling (#11585) May 25, 2018
examples [examples] Fix create-react-app-with-jss theme object (#11485) May 19, 2018
flow-typed/npm push lab forward Feb 19, 2018
flow [docs] Use next.js (#7759) Aug 18, 2017
packages [ButtonBase] Improve enter & space handling (#11585) May 25, 2018
pages [docs] Update the showcase (#11578) May 25, 2018
scripts [core] Bundle UMD with rollup (#11360) May 15, 2018
static [docs] Update the showcase (#11578) May 25, 2018
test [docs] Update the showcase (#11578) May 25, 2018
.babelrc [core] Simplify the babel docs config (#11514) May 21, 2018
.browserslistrc [jss] Fix the last w3c issue I'm aware of (#10063) Jan 27, 2018
.codecov.yml [core] Move to the packages structure (#11033) Apr 16, 2018
.editorconfig [.editorconfig] Add max_line_length (#9580) Dec 20, 2017
.eslintignore [core] Rename .spec.js to .test.js (#10854) Mar 30, 2018
.eslintrc.js [eslint] no-confusing-arrow is incompatible with prettier Apr 2, 2018
.eslintrc.spellcheck.js [examples] Take ownership on the next.js example (#7703) Aug 8, 2017
.firebaserc [docs] IE11 2nd iteration Apr 15, 2017
.flowconfig [core] Move material-ui to @material-ui/core (#11310) May 10, 2018
.gitattributes Add gitattributes Dec 12, 2014
.gitignore [core] Move to the packages structure (#11033) Apr 16, 2018
.size-limit.js [core] Internalize ScrollbarSize (#11523) May 21, 2018
.yarnrc [core] Upgrade Babel 6 to Babel 7 (#10964) May 8, 2018
BACKERS.md [BACKERS] Add 3 new backers :) May 19, 2018
CHANGELOG.md [docs] Update for v1 release (#11365) May 17, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Aug 9, 2017
CONTRIBUTING.md [CONTRIBUTING] The v1-beta branch is almost gone, master May 15, 2018
GOVERNANCE.md [docs] Update after v1.0.0-rc.0 release May 13, 2018
LICENSE Initial commit Aug 18, 2014
README.md [docs] Use https for v0 URLs May 18, 2018
ROADMAP.md [docs] Move v1-beta to master (#11354) May 12, 2018
SUPPORT.md Update SUPPORT.md (#9702) Jan 2, 2018
docker-compose.yml [core] Prune dead dependencies (#10963) Apr 8, 2018
lerna.json [docs] Move v1-beta to master (#11354) May 12, 2018
next.config.js [core] Upgrade Babel 6 to Babel 7 (#10964) May 8, 2018
package.json [core] Internalize ScrollbarSize (#11523) May 21, 2018
prettier.config.js [core] Minor refacto Apr 2, 2018
tsconfig.json [core] Move to the packages structure (#11033) Apr 16, 2018
yarn.lock update yarn.lock May 25, 2018

README.md

Material-UI logo

Material-UI

React components that implement Google's Material Design.

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

Installation

Material-UI is available as an npm package.

Stable channel v1

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

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

v0.x

// 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:

Your contributions, donations, and sponsorship allow us to build a sustainable organization. They directly support office hours, continued enhancements, great documentation and learning materials!

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 also support Olivier, but will be shared amongst other contributors and pay for operating expenses. These funds are managed transparently through the OpenCollective website. 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

0 1

via OpenCollective

0 1 2 3 4 5 6 7 8 9

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="raised" 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

Thank you to BrowserStack for providing the infrastructure that allows us to test in real browsers.

License

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