Icon 图标组件

用于项目内组件的展示,基本支持所有图标库(支持按需加载,只打包所用到的图标),支持使用本地 svg 和 Iconify 图标。

Icon 组件位于 src/components/Icon

TIP

Iconify 上,你可以查询到你想要的所有图标并使用,不管是不是 element-plus 的图标库。

用法

基本用法

如果以svg-icon: 开头,则会在本地中找到该 svg 图标,否则,会加载 Iconify 图标。

<template>
  <!-- 加载本地 svg -->
  <Icon icon="svg-icon:peoples" />
  
  <!-- 加载 Iconify -->
  <Icon icon="ep:aim" />
</template>

useIcon

如果需要在其他组件中如 ElButton 传入 icon 属性,可以使用 useIcon

<script setup lang="ts">
import { useIcon } from '@/hooks/web/useIcon'
import { ElButton } from 'element-plus'

const icon = useIcon({ icon: 'svg-icon:save' })
</script>

<template>
  <ElButton :icon="icon"> button </ElButton>
</template>

参数介绍

const icon = useIcon(props)

props

详见

Icon 属性

属性说明类型可选值默认值
icon图标名string--
color图标颜色string--
size图标大小number-16