Icon 圖示

圖示元件，提供豐富的圖示資源。

基礎用法

基礎用法

<script setup lang="ts">
import { LhIcon } from '@lh-ui/vue3'
</script>

<template>
  <!-- 星形 -->
  <LhIcon name="star" />
  <!-- 搜尋 -->
  <LhIcon name="search" />
  <!-- 打勾 -->
  <LhIcon name="check" />
  <!-- 關閉 -->
  <LhIcon name="close" />
  <!-- 編輯 -->
  <LhIcon name="edit" />
  <!-- 刪除 -->
  <LhIcon name="delete" />
  <!-- 載入中 -->
  <LhIcon name="loading" />
  <!-- 向上箭頭 -->
  <LhIcon name="arrow-up" />
  <!-- 向下箭頭 -->
  <LhIcon name="arrow-down" />
  <!-- 向左箭頭 -->
  <LhIcon name="arrow-left" />
  <!-- 向右箭頭 -->
  <LhIcon name="arrow-right" />
</template>

<script>
import { LhIcon } from '@lh-ui/vue3'

export default {
  components: { LhIcon },
}
</script>

<template>
  <!-- 星形 -->
  <LhIcon name="star" />
  <!-- 搜尋 -->
  <LhIcon name="search" />
  <!-- 打勾 -->
  <LhIcon name="check" />
  <!-- 關閉 -->
  <LhIcon name="close" />
  <!-- 編輯 -->
  <LhIcon name="edit" />
  <!-- 刪除 -->
  <LhIcon name="delete" />
  <!-- 載入中 -->
  <LhIcon name="loading" />
  <!-- 向上箭頭 -->
  <LhIcon name="arrow-up" />
  <!-- 向下箭頭 -->
  <LhIcon name="arrow-down" />
  <!-- 向左箭頭 -->
  <LhIcon name="arrow-left" />
  <!-- 向右箭頭 -->
  <LhIcon name="arrow-right" />
</template>

不同尺寸

不同尺寸

<script setup lang="ts">
</script>

<template>
  <LhIcon name="star" size="small" />
  <LhIcon name="star" size="default" />
  <LhIcon name="star" size="large" />
  <LhIcon name="star" size="x-large" />
</template>

<script>
export default {}
</script>

<template>
  <LhIcon name="star" size="small" />
  <LhIcon name="star" size="default" />
  <LhIcon name="star" size="large" />
  <LhIcon name="star" size="x-large" />
</template>

自訂顏色

自訂顏色

<script setup lang="ts">
</script>

<template>
  <LhIcon name="star" color="#e6a23c" />
  <LhIcon name="search" color="#409eff" />
  <LhIcon name="check" color="#67c23a" />
  <LhIcon name="close" color="#f56c6c" />
</template>

<script>
export default {}
</script>

<template>
  <LhIcon name="star" color="#e6a23c" />
  <LhIcon name="search" color="#409eff" />
  <LhIcon name="check" color="#67c23a" />
  <LhIcon name="close" color="#f56c6c" />
</template>

國際化

圖示元件本身不涉及文案，但可透過 LhConfigProvider 配合語言包實作周邊文字的國際化。

國際化

<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhIcon, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

const locale = ref('zh-CN')
</script>

<template>
  <!-- 語言環境切換 -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhIcon name="star" />
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhIcon, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhIcon, LhButton },
  data() {
    return {
      locale: 'zh-CN',
      zhCN: zhCN,
      enUS: enUS,
    }
  },
}
</script>

<template>
  <!-- 語言環境切換 -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhIcon name="star" />
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

Icon API

Props

屬性名	說明	類型	預設值
name	圖示名稱	"star" | "search" | "check" | "close" | "arrow-up" | "arrow-down" | "arrow-left" | "arrow-right" | "warning" | "error" | "info" | "loading" | "plus" | "minus" | "edit" | "delete" | "setting" | "user" | "home" | "menu" | "more" | "download" | "upload" | "refresh" | "folder" | "file" | "date" | "clock" | "email" | "phone" | "location" | "image" | "share" | "bell" | "filter" | "eye" | "link"	—
size	圖示尺寸	string | number	—
color	圖示顏色	string	—
themeVars	元件級主題變數，覆寫 ConfigProvider 設定	{ [x: string]: string; }	—
bgPattern	元件級背景花紋，覆寫 ConfigProvider 設定	string	—

Slots

插槽名	說明
default	自訂圖示內容

類型定義

本元件對外匯出的 TypeScript 類型結構如下（自動提取自 packages/components/icon/src/types.ts 與 @lh-ui/share/core/* 原始碼，點選各條目展開檢視完整定義；屬性說明見上方 Props 表）：

LhIconProps

/**
 * Icon 元件 Props
 */
export interface LhIconProps {
  /** 圖示名稱 */
  name?: LhIconName
  /** 圖示尺寸 */
  size?: string | number
  /** 圖示顏色 */
  color?: string
  /** 元件級主題變數，覆寫 ConfigProvider 設定 */
  themeVars?: Record<string, string>
  /** 元件級背景花紋，覆寫 ConfigProvider 設定 */
  bgPattern?: string
}

LhIconSize

export type LhIconSize = string | number

LhIconName _{（來自 @lh-ui/share/core/icon (svgs.ts)）}

export type LhIconName = keyof typeof LH_ICON_SVGS_CONST