Vue3 + Element Plus 按需引入 - 自动导入_components.d.ts

1 前言

1.1 目的

Element Plus 使用按需引入，大大缩小打包后的文件大小

1.2 最终效果

自动生成 components.d.ts 文件，并在文件中引入 Element Plus 组件

自动生成 components.d.ts 文件，并在文件中引入 Element Plus API

2 准备工作

安装 Element Plus

# 选择一个你喜欢的包管理器

# NPM
$ npm install element-plus --save

# Yarn
$ yarn add element-plus

# pnpm
$ pnpm install element-plus
1
2
3
4
5
6
7
8
9
10

3 按需引入

3.1 安装插件

• 组件按需引入所需插件：unplugin-auto-import 、 unplugin-vue-components
• 图标按需引入所需插件：unplugin-auto-import 、 unplugin-icons

只需要安装到开发环境

$ pnpm i unplugin-auto-import unplugin-vue-components unplugin-icons -D
1

3.2 修改 vite.config.ts 文件

4 其他

4.1 ElMessageBox 使用时报错

若修改后还是报错，重启再看看

4.1.1 Eslint 报错： ‘ElMessageBox’ is not defined.eslint(no-undef)

修改 vite.config.ts 配置： AutoImport 增加 eslintrc ，自动生成 .eslintrc-auto-import.json 文件

修改 .eslintrc.js 配置：

4.1.2 TS 报错： Cannot find name ‘ElMessageBox’

修改 tsconfig.json 配置： include 中增加 “./auto-imports.d.ts”

"include": [
  "src/**/*.ts",
  "src/**/*.d.ts",
  "src/**/*.tsx",
  "src/**/*.vue",
  "./auto-imports.d.ts"
], 
1
2
3
4
5
6
7

4.2 ElMessageBox 弹框样式未生效

使用按需引入后，不能再手动引入 ElMessageBox ，否则会引起样式冲突，需要删除手动引入 ElMessageBox 部分代码

4.3 图标使用

注意，-ep- 是 vite.config.ts 文件中配置的，必须保持一致

<!-- 直接使用 -->
<i-ep-menu />

<!-- 嵌套使用 -->
<el-icon><i-ep-menu /></el-icon>
1
2
3
4
5

4.4 修改命名空间

将所有el-替换为ep-，一般用于避免样式冲突

1. 使用 ElConfigProvider 包装根组件

<!-- App.vue -->
<template>
  <el-config-provider namespace="ep">
    <!-- ... -->
  </el-config-provider>
</template>
1
2
3
4
5
6

2. 创建 styles/element/index.scss

// styles/element/index.scss
@forward 'element-plus/theme-chalk/src/mixins/config.scss' with (
  $namespace: 'ep'
);
1
2
3
4

3. 导入 index.scss

// vite.config.ts
export default defineConfig({
  css: {
    preprocessorOptions: {
      scss: {
        // 注意 "styles/element/index.scss" 文件路径是否正确
        additionalData: `@use "styles/element/index.scss" as *;`,
      },
    },
  },
  // ...
})
1
2
3
4
5
6
7
8
9
10
11
12

4. 修改 ElementPlusResolver

// vite.config.ts
// ElementPlusResolver 传入 importStyle 参数
ElementPlusResolver({
  importStyle: 'sass'
})
1
2
3
4
5