Material Components

Modular and customizable Material Design UI components for the web

Material designCSS Toolkit
material-components/material-components-webmaterial.io/develop/web

README

Version Chat

Material Components for the web


Material Components for the web helps 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 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.

Material Components for the web is the successor to Material Design Lite. In addition to implementing the Material Design guidelines, it provides more flexible theming customization, not only in terms of color, but also typography, shape, states, and more. It is also specifically architected for adaptability to various major web frameworks.

NOTE: Material Components Web tends to release breaking changes on a monthly basis, but follows

semver so you can control when you incorporate them.

We typically follow a 2-week release schedule which includes one major release per month with breaking changes,

and intermediate patch releases with bug fixes.


Important links


- Getting Started Guide
- Demos (external site)
- Material on other frameworks
- Examples using Material Web
- Contributing
- Material Design Guidelines (external site)
- Supported browsers
- All Components
- Changelog

Quick start


Using via CDN


  1. ``` html
  3. <link rel="stylesheet" href="https://unpkg.com/material-components-web@latest/dist/material-components-web.min.css">
  4. <label class="mdc-text-field mdc-text-field--filled">
  5.   <span class="mdc-text-field__ripple"></span>
  6.   <span class="mdc-floating-label" id="my-label">Label</span>
  7.   <input type="text" class="mdc-text-field__input" aria-labelledby="my-label">
  8.   <span class="mdc-line-ripple"></span>
  9. </label>
  10. <script src="https://unpkg.com/material-components-web@latest/dist/material-components-web.min.js"></script>
  11. <script>
  12.   mdc.textField.MDCTextField.attachTo(document.querySelector('.mdc-text-field'));
  13. </script>
  14. ```

Please see quick start demo on codepen for full example.


Using NPM


This guide assumes you have webpack configured to compile Sass into CSS. To configure webpack, please see the full getting started guide. You can also see the final code and result in the Material Starter Kit.


Install textfield node module to your project.

  1. ```
  2. npm install @material/textfield
  3. ```

HTML


Sample usage of text field component. Please see Textfield component page for more options.

  1. ``` html
  2. <label class="mdc-text-field mdc-text-field--filled">
  3.   <span class="mdc-text-field__ripple"></span>
  4.   <input type="text" class="mdc-text-field__input" aria-labelledby="my-label">
  5.   <span class="mdc-floating-label" id="my-label">Label</span>
  6.   <span class="mdc-line-ripple"></span>
  7. </label>
  8. ```

CSS


Load styles required for text field component.

  1. ```scss
  2. @use "@material/floating-label/mdc-floating-label";
  3. @use "@material/line-ripple/mdc-line-ripple";
  4. @use "@material/notched-outline/mdc-notched-outline";
  5. @use "@material/textfield";

  7. @include textfield.core-styles;

  9. ```

JavaScript


Import MDCTextField module to instantiate text field component.

  1. ``` js
  2. import {MDCTextField} from '@material/textfield';
  3. const textField = new MDCTextField(document.querySelector('.mdc-text-field'));
  4. ```

This'll initialize text field component on a single .mdc-text-field element.

Please see quick start demo on glitch for full example.


Need help?


We're constantly trying to improve our components. If Github Issues don't fit your needs, then please visit us on our Discord Channel.