Instalacja
Możesz zainstalować mdui przez npm lub użyć go z CDN. Zalecana jest instalacja przez npm.
Instalacja przez npm
npm install mdui --save
Import wszystkich komponentów
W głównym pliku projektu zaimportuj poniższe dwa pliki, aby używać wszystkich komponentów mdui:
import 'mdui/mdui.css';
import 'mdui';
Możesz też bezpośrednio importować potrzebne funkcje z mdui. Na przykład, aby zaimportować funkcję snackbar:
import { snackbar } from 'mdui';
import {
$,
dialog,
alert,
confirm,
prompt,
snackbar,
getTheme,
setTheme,
getColorFromImage,
setColorScheme,
removeColorScheme,
loadLocale,
setLocale,
getLocale,
throttle,
observeResize,
breakpoint
} from 'mdui';Import selektywny
Aby zoptymalizować rozmiar projektu, możesz zaimportować tylko potrzebne komponenty i funkcje. Na przykład, jeśli potrzebujesz tylko komponentu <mdui-button> i funkcji snackbar:
// Plik CSS jest zawsze wymagany
import 'mdui/mdui.css';
// Import komponentu <mdui-button>
import 'mdui/components/button.js';
// Import funkcji snackbar
import { snackbar } from 'mdui/functions/snackbar.js';
Na stronach dokumentacji każdego komponentu lub funkcji znajdziesz szczegółowe instrukcje dotyczące importu na żądanie.
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
Możesz użyć tagów <link> i <script>, aby korzystać z mdui bezpośrednio przez CDN. Możesz też pobrać pliki CSS i JS i umieścić je na własnym serwerze. Po dołączeniu plików CSS i JS możesz używać wszystkich komponentów mdui.
Użycie wersji globalnej
Poniższy przykład pokazuje, jak używać globalnej wersji mdui. W tej wersji wszystkie funkcje są dostępne jako właściwości globalnego obiektu 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">Kliknij mnie</mdui-button>
<script>
document.querySelector('.btn').addEventListener('click', () => {
mdui.snackbar({ message: 'Kliknięto przycisk' });
});
</script>Użycie wersji ES module
Poniższy przykład pokazuje, jak używać wersji ES module mdui. W tej wersji możesz używać składni ES module do importowania mdui z CDN:
<link rel="stylesheet" href="https://unpkg.com/mdui@2/mdui.css">
<mdui-button class="btn">Kliknij mnie</mdui-button>
<script type="module">
import { snackbar } from 'https://unpkg.com/mdui@2/mdui.esm.js';
document.querySelector('.btn').addEventListener('click', () => {
snackbar({ message: 'Kliknięto przycisk' });
});
</script>