Vite中plugins怎么安装和配置unplugin-auto-import以实现组件库自动引入

风杰小哥_8288

风杰小哥_8288

2026-07-24

416人浏览

原创

unplugin-auto-import 用于自动引入 composition api、框架库及工具库的函数,不处理组件引入;需配合 unplugin-vue-components 实现组件库自动引入。

vite中plugins怎么安装和配置unplugin-auto-import以实现组件库自动引入

在 Vite 项目中,unplugin-auto-import 用于自动引入 Composition API(如 ref、computed)、框架库(Vue、Vue Router、Pinia)及工具库(如 @vueuse/core),但它不负责组件自动引入——那是 unplugin-vue-components 的职责。如果你的目标是“组件库自动引入”,实际需要的是两者配合使用,而 unplugin-auto-import 主要解决的是 API 函数的免 import。

安装 unplugin-auto-import

执行以下命令安装(开发依赖):

  • npm install -D unplugin-auto-import
  • 或 yarn add -D unplugin-auto-import
  • 或 pnpm add -D unplugin-auto-import

基础配置(vite.config.ts)

在 vite.config.ts 中导入并启用插件,指定要自动导入的库和类型声明路径:

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import AutoImport from 'unplugin-auto-import/vite'

export default defineConfig({
  plugins: [
    vue(),
    AutoImport({
      imports: ['vue', 'vue-router', 'pinia', '@vueuse/core'],
      dts: 'src/auto-imports.d.ts',
      eslintrc: {
        enabled: true,
        filepath: './.eslintrc-auto-import.json'
      }
    })
  ]
})

配置后首次启动或保存时,插件会自动生成 src/auto-imports.d.ts,为 TypeScript 提供类型提示,并同步更新 ESLint 全局变量声明。

Vite
Vite

为开发、生产构建和库打包配置并优化 Vite。

下载

支持组件库的 API 自动引入(如 Element Plus、Ant Design Vue)

若你用的是 Element Plus 等 UI 库,其 useXXX 组合式函数(如 useMessage、useNotification)也需纳入自动导入范围。官方推荐方式是通过 resolvers 配合 unplugin-vue-components 处理组件,而 unplugin-auto-import 则借助对应 resolver 补充 API:

  • 安装 resolver:例如 npm install -D @element-plus/icons-vue(按需)
  • 在 AutoImport 配置中加入 resolver(需额外安装 unplugin-auto-import/resolvers):
import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'
// 注意:ElementPlusResolver 同时服务于 unplugin-vue-components 和 unplugin-auto-import
AutoImport({
  resolvers: [ElementPlusResolver()],
  imports: ['vue', 'vue-router', 'pinia']
})

这样 ElMessage、useMessage 等都会被识别并自动导入。

本地自定义 Hooks / Composables 自动导入

把封装好的组合式函数放在统一目录(如 src/composables),可通过 dirs 选项让插件扫描导出内容:

AutoImport({
  imports: ['vue'],
  dirs: ['src/composables/**'],
  dts: 'src/auto-imports.d.ts'
})

例如 src/composables/useApi.ts 导出 useApi,之后在任意 .vue 或 .ts 文件中直接使用,无需 import。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4606

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1149

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4524

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1816

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3285

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4273

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2780

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 80.5万人学习

Webpack4.x---十天技能课堂
Webpack4.x---十天技能课堂

共20课时 | 2.1万人学习

两小时学会 Webpack
两小时学会 Webpack

共14课时 | 2.1万人学习