Permalink
25e87b7 Oct 5, 2018
5 contributors

Users who have contributed to this file

@TimvdLippe @sorvell @azakus @samuelli @material-admin
120 lines (71 sloc) 5.39 KB

Material Web Components

⚠️ These components are still a work in progress. Not all elements are available on NPM yet. We are working on the remaining elements and publish them to the NPM registry once we have a first working version. ⚠️

Material Web Components helps developers execute Material Design using web components.

Built on top of the Material Components Web project and LitElement, the Material Web Components enable a reliable development workflow to build beautiful and functional web projects.

Web Components can be seamlessly incorporated into a wide range of usage contexts. Whether you're already heavily invested in another framework or not, it's easy to incorporate Material Web Components into your site in a lightweight, idiomatic fashion.

Demos

Quick start

Note: This guide assumes you have npm installed locally.

The easiest way to try out the Material Web Components is to use one of these online tools:

Or you can also copy this HTML file into a local file and run it in any browser that supports JavaScript Modules.

When you're ready to use the Material Web Components in your web application:

  1. Ensure the webcomponents polyfills are included in your HTML page

    • Install webcomponents polyfills

      npm i @webcomponents/webcomponentsjs

    • Add webcomponents polyfills to your HTML page

      <script src="@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>

  2. Add one of the MWC elements to your project, for example for icon:

    npm i @material/mwc-icon

  3. Import the element definition into your HTML page:

    <script type="module" src="@material/mwc-icon/index.js"></script>

    Or into your module script:

    import {Icon} from "@material/mwc-icon"

  4. Create an instance of element in your HTML page, or via any framework that supports rendering Custom Elements:

    <mwc-icon>sentiment_very_satisfied</mwc-icon>

  5. Install the Polymer CLI:

    npm i -g polymer-cli

  6. Run the development server and open a browser pointing to its URL:

    polymer serve

The Material Web Components are published on npm using JavaScript Modules. This means it can take advantage of the standard native JavaScript module loader available in all current major browsers.

However, since the Material Web Components use npm convention to reference dependencies by name, a light transform to rewrite specifiers to URLs is required to get it to run in the browser. The polymer-cli's development server polymer serve automatically handles this transform.

Tools like WebPack and Rollup can also be used to serve and/or bundle.

Contributing guide

Below are instructions for setting up project development.

  1. Clone this repo with git clone.
  2. Install dependencies by running npm run bootstrap
  3. Run a development server with npm run dev
    • View the demos by accessing <dev server url>/demos/index.html
    • This will also build the project.
  4. Build the project with npm run build
  5. Run tests with npm run test

Developing Components

Components are written in Typescript, and compiled to Javascript Modules.

The output Javascript Modules can be used in every modern browser directly, and are supported a wide variety of popular bundler and build tools.

The components render output structure, handle styling, and manage data flow with lit-html while integrating with Material Design's common logic library for each component.

Styling Components

Components define their styling using SASS.

The SASS output is built into a javascript module which exports the component's styling as a lit-html template.

Component styling is compiled with both npm run build and npm run watch.

To compile the component SASS manually, use npm run build-styling

Useful Links

Browser Support

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