Skip to content

图标 Icon

图标组件使用 symbol 格式的 SVG 图标,可以简单快速的使用本地的 SVG 图标。

Qii-UI 使用的图标来自 MingCute Icon 图标库。

安装插件

  1. 首先安装下面的两个插件(用来把 SVG 图标自动注册到 HTML 中)
bash
npm i vite-plugin-svg-icons -D
npm i fast-glob@3.x -D
  1. main.ts 中引入图标注册器。
ts
import 'virtual:svg-icons-register'
  1. vite.config.ts 中引入插件并配置图标目录。
ts
// 引入图标插件
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
import path from "path"

export default defineConfig({
  plugins: [
    createSvgIconsPlugin({
      iconDirs: [path.resolve(__dirname, 'src/icons')],  // 存放图标的目录
      symbolId: 'icon-[dir]-[name]'                      // symbolId 格式
    })
  ]
})
  1. 配置完成后,把你的图标放入设置的目录 src/icons 里面,就可以使用啦!
src
 └─ icons
      ├─ add.svg
      ├─ star.svg
      └─ more.svg

使用图标

在组件的 name 属性中填入图标文件的名称,即可使用图标。

颜色与大小

使用 colorsize 属性设置图标的颜色和大小。

旋转状态

添加 spin 属性可以让图标旋转起来。也可以使用 rotate 属性自定义旋转角度。

自定义图标

默认插槽中可以传入 SVG 代码来自定义图标。

API

Icon 属性

属性类型默认值说明
namestring图标名
colorstringcurrentColor图标颜色
sizestring1.5em图标大小
spinbooleanfalse图标是否为旋转状态
rotatenumber0自定义旋转角度

Icon 插槽

名称说明
default自定义图标