JavaScript Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci [core] Should run the tests when needed (#12510) Aug 14, 2018
.github [docs] New ISSUE_TEMPLATE (#12148) Jul 14, 2018
docs [CardMedia] Add an example with the component property (#12481) Aug 15, 2018
examples [docs] Document the meta viewport (#12541) Aug 15, 2018
flow-typed/npm [Tooltip] Rework the implementation (#12085) Jul 8, 2018
flow [docs] Use next.js (#7759) Aug 18, 2017
modules/waterfall [icons] New iteration (#12170) Jul 18, 2018
packages [SpeedDial] Remove dead code from test (#12545) Aug 15, 2018
pages [CardMedia] Add an example with the component property (#12481) Aug 15, 2018
static [docs] Add example layouts (#12410) Aug 5, 2018
test [icons] Remove clip-path from all icons (#12452) Aug 9, 2018
.babelrc.js [docs] Add the new Creative Tim theme (#12217) Jul 20, 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 [icons] New iteration (#12170) Jul 18, 2018
.eslintrc.js [docs] Don't load the ad on mobile (#12509) Aug 13, 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 [icons] New iteration (#12170) Jul 18, 2018
.size-limit.js [docs] Add example layouts (#12410) Aug 5, 2018
.yarnrc [core] Upgrade Babel 6 to Babel 7 (#10964) May 8, 2018
BACKERS.md [README] New iteration on the backers (#12475) Aug 11, 2018
CHANGELOG.md Minor tweks to CHANGELOG.md Aug 12, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Aug 9, 2017
CONTRIBUTING.md [docs] Improve ListItem and BottomNavigationAction docs (#12295) Jul 27, 2018
GOVERNANCE.md [docs] Use the new documentation URL Aug 12, 2018
LICENSE Initial commit Aug 18, 2014
README.md [README] New iteration on the backers (#12475) Aug 11, 2018
ROADMAP.md [docs] Do SEO for the components (#11963) Jun 24, 2018
SUPPORT.md Update SUPPORT.md (#9702) Jan 2, 2018
docker-compose.yml [core] Prune dead dependencies (#10963) Apr 8, 2018
next.config.js [core] Upgrade Babel 6 to Babel 7 (#10964) May 8, 2018
package.json v1.5.0 Aug 12, 2018
prettier.config.js [core] Remove parser specification to fix JSON issue (#11763) Jun 7, 2018
tsconfig.json [core] Move to the packages structure (#11033) Apr 16, 2018
yarn.lock [docs] Don't load the ad on mobile (#12509) Aug 13, 2018

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

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 (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 bitsrc

via OpenCollective

0 1 2 3 4 5 6 7 8 9

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