インストール

mdui は npm でインストールするか、CDN から読み込むかを選択できます。npm でのインストールを推奨します。

npm インストール

npm install mdui --save

フルインポート

プロジェクトのエントリーファイルで以下の 2 つのファイルをインポートすると、すべての mdui コンポーネントを使用できます：

import 'mdui/mdui.css';
import 'mdui';

mdui から必要な関数を直接インポートすることもできます。例えば、snackbar 関数をインポートするには、次のようにします：

import { snackbar } from 'mdui';

mdui からインポート可能なすべての関数を表示

import {
  $,
  dialog,
  alert,
  confirm,
  prompt,
  snackbar,
  getTheme,
  setTheme,
  getColorFromImage,
  setColorScheme,
  removeColorScheme,
  loadLocale,
  setLocale,
  getLocale,
  throttle,
  observeResize,
  breakpoint
} from 'mdui';

必要なものだけをインポート（Cherry-Picking）

プロジェクトのサイズを最適化するために、必要なコンポーネントと関数のみをインポートできます。例えば、<mdui-button> コンポーネントと snackbar 関数のみを使用する場合は、次のようにインポートします：

// CSS ファイルは常にインポートする必要があります
import 'mdui/mdui.css';
// <mdui-button> コンポーネントをインポート
import 'mdui/components/button.js';
// snackbar 関数をインポート
import { snackbar } from 'mdui/functions/snackbar.js';

各コンポーネントや関数のドキュメントページで、必要なものだけをインポートする方法が詳しく説明されています。

必要なものだけをインポート可能なすべてのコンポーネントと関数を表示

import 'mdui/components/avatar.js';
import 'mdui/components/badge.js';
import 'mdui/components/bottom-app-bar.js';
import 'mdui/components/button.js';
import 'mdui/components/button-icon.js';
import 'mdui/components/card.js';
import 'mdui/components/checkbox.js';
import 'mdui/components/chip.js';
import 'mdui/components/circular-progress.js';
import 'mdui/components/collapse.js';
import 'mdui/components/collapse-item.js';
import 'mdui/components/dialog.js';
import 'mdui/components/divider.js';
import 'mdui/components/dropdown.js';
import 'mdui/components/fab.js';
import 'mdui/components/icon.js';
import 'mdui/components/layout.js';
import 'mdui/components/layout-item.js';
import 'mdui/components/layout-main.js';
import 'mdui/components/linear-progress.js';
import 'mdui/components/list.js';
import 'mdui/components/list-item.js';
import 'mdui/components/list-subheader.js';
import 'mdui/components/menu.js';
import 'mdui/components/menu-item.js';
import 'mdui/components/navigation-bar.js';
import 'mdui/components/navigation-bar-item.js';
import 'mdui/components/navigation-drawer.js';
import 'mdui/components/navigation-rail.js';
import 'mdui/components/navigation-rail-item.js';
import 'mdui/components/radio.js';
import 'mdui/components/radio-group.js';
import 'mdui/components/range-slider.js';
import 'mdui/components/ripple.js';
import 'mdui/components/segmented-button.js';
import 'mdui/components/segmented-button-group.js';
import 'mdui/components/select.js';
import 'mdui/components/slider.js';
import 'mdui/components/snackbar.js';
import 'mdui/components/switch.js';
import 'mdui/components/tab.js';
import 'mdui/components/tab-panel.js';
import 'mdui/components/tabs.js';
import 'mdui/components/text-field.js';
import 'mdui/components/tooltip.js';
import 'mdui/components/top-app-bar.js';
import 'mdui/components/top-app-bar-title.js';
import { $ } from 'mdui/jq.js';
import { alert } from 'mdui/functions/alert.js';
import { breakpoint } from 'mdui/functions/breakpoint.js';
import { confirm } from 'mdui/functions/confirm.js';
import { dialog } from 'mdui/functions/dialog.js';
import { getColorFromImage } from 'mdui/functions/getColorFromImage.js';
import { getLocale } from 'mdui/functions/getLocale.js';
import { getTheme } from 'mdui/functions/getTheme.js';
import { loadLocale } from 'mdui/functions/loadLocale.js';
import { observeResize } from 'mdui/functions/observeResize.js';
import { prompt } from 'mdui/functions/prompt.js';
import { removeColorScheme } from 'mdui/functions/removeColorScheme.js';
import { setColorScheme } from 'mdui/functions/setColorScheme.js';
import { setLocale } from 'mdui/functions/setLocale.js';
import { setTheme } from 'mdui/functions/setTheme.js';
import { snackbar } from 'mdui/functions/snackbar.js';
import { throttle } from 'mdui/functions/throttle.js';

CDN

<link> と <script> タグを使用して、CDN から直接 mdui を利用できます。また、CSS と JavaScript ファイルをダウンロードして、自分のサーバーに配置することもできます。CSS と JavaScript ファイルを読み込めば、すべての mdui コンポーネントを使用できます。

グローバルビルド版の使用

以下の例は、グローバルビルド版の mdui の使用方法を示しています。このバージョンでは、すべての関数がグローバルオブジェクト mdui のプロパティとして公開されます：

<link rel="stylesheet" href="https://unpkg.com/mdui@2/mdui.css">
<script src="https://unpkg.com/mdui@2/mdui.global.js"></script>

<mdui-button class="btn">クリック</mdui-button>

<script>
  document.querySelector('.btn').addEventListener('click', () => {
    mdui.snackbar({ message: 'ボタンがクリックされました' });
  });
</script>

ES モジュールビルド版の使用

以下の例は、ES モジュールビルド版の mdui の使用方法を示しています。このバージョンでは、CDN から mdui を ES モジュール構文でインポートできます：

<link rel="stylesheet" href="https://unpkg.com/mdui@2/mdui.css">

<mdui-button class="btn">クリック</mdui-button>

<script type="module">
  import { snackbar } from 'https://unpkg.com/mdui@2/mdui.esm.js';

  document.querySelector('.btn').addEventListener('click', () => {
    snackbar({ message: 'ボタンがクリックされました' });
  });
</script>

前の章

概要

次の章

クイックスタート