Skip to content
React components for faster and easier web development. Build your own design system, or start with Material Design.
Branch: master
Clone or download
m2mathew and oliviertassinari [docs] Reword unsupported material components notes (#16660)
* [Docs] Reword unsupported material components alert

* [Docs] Update wording for Material spec from 'documentation' to 'guidelines'

* [Docs] Remove updated 'not supported' wording from translated pages

* Update text-fields.md
Latest commit a3ae056 Jul 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci [docs] Move dependencies/scripts from root into workspace (#16640) Jul 19, 2019
.github [styles] Only run the check on the client-side (#16284) Jun 19, 2019
docs [docs] Reword unsupported material components notes (#16660) Jul 21, 2019
examples [docs] Remove <any> from nextjs-with-typescript example (#16555) Jul 17, 2019
modules [docs] Change http to https (#16056) Jun 5, 2019
packages [Modal] Fix focus not being contained (#16585) Jul 20, 2019
scripts [docs] Upgrade next to v9 (#16546) Jul 21, 2019
static/icons [docs] Move dependencies/scripts from root into workspace (#16640) Jul 19, 2019
test [Menu] Use strict mode compatible testing API (#16582) Jul 19, 2019
.browserslistrc [core] Drop node 6 support (#14379) Feb 2, 2019
.codecov.yml [test] Increase the Codecov threshold (#14796) Mar 9, 2019
.editorconfig [docs] Change http to https part 2 (#16171) Jun 12, 2019
.eslintignore [docs] Move dependencies/scripts from root into workspace (#16640) Jul 19, 2019
.eslintrc.js [MenuList] Fix keyboard a11y when no item is focused when opening (#1… Jun 22, 2019
.gitattributes Add gitattributes Dec 12, 2014
.gitignore [docs] Move dependencies/scripts from root into workspace (#16640) Jul 19, 2019
.tidelift.yml [test] Tidelift - skip checking nomnom & os-locale (#13157) Oct 8, 2018
.yarnrc [core] Fix .yarnrc syntax (#14704) Mar 1, 2019
BACKERS.md [docs] Batch of small fixes (#16061) Jun 5, 2019
CHANGELOG.md v4.2.1 Jul 17, 2019
CODE_OF_CONDUCT.md [docs] Use full text of the code of conduct (#16417) Jun 29, 2019
CONTRIBUTING.md [docs] Minor fixes (#15836) May 24, 2019
GOVERNANCE.md [docs] Change http to https (#16056) Jun 5, 2019
LICENSE Initial commit Aug 18, 2014
README.md [docs] Batch of fixes (#16229) Jun 15, 2019
ROADMAP.md [docs] Reorganize the structure (#15603) May 8, 2019
SECURITY.md [docs] Add SECURITY.md (#15804) May 25, 2019
SUPPORT.md [docs] Change http to https part 2 (#16171) Jun 12, 2019
azure-pipelines.yml [docs] Upgrade next to v9 (#16546) Jul 21, 2019
babel.config.js [docs] Move dependencies/scripts from root into workspace (#16640) Jul 19, 2019
crowdin.yml [docs] Tidy up moved / deleted translations and update the Crowdin co… Apr 7, 2019
dangerfile.js [ci] Fix a typo emooji -> emoji (#16286) Jun 19, 2019
docker-compose.yml [core] Prune dead dependencies (#10963) Apr 8, 2018
lerna.json [core] Speed-up typechecking (#16413) Jun 29, 2019
package.json [docs] Move dependencies/scripts from root into workspace (#16640) Jul 19, 2019
prettier.config.js [core] Remove parser specification to fix JSON issue (#11763) Jun 7, 2018
tsconfig.json [docs] Upgrade next to v9 (#16546) Jul 21, 2019
tslint.json [withMobileDialog] Improve types (#15276) Apr 9, 2019
yarn.lock [docs] Upgrade next to v9 (#16546) Jul 21, 2019

README.md

Material-UI logo

Material-UI

React components that implement Google's Material Design.

npm package npm downloads CircleCI Build Status Join the community on Spectrum 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 v4

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

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

v3.x (Migration from v3 to v4)

v0.x (Migration to v1)

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 blokt

via OpenCollective

callemall localize

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.

You can’t perform that action at this time.