MDUI文件
複製 llms.txt 連結複製 llms-full.txt 連結以 Markdown 格式檢視此頁與 ChatGPT 討論此頁內容與 ChatGPT 討論專案完整文件
預設顏色
自選顏色
從桌布擷取顏色
請選擇一張桌布
開發指南
AI 輔助開發
樣式
與框架整合
元件
Avatar 頭像Badge 徽章BottomAppBar 底部應用程式列Button 按鈕ButtonIcon 圖示按鈕Card 卡片Checkbox 核取方塊Chip 標籤CircularProgress 環形進度條Collapse 收合區塊Dialog 對話框Divider 分隔線Dropdown 下拉元件Fab 浮動動作按鈕Icon 圖示Layout 版面配置LinearProgress 線性進度條List 清單Menu 選單NavigationBar 底部導覽列NavigationDrawer 導覽抽屜NavigationRail 側邊導覽列Radio 單選按鈕RangeSlider 範圍滑桿Select 選擇框SegmentedButton 分段按鈕Slider 滑桿Snackbar 消息條Switch 切換開關Tabs 分頁TextField 文字欄位Tooltip 工具提示TopAppBar 頂部應用程式列
函式
獨立程式庫

Icon圖示

圖示用於表示常見的操作。它支援 Material Icons 圖示,也支援使用 SVG 圖示。

使用方法

按需引入元件:

import 'mdui/components/icon.js';

按需引入元件的 TypeScript 型別:

import type { Icon } from 'mdui/components/icon.js';

使用範例:

<mdui-icon name="search"></mdui-icon>

使用 Material Icons 圖示

如果要透過這個元件使用 Material Icons 圖示,你需要另外引入 Material Icons 的 CSS 檔案。Material Icons 共有 5 種變體,分別為:Filled、Outlined、Rounded、Sharp、Two Tone,請依照你要使用的圖示變體,引入對應的 CSS 檔案:

<!-- Filled -->
<link
  href="https://fonts.googleapis.com/icon?family=Material+Icons"
  rel="stylesheet"
/>

<!-- Outlined -->
<link
  href="https://fonts.googleapis.com/icon?family=Material+Icons+Outlined"
  rel="stylesheet"
/>

<!-- Rounded -->
<link
  href="https://fonts.googleapis.com/icon?family=Material+Icons+Round"
  rel="stylesheet"
/>

<!-- Sharp -->
<link
  href="https://fonts.googleapis.com/icon?family=Material+Icons+Sharp"
  rel="stylesheet"
/>

<!-- Two Tone -->
<link
  href="https://fonts.googleapis.com/icon?family=Material+Icons+Two+Tone"
  rel="stylesheet"
/>

使用元件時,在 name 屬性中傳入圖示名稱,並以圖示變體名稱為後綴(Filled 變體無需加入後綴),以下是 delete 圖示的 5 種變體的使用方式:

<!-- Filled -->
<mdui-icon name="delete"></mdui-icon>

<!-- Outlined -->
<mdui-icon name="delete--outlined"></mdui-icon>

<!-- Rounded -->
<mdui-icon name="delete--rounded"></mdui-icon>

<!-- Sharp -->
<mdui-icon name="delete--sharp"></mdui-icon>

<!-- Two Tone -->
<mdui-icon name="delete--two-tone"></mdui-icon>

你可以直接在頁面下方的 Material Icons 圖示搜尋 工具中搜尋圖示,然後點選需要使用的圖示,就會自動將圖示程式碼複製到剪貼簿。

另外,mdui 還提供了一個獨立的套件 @mdui/icons,這個套件裡的每一個圖示元件都是一個獨立的檔案,讓你可以按需引入需要的圖示元件,而不需引入整個圖示庫。

使用 SVG 圖示

該元件也支援使用 SVG 圖示作為圖示內容。你可以透過元件的 src 屬性傳入 SVG 圖示的連結。例如:

<mdui-icon src="https://fonts.gstatic.com/s/i/materialicons/search/v17/24px.svg"></mdui-icon>

也可以在元件的 default slot 中傳入 SVG 的內容。例如:

<mdui-icon>
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
    <path d="M0 0h24v24H0z" fill="none"/>
    <path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/>
  </svg>
</mdui-icon>

範例

設定顏色

設定 <mdui-icon> 元素或父元素的 color CSS 樣式即可修改圖示顏色。

設定大小

設定 <mdui-icon> 元素或父元素的 font-size CSS 樣式即可修改圖示大小。

API

屬性

HTML 屬性JavaScript 屬性Reflect型別預設值
namenamestring-

Material Icons 圖示名

srcsrcstring-

svg 圖示的路徑

Slots

名稱
預設

svg 圖示的內容

FilledOutlinedRoundedSharpTwo tone
<mdui-icon name=""></mdui-icon>
本頁目錄