Skip to content
⚠️This repository is read-only. Please don't submit PRs here as they will be closed. To submit translations please visit https://translate.material-ui.com. To edit the English docs or source code, please use the main repository:
JavaScript TypeScript
Branch: latest
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci [core] cross-os jsonlint (#19377) Jan 26, 2020
.codesandbox [test] Build all `@material-ui/*` packages for Codesandbox CI (#18100) Oct 31, 2019
.dependabot [core] Ignore `@date-ui/` updates (#19633) Feb 9, 2020
.github [docs] Improve entry points for issue repros (#19501) Feb 2, 2020
docs [docs] Update the translations (#19741) Feb 16, 2020
examples [core] Misc dependency fixes (#19643) Feb 10, 2020
framer [core] Misc dependency fixes (#19643) Feb 10, 2020
modules docs: Fixing url address in modules/watrerfall/Batcher.js (#18997) Dec 27, 2019
packages v4.9.3 Feb 16, 2020
scripts [test] Test type libs in docs (#19375) Jan 26, 2020
test [core] Batch small changes (#19416) Jan 30, 2020
.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 [icons] Update script to use latest json file (#17257) Sep 5, 2019
.eslintrc.js [core] Batch small changes (#19639) Feb 10, 2020
.gitattributes Add gitattributes Dec 12, 2014
.gitignore Add Framer X wrapper components (#17797) Nov 6, 2019
.mocharc.js Bump mocha from 6.2.2 to 7.0.0 (#19078) Jan 19, 2020
.tidelift.yml [test] Tidelift - skip checking nomnom & os-locale (#13157) Oct 8, 2018
.yarnrc [ci] Use custom frozen lockfile check (#16677) Jul 22, 2019
CHANGELOG.md v4.9.3 Feb 16, 2020
CODE_OF_CONDUCT.md [docs] Use full text of the code of conduct (#16417) Jun 29, 2019
CONTRIBUTING.md [docs] Update link to example for adding a new demo (#19590) Feb 6, 2020
LICENSE Initial commit Aug 18, 2014
README.md [core] Batch small changes (#19717) Feb 15, 2020
SECURITY.md [docs] Add SECURITY.md (#15804) May 25, 2019
azure-pipelines.yml [docs] Extend size-snapshot (#17633) Oct 3, 2019
babel.config.js [build] Clarify transform-runtime, runtime version (#18512) Jan 20, 2020
crowdin.yml [docs] Update the translations (#19514) Feb 1, 2020
dangerfile.js [ci] Fix size comparison sort order (#17800) Oct 9, 2019
docker-compose.yml [core] Prune dead dependencies (#10963) Apr 8, 2018
lerna.json Add Framer X wrapper components (#17797) Nov 6, 2019
package.json v4.9.3 Feb 16, 2020
prettier.config.js [core] Remove parser specification to fix JSON issue (#11763) Jun 7, 2018
tsconfig.json [docs] Revert upgrade to next 9 (#16755) Jul 26, 2019
tslint.json [TableSortLabel] Sort asc by default (#19013) Dec 30, 2019
yarn.lock Bump webpack from 4.41.5 to 4.41.6 (#19735) Feb 16, 2020

README.md

Material-UI logo

Material-UI

React components for faster and easier web development. Build your own design system, or start with Material Design.

npm package npm downloads CircleCI Build Status Coverage Status CII Best Practices Code style Follow on Twitter Dependabot Status 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.

Who sponsors Material-UI?

Diamond 💎

Diamond Sponsors are those who have pledged $1,500/month or more to Material-UI.

Gold 🏆

via Patreon

tidelift bitsrc

via OpenCollective

call-em-all

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

Premium Themes

You can find complete templates & themes in our premium themes section.

Contributing

Read our 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

Recently Updated? Please read the changelog.

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.

You can’t perform that action at this time.