Instalação
Você pode optar por instalar o mdui via npm ou importá-lo de um CDN. Recomenda-se o uso do npm.
Instalação via npm
npm install mdui --save
Importação completa
Importe os dois arquivos abaixo no arquivo de entrada do projeto para usar todos os componentes do mdui:
import 'mdui/mdui.css';
import 'mdui';
Você também pode importar diretamente as funções necessárias do mdui. Por exemplo, para importar a função snackbar, faça o seguinte:
import { snackbar } from 'mdui';
import {
$,
dialog,
alert,
confirm,
prompt,
snackbar,
getTheme,
setTheme,
getColorFromImage,
setColorScheme,
removeColorScheme,
loadLocale,
setLocale,
getLocale,
throttle,
observeResize,
breakpoint
} from 'mdui';Importação sob demanda
Para otimizar o tamanho do projeto, você pode importar apenas os componentes e funções necessários. Por exemplo, se você precisar apenas do componente <mdui-button> e da função snackbar, pode fazer a importação da seguinte forma:
// O arquivo CSS sempre precisa ser importado
import 'mdui/mdui.css';
// Importar o componente <mdui-button>
import 'mdui/components/button.js';
// Importar a função snackbar
import { snackbar } from 'mdui/functions/snackbar.js';
A página de documentação de cada componente ou função descreve em detalhes como fazer a importação sob demanda.
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
Você pode usar as tags <link> e <script> para usar o mdui diretamente via CDN. Também pode baixar os arquivos CSS e JavaScript e hospedar em seu próprio servidor. Após importar os arquivos CSS e JavaScript, você pode usar todos os componentes do mdui.
Usando a versão de build global
O exemplo a seguir mostra como usar a versão de build global do mdui. Nesta versão, todas as funções são expostas como propriedades no objeto global 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">Clique em mim</mdui-button>
<script>
document.querySelector('.btn').addEventListener('click', () => {
mdui.snackbar({ message: 'Botão clicado' });
});
</script>Usando a versão de build ES Module
O exemplo a seguir mostra como usar a versão de build ES Module do mdui. Nesta versão, você pode usar a sintaxe de módulo ES para importar o mdui do CDN:
<link rel="stylesheet" href="https://unpkg.com/mdui@2/mdui.css">
<mdui-button class="btn">Clique em mim</mdui-button>
<script type="module">
import { snackbar } from 'https://unpkg.com/mdui@2/mdui.esm.js';
document.querySelector('.btn').addEventListener('click', () => {
snackbar({ message: 'Botão clicado' });
});
</script>