vue3 【提效】自动导入框架方法 unplugin-auto-import 实用教程

简介: vue3 【提效】自动导入框架方法 unplugin-auto-import 实用教程

是否还在为每次都需要导入框架方法而烦恼呢?

// 每次都需手动导入框架方法
import { ref } from 'vue'

let num = ref(0)

用 unplugin-auto-import 来帮你吧,以后只需这样写就行啦!

let num = ref(0)

官方示例如下图

使用流程

1. 安装 unplugin-auto-import

npm i -D unplugin-auto-import

2. vite 配置中导入

vite.config.ts

import AutoImport from 'unplugin-auto-import/vite'
// 项目中集成了 unplugin-vue-router 时,此处导入VueRouterAutoImports  需用  代替 vue-router
import { VueRouterAutoImports } from 'unplugin-vue-router'

plugins 中加入 AutoImport

  plugins: [
    // VueRouter  必须在 vue() 之前
    VueRouter({}),
    Layouts({
      layoutsDirs: 'src/layouts', // 指定布局文件的目录路径
      defaultLayout: 'default' // 指定默认布局文件的名称
    }),
    vue(),
    vueJsx(),
    vueDevTools(),
    AutoImport({
      // 解析的文件类型
      include: [
        /\.[tj]sx?$/, // .ts, .tsx, .js, .jsx
        /\.vue$/,
        /\.vue\?vue/, // .vue
        /\.md$/ // .md
      ],
      // 需自动导入方法的库
      imports: [
        'vue',
        'pinia',
        // 项目中集成了 unplugin-vue-router 时,此处需用 VueRouterAutoImports 替换掉 'vue-router'
        VueRouterAutoImports
      ]
    })
  ],
  • 若有其他想自动导入方法的库,在 imports 里添加即可

3. 添加 ts 相关配置

tsconfig.app.json 的 include 中添加 "auto-imports.d.ts" ,最终效果如下:

  "include": ["env.d.ts", "src/**/*", "src/**/*.vue", "auto-imports.d.ts"],

4. 重启 vscode

以便触发插件对相关文件的识别和解析

5. 重启项目

会重新生成 auto-imports.d.ts 文件(内部可见自动导入的框架方法)

通过下方代码测试效果:

<script setup lang="ts">
let num = ref(0)
</script>

<template>
  <div>{{ num }}</div>
</template>

若页面正常渲染无报错,恭喜配置成功!

更多配置和用法见官网

https://www.npmjs.com/package/unplugin-auto-import

目录
相关文章
|
6天前
|
缓存 监控 UED
升级 Vue3 时,如何减少打包体积的增加?
升级 Vue3 时,如何减少打包体积的增加?
85 59
|
5天前
|
JavaScript
在vue3中(vite)引入unocss,安装配置unocss
在vue3中(vite)引入unocss,安装配置unocss
|
6天前
|
API UED
如何实现Vue2项目升级Vue3?
如何实现Vue2项目升级Vue3?
13 1
|
6天前
|
API UED
升级 Vue3 后,项目的打包体积会有什么变化?
升级 Vue3 后,项目的打包体积会有什么变化?
92 57
|
7天前
|
JavaScript
vue组件中的插槽
本文介绍了Vue中组件的插槽使用,包括单个插槽和多个具名插槽的定义及在父组件中的使用方法,展示了如何通过插槽将父组件的内容插入到子组件的指定位置。
|
5天前
|
JavaScript
vue消息订阅与发布
vue消息订阅与发布
|
2天前
|
JavaScript
理解 Vue 的 setup 应用程序钩子
【10月更文挑战第3天】`setup` 函数是 Vue 3 中的新组件选项,在组件创建前调用,作为初始化逻辑的入口。它接收 `props` 和 `context` 两个参数,内部定义的变量和函数需通过 `return` 暴露给模板。`props` 包含父组件传入的属性,`context` 包含组件上下文信息。`setup` 可替代 `beforeCreate` 和 `created` 钩子,并提供类似 `data`、`computed` 和 `methods` 的功能,支持逻辑复用和 TypeScript 类型定义。
20 11
|
6天前
|
JavaScript 前端开发 IDE
Vue学习笔记5:用Vue的事件监听 实现数据更新的实时视图显示
Vue学习笔记5:用Vue的事件监听 实现数据更新的实时视图显示
|
6天前
|
JavaScript 前端开发 API
Vue学习笔记4:用reactive() 实现数据更新的实时视图显示
Vue学习笔记4:用reactive() 实现数据更新的实时视图显示
|
4天前
|
JavaScript
vue尚品汇商城项目-day07【vue插件-50.(了解)表单校验插件】
vue尚品汇商城项目-day07【vue插件-50.(了解)表单校验插件】
13 4
下一篇
无影云桌面