mirror of https://github.com/material-components/material-web.git synced 2024-11-11 06:10:17 +03:00

Material Design Web Components

starred-material-components-repo starred-repo

Go to file

Allan Chen d7ff60b86b Update theming.md		2021-10-14 15:04:46 -07:00
.github	Remove aomarks from auto format job assignees (#2775 )	2021-09-29 10:20:33 -07:00
components	feat(button): add focus ring (no-op for now)	2021-10-14 11:47:09 -07:00
demos	chore(slider): allow dependency updating and update demo	2021-07-26 15:41:49 -07:00
docs	Update theming.md	2021-10-14 15:04:46 -07:00
images	Edge support (#948 )	2020-03-02 17:03:14 -08:00
packages	fix(aria-property): Disable attribute removal from host until internal tooling is compatible	2021-10-13 13:56:24 -07:00
scripts	Update sass-to-lit-css script to use lit import instead of lit-element	2021-10-11 16:45:07 -07:00
test	chore: just import 'lit', it's cleaner	2021-09-27 11:28:08 -07:00
.clang-format	chore: update clang-format	2021-01-13 12:56:07 -08:00
.eslintignore	chore: remove src folder from packages in GitHub (#1706 )	2020-08-17 17:59:35 -07:00
.eslintrc.yaml	(chore): Prepare for switch to Jasmine `expect`	2021-05-25 10:41:59 -07:00
.gitignore	chore(switch): add github build deps for deprecated switch (#2534 )	2021-07-14 13:23:21 -07:00
CHANGELOG.md	update changelog	2021-10-11 16:52:25 -07:00
karma.conf.js	(chore): Convert Chai assertions to Jasmine assertions	2021-05-25 12:09:03 -07:00
lerna.json	v0.25.2	2021-10-11 21:48:48 +00:00
LICENSE	docs: Update LICENSE file to be exact copy of apache license	2021-02-26 17:45:18 -05:00
package-lock.json	build: revert pacakgelock	2021-09-20 19:39:50 -07:00
package.json	build: pin TS to 4.3	2021-09-20 19:24:07 -07:00
polymer.json	add demo build polymer.json	2018-05-02 11:23:40 -07:00
README.md	Update README.md (#2806 )	2021-10-05 12:09:55 -07:00
rollup.config.js	feat(elevation-overlay): implement elevation overlay	2020-09-22 17:11:22 -07:00
tsconfig.json	chore(switch): add github build deps for deprecated switch (#2534 )	2021-07-14 13:23:21 -07:00

README.md

Material Web

IMPORTANT: Material Web is a work in progress and subject to major changes until 1.0 release.

Material Web is Google’s UI toolkit for building beautiful, accessible web applications. Material Web is implemented as a collection of web components.

The Material team is currently working on Material You (Material Design 3) support for Material components.

Developers using this library should expect some big changes as we work to improve our codebase and ease of use and implement the newest Material Design.

A few notable changes you should expect:

UX changes as we adopt the new designs (production users will definitely want to pin to an appropriate release, not mainline)
A single npm package (@material/web)
Simplification of tag name prefixes to md- (CSS custom properties will be --md-)
Components as top-level folders which contain all variants

Example: top-app-bar and top-app-bar-fixed will be placed in the same folder: top-app-bar
Components with variant attributes will be split into several variant components:

Example: mwc-button will be split into md-text-button, md-filled-button, md-tonal-button, md-outlined-button, etc

API demos

Theming Guide

Sandbox demo on Glitch

Contributing Guide

Components

Component	Status	Issues
`<mwc-button>`		Issues
`<mwc-bottom-app-bar>`	TBD	Issues
`<mwc-card>`	TBD	Issues
`<mwc-checkbox>`		Issues
`<mwc-chip>`	TBD	Issues
`<mwc-circular-progress>`		Issues
`<mwc-circular-progress-four-color>`		Issues
`<mwc-data-table>`	TBD	Issues
`<mwc-dialog>`		Issues
`<mwc-drawer>`		Issues
`<mwc-fab>`		Issues
`<mwc-formfield>`		Issues
`<mwc-icon-button-toggle>`		Issues
`<mwc-icon-button>`		Issues
`<mwc-icon>`		Issues
`<mwc-linear-progress>`		Issues
`<mwc-list>`		Issues
`<mwc-menu>`		Issues
`<mwc-radio>`		Issues
`<mwc-select>`		Issues
`<mwc-slider>`		Issues
`<mwc-snackbar>`		Issues
`<mwc-switch>`		Issues
`<mwc-tab-bar>`		Issues
`<mwc-tab>`		Issues
`<mwc-textarea>`		Issues
`<mwc-textfield>`		Issues
`<mwc-tooltip>`	TBD	Issues
`<mwc-top-app-bar-fixed>`		Issues
`<mwc-top-app-bar>`		Issues

Quick start

1) Install

Install a component from NPM:

npm install @material/mwc-button @webcomponents/webcomponentsjs

2) Write HTML and JavaScript

Import the component's JavaScript module, use the component in your HTML, and control it with JavaScript, just like you would with a built-in element such as <button>:

<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <title>My Example App</title>

    <!-- Add support for Web Components to older browsers. -->
    <script src="./node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>

    <!-- Your application must load the Roboto and Material Icons fonts. -->
    <link rel="preconnect" href="https://fonts.googleapis.com">
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    <link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500" rel="stylesheet">
    <link href="https://fonts.googleapis.com/css?family=Material+Icons&display=block" rel="stylesheet">
  </head>
  <body>
    <!-- Use Web Components in your HTML like regular built-in elements. -->
    <mwc-button id="myButton" label="Click Me!" raised></mwc-button>

    <!-- Material Web uses standard JavaScript modules. -->
    <script type="module">

      // Importing this module registers <mwc-button> as an element that you
      // can use in this page.
      //
      // Note this import is a bare module specifier, so it must be converted
      // to a path using a server such as Web Dev Server.
      import '@material/mwc-button';

      // Standard DOM APIs work with Web Components just like they do for
      // built-in elements.
      const button = document.querySelector('#myButton');
      button.addEventListener('click', () => {
        alert('You clicked!');
      });
    </script>
  </body>
</html>

3) Serve

Serve your HTML with any server or build process that supports bare module specifier resolution (see next section):

npm install --save-dev @web/dev-server
npx web-dev-server --node-resolve

Bare module specifiers

Material Web is published as standard JavaScript modules that use bare module specifiers. Bare module specifiers are not yet supported by browsers, so it is necessary to use a tool that transforms them to a path (for example from @material/mwc-button to ./node_modules/@material/mwc-button/mwc-button.js).

Two great choices for tools that do this are:

During local development, use Modern Web's Web Dev Server with the --node-resolve flag.
For your production deployment, build your application with Rollup using the rollup-plugin-node-resolve plugin.

Fonts

Most applications should include the following tags in their main HTML file to ensure that text and icons render correctly:

<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Material+Icons&display=block" rel="stylesheet">

Material Web defaults to using the Roboto font for text, and the Material Icons font for icons. These fonts are not automatically loaded, so it is the application's responsiblity to ensure that they are loaded.

Note that if you load the Material Icons font in a different way to the recommendation shown above, be sure to include font-display: block in your @font-face CSS rule. This prevents icons from initially displaying their raw ligature text before the font has loaded. The <link> tag recommended above automaticaly handles this setting.

Supporting older browsers

Material Web uses modern browser features that are natively supported in the latest versions of Chrome, Safari, Firefox, and Edge. IE11 and some older versions of other browsers are also supported, but they require additional build steps and polyfills.

Feature	Chrome	Safari	Firefox	Edge	IE11
Web Components					*
Modules					*
ES2015					*

Web Components

To support Web Components in IE11 and other older browsers, install the Web Components Polyfills:

npm install @webcomponents/webcomponentsjs

And include the webcomponents-loader.js script in your HTML, which detects when polyfills are needed and loads them automatically:

<!-- Add support for Web Components to IE11. -->
<script src="node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>

Modules

To support IE11 or other older browsers that do not support JavaScript modules, you must transform JavaScript modules to classic JavaScript scripts. Rollup is a popular tool that can consume JavaScript modules and produce a number of other formats, such as AMD. Be sure to use the rollup-plugin-node-resolve plugin to resolve bare module specifiers, as mentioned above.

ES2015

If you support IE11 or other older browsers that do not support the latest version of JavaScript, you must transpile your application to ES5. Babel is a popular tool that does this. You can integrate Babel transpilation into a Rollup configuration using rollup-plugin-babel.

Contributing

Clone and setup the repo:

git clone git@github.com:material-components/material-web.git mwc
cd mwc
npm install
npm run build

View the demos:

npm run dev
http://127.0.0.1:8000/demos/

Run all tests:

npm run test

Run tests for a specific component:

npm run test -- --packages=mwc-button

Run benchmarks for a specific component:

npm run test:bench -- --package list

Advanced developer workflow:

npm install

# (persistent) build source files on change
npm run watch

# another terminal (persistent) - viewing auto-reload demos
npm run dev -- --watch -p <optional port>

# for testing:
# another terminal (persistent) - build tests (must run after normal watch)
npm run watch:tests

# another terminal (persistent) - debug tests
npm run test:debug -- --autoWatch --packages <comma sepaarated package names> # e.g. mwc-switch,mwc-text*

README.md Unescape Escape