Installation

Sie können wählen, ob Sie mdui über npm installieren oder über ein CDN einbinden möchten. Die Installation über npm wird empfohlen.

npm-Installation

npm install mdui --save

Vollständiger Import

Importieren Sie die folgenden beiden Dateien in die Einstiegsdatei Ihres Projekts, um alle mdui-Komponenten verwenden zu können:

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

Sie können auch direkt aus mdui die benötigten Funktionen importieren. Um beispielsweise die snackbar-Funktion zu importieren, können Sie Folgendes tun:

import { snackbar } from 'mdui';

Alle Funktionen anzeigen, die aus mdui importiert werden können

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

Bedarfsgerechter Import (Cherry Picking)

Um die Projektgröße zu optimieren, können Sie nur die benötigten Komponenten und Funktionen importieren. Wenn Sie beispielsweise nur die <mdui-button>-Komponente und die snackbar-Funktion benötigen, können Sie wie folgt importieren:

// Die CSS-Datei muss immer importiert werden
import 'mdui/mdui.css';
// Importiere die <mdui-button>-Komponente
import 'mdui/components/button.js';
// Importiere die snackbar-Funktion
import { snackbar } from 'mdui/functions/snackbar.js';

Auf den Dokumentationsseiten jeder Komponente oder Funktion wird detailliert beschrieben, wie der bedarfsgerechte Import durchgeführt wird.

Alle Komponenten und Funktionen anzeigen, die bedarfsgerecht importiert werden können

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

Sie können mdui direkt über ein CDN mit <link>- und <script>-Tags verwenden. Sie können die CSS- und JavaScript-Dateien auch herunterladen und auf Ihrem eigenen Server bereitstellen. Nach dem Einbinden der CSS- und JavaScript-Dateien können Sie alle mdui-Komponenten verwenden.

Verwenden der globalen Build-Version

Das folgende Beispiel zeigt, wie Sie die globale Build-Version von mdui verwenden. In dieser Version sind alle Funktionen als Eigenschaften des globalen Objekts mdui verfügbar:

<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">Klick mich</mdui-button>

<script>
  document.querySelector('.btn').addEventListener('click', () => {
    mdui.snackbar({ message: 'Button geklickt' });
  });
</script>

Verwenden der ES-Module-Build-Version

Das folgende Beispiel zeigt, wie Sie die ES-Module-Build-Version von mdui verwenden. In dieser Version können Sie mdui über ein CDN mit der ES-Modul-Syntax importieren:

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

<mdui-button class="btn">Klick mich</mdui-button>

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

  document.querySelector('.btn').addEventListener('click', () => {
    snackbar({ message: 'Button geklickt' });
  });
</script>

Vorherige Seite

Übersicht

Nächste Seite

Verwendung