Vue3按需引入element plus 以及icon

本文介绍了作者在自学Vue3时遇到的element-plus安装、按需导入插件、配置vite.config.js以及解决遇到的四个主要问题的过程,包括模块缺失、图标显示、动态组件和侧边栏菜单的图标显示问题。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

         最近在自学Vue3,打算做一个纯前端的小东西,记录一下element-plus的安装和使用。以下是安装使用过程,以及踩过的坑。

一、安装element-plus及icon

npm i element-plus @element-plus/icons-vue -S

二、安装按需导入的插件

npm i  unplugin-auto-import unplugin-vue-components unplugin-icons -D

三、配置vite.config.js

我是从官网上拷贝的配置内容,官网配置文件地址 其中 “import Inspect from 'vite-plugin-inspect'” 我本地飘红,网上也搜索不到就删掉了

import path from 'path'
import { defineConfig } from 'vite'
import Vue from '@vitejs/plugin-vue'
import Icons from 'unplugin-icons/vite'
import IconsResolver from 'unplugin-icons/resolver'
import AutoImport from 'unplugin-auto-import/vite'
import Components from 'unplugin-vue-components/vite'
import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'

const pathSrc = path.resolve(__dirname, 'src')

export default defineConfig({
  resolve: {
    alias: {
      '@': pathSrc,
    },
  },
  plugins: [
    Vue(),
    AutoImport({
      // Auto import functions from Vue, e.g. ref, reactive, toRef...
      // 自动导入 Vue 相关函数,如:ref, reactive, toRef 等
      imports: ['vue'],

      // Auto import functions from Element Plus, e.g. ElMessage, ElMessageBox... (with style)
      // 自动导入 Element Plus 相关函数,如:ElMessage, ElMessageBox... (带样式)
      resolvers: [
        ElementPlusResolver(),

        // Auto import icon components
        // 自动导入图标组件
        IconsResolver({
          prefix: 'Icon',
        }),
      ],

      dts: path.resolve(pathSrc, 'auto-imports.d.ts'),
    }),

    Components({
      resolvers: [
        // Auto register icon components
        // 自动注册图标组件
        IconsResolver({
          enabledCollections: ['ep'],
        }),
        // Auto register Element Plus components
        // 自动导入 Element Plus 组件
        ElementPlusResolver(),
      ],

      dts: path.resolve(pathSrc, 'components.d.ts'),
    }),

    Icons({
      autoInstall: true,
    }),

  ],
})

四、踩过的坑

1、can not find module 'path',从官网拷贝回来的配置文件第一行就飘红了,网上找的解决方案

npm install -D @types/node

2、按照官网配置以后,icon图标不显示,浏览器控制台还出现了警告:“ [Vue warn]: Failed to resolve component: edit
If this is a native custom element, make sure to exclude it from component resolution via compilerOptions.isCustomElement. ” 

也是百度查询的解决方案。修改icon的写法:在原来icon写法的基础上增加 i-ep-前缀

<i-ep-location/>

3、按照上述都进行了设置,在修改icon的写法的时候,发现 @iconify-json/ep 会自动安装上。等待安装结束以后一切就正常了

4、动态生成侧边栏菜单时icon不显示

在静态显示图标成功以后,我在路由中设置的图标名称加了前缀i-ep-,并使用了<component>动态组件来渲染图标,以下是最开始的写法。结果icon还是没有渲染出来。

  name: 'home',
  path: '/home',
  component: () => import('../../views/home/index.vue'),
  meta: { title: '首页', icon: 'i-ep-House' },
<el-icon><component :is="item.meta.icon"/></el-icon>

在百度上搜了一圈以后发现是因为在vue3中 component需要用使用:is动态绑定组件,而不是简单的字符串了。将icon名称重新修改,去掉引号,并且修改前缀为IconEp后问题解决。如下所示:

  name: 'home',
  path: '/home',
  component: () => import('../../views/home/index.vue'),
  meta: { title: '首页', icon: IconEpHouse },

参考文章地址

### 如何在 Element Plus 中实现 Icon 的按引入 为了实现在 Vue3 项目中按引入 Element Plus 的图标,可以遵循以下方法: #### 安装必要的依赖包 确保已经安装 `element-plus` 及其图标库 `@element-plus/icons-vue`。这可以通过 npm 来完成。 ```bash npm install element-plus @element-plus/icons-vue --save ``` 对于按加载的支持,还要额外安装几个工具来帮助自动处理组件和图标的注册工作。 ```bash npm install unplugin-auto-import unplugin-vue-components unplugin-icons --save-dev ``` 这些插件能够简化开发流程,在构建过程中动态分析并只打包实际使用的模块[^2]。 #### 配置 Vite 构建工具 如果正在使用 Vite 进行项目的构建,则要修改 `vite.config.js` 文件以集成上述提到的插件。通过这种方式可以让 Vite 自动检测到应用里用到了哪些具体的 Element 组件或图标,并仅将它们加入最终的打包文件之中。 ```javascript import { defineConfig } from &#39;vite&#39; import AutoImport from &#39;unplugin-auto-import/vite&#39; import Components from &#39;unplugin-vue-components/vite&#39; export default defineConfig({ plugins: [ AutoImport({ imports: [&#39;vue&#39;, &#39;vue-router&#39;], dts: true, }), Components({ resolvers: [ // 解析 Element Plus 组件 /* ... */ ] }) ], }) ``` 请注意这里省略了一些细节性的配置项;具体可以根据官方文档调整适合自己的设置。 #### 注册全局组件与图标 一种方式是在入口文件(通常是 `main.js` 或者 `main.ts`)里面批量导入所有的图标作为全局组件。不过这种方法并不推荐用于生产环境下的大型应用程序,因为它会增加不必要的体积负担。 另一种更优的做法是利用前面介绍过的两个插件来进行懒加载式的局部注册。这样既保持了灵活性又提高了性能效率。 当采用后者时,可以在模板内直接书写 `<component :is="iconName"></component>` 形式的语法来引用所的具体图标实例而无提前声明每一个可能要用到的名字[^3]。 #### 使用示例 下面给出一段简单的例子展示如何在一个按钮上添加箭头向右的图标: ```html <template> <div class="example"> <!-- 直接写 el-icon 标签 --> <el-button type="primary" round> Next Step<i class="el-icon-arrow-right"/> </el-button> <!-- 动态绑定 is 属性的方式 --> <el-button v-bind="$attrs" circle><component :is="&#39;ElIconArrowRight&#39;"/></el-button> </div> </template> <script setup lang="ts"> // 不再显式 import 各种图标... </script> ``` 以上就是关于怎样在基于 Vue3 的项目里高效地管理来自 Element Plus 库中的各种矢量图形资源的一些指导建议[^4]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

大宝贱

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值