Установка
Вы можете установить mdui через npm или подключить через CDN. Рекомендуется устанавливать через npm.
Установка через npm
npm install mdui --save
Полный импорт
В точке входа вашего проекта импортируйте следующие два файла, чтобы использовать все компоненты mdui:
import 'mdui/mdui.css';
import 'mdui';
Вы также можете импортировать необходимые функции непосредственно из mdui. Например, чтобы импортировать функцию snackbar, сделайте следующее:
import { snackbar } from 'mdui';
import {
$,
dialog,
alert,
confirm,
prompt,
snackbar,
getTheme,
setTheme,
getColorFromImage,
setColorScheme,
removeColorScheme,
loadLocale,
setLocale,
getLocale,
throttle,
observeResize,
breakpoint
} from 'mdui';
Выборочный импорт
Для оптимизации размера проекта вы можете импортировать только необходимые компоненты и функции. Например, если вам нужен только компонент <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> для подключения mdui через CDN. Также можно скачать CSS и JavaScript файлы и разместить их на своём сервере. После подключения CSS и JS вы сможете использовать все компоненты 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. В этой сборке вы можете использовать синтаксис ES-модулей для импорта mdui из CDN:
<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>