Material Components for the web のドキュメントの日本語訳を作ってみた

# Material Components for the web とは

Material Components for the web （以下、MDC-Web）は Google のエンジニアらが作成しているオープンソースライブラリです。[マテリアルデザイン](https://material.io/guidelines/) をサポートするだけでなく、Angular や React などの他のライブラリとも共存できるようにというかなり野心的なプロジェクトです。UI だけでなく、Component/Foundation/Adapter などという独特の JavaScript フレームワークを内包しています。

- [Web サイト](https://material.io/components/web/)
- [デモサイト](https://material-components.github.io/material-components-web-catalog/)
- [GitHub](https://github.com/material-components/material-components-web)

# ドキュメントについて

これまで MDC-Web にだいぶお世話になったので、恩返しの意味で少しでも自分にできることをというのと、自分のためというのもあり、ドキュメントを日本語に訳しました。

https://github.com/YuoMamoru/material-components-web

MDC-Web を使う人にとっての一助となればということで、公開します。

ちなみに Branch を master に切り替えれば原文（英語）が見れます。

## ガイダンス

主なコンテンツは以下の通りです。

| コンテンツ| 備考 |
| --- | --- |
| [概要](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/README.md) | ライブラリの概要です。 |
| [入門ガイド](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/docs/getting-started.md) | とりあえず使ってみたい人向けのコンテンツ。アプリを作りながら基礎が学べます。<br>※ 2018/03/01 に内容が大幅に更新され、「アプリを作りながら基礎を学ぶ」というより、インストールと設定の方法についての記載になりました。 |
| [テーマガイド](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/docs/theming.md) | テーマ（配色などの外観）の設定のガイド。アプリを作りながら外観の設定方法を学べます。（Sass の知識がないと厳しいかも） |
| [コンポーネントの構成](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/docs/authoring-components.md) | MDC-Web のフレームワークの概要やベストプラクティスなどが書かれています。MDC-Web を使って新たなコンポーネントを作る場合は必読。 |

### MDC-Web を構成するパッケージ

MDC-Web は複数のパッケージで構成されてますが、コンポーネントの詳しい内容は[個別のパッケージのドキュメント](https://github.com/YuoMamoru/material-components-web/tree/translate-into-japanese/packages)を読むのがよいです。

* [material-components-web](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/material-components-web/README.md)
* [mdc-animation](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-animation/README.md)
* [mdc-auto-init](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-auto-init/README.md)
* [mdc-banner](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-banner/README.md) （未翻訳）
* [mdc-base](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-base/README.md)
* [mdc-button](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-button/README.md)
* [mdc-card](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-card/README.md)
* [mdc-checkbox](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-checkbox/README.md)
* [mdc-chips](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-chips/README.md)
* [mdc-circular-progress](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-circular-progress/README.md) （未翻訳）
* [mdc-data-table](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-data-table/README.md)
* [mdc-densty](https://github.com/YuoMamoru/material-components-web/tree/translate-into-japanese/packages/mdc-density)
* [mdc-dialog](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-dialog/README.md)
* [mdc-dom](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-dom/README.md)
* [mdc-drawer](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-drawer/README.md) （未翻訳）
* [mdc-elevation](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-elevation/README.md)
* [mdc-fab](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-fab/README.md)
* [mdc-feature-targeting](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-feature-targeting/README.md) （未翻訳）
* [mdc-floating-label](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-floating-label/README.md)
* [mdc-form-field](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-form-field/README.md)
* [mdc-icon-button](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-icon-button/README.md)
* [mdc-image-list](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-image-list/README.md)
* [mdc-layout-grid](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-layout-grid/README.md)
* [mdc-line-ripple](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-line-ripple/README.md) （未翻訳）
* [mdc-linear-progress](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-linear-progress/README.md)
* [mdc-list](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-list/README.md)
* [mdc-menu-surface](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-menu-surface/README.md) （未翻訳）
* [mdc-menu](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-menu/README.md)
* [mdc-notched-outline](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-notched-outline/README.md) （未翻訳）
* [mdc-progress-indicator](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-progress-indicator/README.md)
* [mdc-radio](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-radio/README.md)
* [mdc-ripple](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-ripple/README.md) （未翻訳）
* [mdc-rtl](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-rtl/README.md) （未翻訳）
* [mdc-select](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-select/README.md)
* [mdc-shape](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-shape/README.md)
* [mdc-slider](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-slider/README.md)
* [mdc-snackbar](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-snackbar/README.md)
* [mdc-switch](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-switch/README.md)
* [mdc-tab-bar](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-tab-bar/README.md)
* [mdc-tab-indicator](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-tab-indicator/README.md)
* [mdc-tab-scroller](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-tab-scroller/README.md)
* [mdc-tab](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-tab/README.md)
* [mdc-textfield](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-textfield/README.md)
* [mdc-theme](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-theme/README.md)
* [mdc-tooltip](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-tooltip/README.md) （未翻訳）
* [mdc-top-app-bar](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-top-app-bar/README.md)
* [mdc-touch-target](https://github.com/YuoMamoru/material-components-web/tree/translate-into-japanese/packages/mdc-touch-target)
* [mdc-typography](https://github.com/YuoMamoru/material-components-web/blob/translate-into-japanese/packages/mdc-typography/README.md)


今後は未翻訳のドキュメントもすこしずつですが訳していくつもりです。

## 終わりに

誤訳や意味が分かりずらいことろがありましたら、コメントするなりイシューを書くなりプルリクエストなりしてください。

ただし、ドキュメントも含めてこのプロジェクトは更新頻度が高い（API が大幅に変わることも頻繁）ので、常に最新になっているとは限らない点はご了承ください。