Material Components for the web (MDC-Web) help developers execute Material Design. Developed by a core team of engineers and UX designers at Google, these components enable a reliable development workflow to build beautiful and functional web projects.
Material Components for the web is the successor to Material Design Lite, and has 3 high-level goals:
- Production-ready components consumable in an a-la-carte fashion
- Best-in-class performance and adherence to the Material Design guidelines
- Seamless integration with other JS frameworks and libraries
MDC-Web strives to seamlessly incorporate into a wider range of usage contexts, from simple static websites to complex, JavaScript-heavy applications to hybrid client/server rendering systems. In short, whether you're already heavily invested in another framework or not, it should be easy to incorporate Material Components into your site in a lightweight, idiomatic fashion.
Demos (updated with every release)
Install the library
npm install --save material-components-web
Then simply include the correct files, write some HTML, and call mdc.autoInit() within a closing
<script> tag.
<!DOCTYPE html>
<html class="mdc-typography">
<head>
<title>Material Components for the web</title>
<link rel="stylesheet"
href="node_modules/material-components-web/dist/material-components-web.css">
</head>
<body>
<h2 class="mdc-typography--display2">Hello, Material Components!</h2>
<div class="mdc-textfield" data-mdc-auto-init="MDCTextfield">
<input type="text" class="mdc-textfield__input" id="demo-input">
<label for="demo-input" class="mdc-textfield__label">Tell us how you feel!</label>
</div>
<script src="node_modules/material-components-web/dist/material-components-web.js"></script>
<script>mdc.autoInit()</script>
</body>
</html>That's all there is to it! This is the easiest way to get up and running with Material Components for web. Check out our Getting Started guide for a more in-depth introduction to the library.
MDC-Web is modular by design. Each component lives within its own packages under the @material npm org.
npm install --save @material/button @material/card @material/textfield @material/typography
All our components can be found in the packages directory. Each component has a README documenting installation and usage.
If you are using a module loader such as Webpack or SystemJS to load your JS modules, you can simply
import every component you need from material-components-web and use it as such.
import {checkbox as mdcCheckbox} from 'material-components-web';
const {MDCCheckbox, MDCCheckboxFoundation} = mdcCheckbox;
// Use MDCCheckbox and/or MDCCheckboxFoundationYou can do the same with individual components
import {MDCCheckbox, MDCCheckboxFoundation} from '@material/checkbox';
// Use MDCCheckbox and/or MDCCheckboxFoundationWe also provide UMD bundles for both material-components-web as
well as all individual components.
const {checkbox: mdcCheckbox} = require('material-components-web/dist/material-components-web');
// Use mdcCheckbox
const {MDCCheckbox, MDCCheckboxFoundation} = require('@material/checkbox/dist/mdc.checkbox');
// Use MDCCheckbox, MDCCheckboxFoundationWhen no module system is used, every component is added under the global mdc namespace. This
occurs regardless of whether or not the entire library or the individual components are used.
Every component also ships with a minified version of its UMD bundle, which can be found at
dist/mdc.COMPONENT.min.js.
All components which include styles provide them at dist/mdc.COMPONENT.css, as well as a
complementary minified version at dist/mdc.COMPONENT.min.css. Note that CSS files for a
component's dependencies are not included within the component's CSS file, so if you are using
individual components you'll have to include each separately.
Each component also comes with a Sass source file that can be included in your application's Sass
// Using the whole library
@import "material-components-web/material-components-web";
// Using individual components / mixins
@import '@material/checkbox';
@import '@material/typography';
@import '@material/elevation/mixins'; // Mixins for elevation.NOTE: The components' Sass files expect that the
node_modulesdirectory containing the@materialscope folder is present on the Sass include path.
Setup the repo:
git clone https://github.com/material-components/material-components-web.git && cd material-components-web
npm i
Run the development server (served out of demos/):
cd /path/to/material-components-web
npm run dev
open http://localhost:8080
- Getting Started Guide
- All Components
- Demos
- Framework Integration Examples
- Contributing
- Developing MDC-Web Components
- Material.io (external site)
- Material Design Guidelines (external site)
We officially support the last two versions of every major browser. Specifically, we test on the following browsers:
- Chrome
- Safari
- Firefox
- IE 11/Edge
- Opera
- Mobile Safari
- Chrome on Android