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

目录
相关文章
|
8天前
|
人工智能 自然语言处理 JavaScript
用 CodeBuddy 搭建Vue框架 像呼吸一样简单
本文介绍如何借助 CodeBuddy 快速创建 Vue 项目。CodeBuddy 是一款支持自然语言编程的工具,能根据用户需求自动生成代码,降低开发门槛。文章详细说明了通过 CodeBuddy 创建 Vue 项目的步骤,包括解决项目创建失败的问题、自动补全代码功能以及启动开发服务器的方法。无论开发者经验如何,CodeBuddy 都能显著提升效率,让开发更专注创意实现。
|
19天前
|
JavaScript 前端开发 算法
Vue 3 和 Vue 2 的区别及优点
Vue 3 和 Vue 2 的区别及优点
|
19天前
|
存储 JavaScript 前端开发
基于 ant-design-vue 和 Vue 3 封装的功能强大的表格组件
VTable 是一个基于 ant-design-vue 和 Vue 3 的多功能表格组件,支持列自定义、排序、本地化存储、行选择等功能。它继承了 Ant-Design-Vue Table 的所有特性并加以扩展,提供开箱即用的高性能体验。示例包括基础表格、可选择表格和自定义列渲染等。
|
2月前
|
JavaScript 前端开发 UED
vue2和vue3的响应式原理有何不同?
大家好,我是V哥。本文详细对比了Vue 2与Vue 3的响应式原理:Vue 2基于`Object.defineProperty()`,适合小型项目但存在性能瓶颈;Vue 3采用`Proxy`,大幅优化初始化、更新性能及内存占用,更高效稳定。此外,我建议前端开发者关注鸿蒙趋势,2025年将是国产化替代关键期,推荐《鸿蒙 HarmonyOS 开发之路》卷1助你入行。老项目用Vue 2?不妨升级到Vue 3,提升用户体验!关注V哥爱编程,全栈开发轻松上手。
103 2
|
2月前
|
JavaScript 前端开发 算法
高效工作流:用Mermaid绘制你的专属流程图;如何在Vue3中导入mermaid绘制流程图
mermaid是一款非常优秀的基于 JavaScript 的图表绘制工具,可渲染 Markdown 启发的文本定义以动态创建和修改图表。非常适合新手学习或者做一些弱交互且自定义要求不高的图表 除了流程图以外,mermaid还支持序列图、类图、状态图、实体关系图等图表可供探索。 博客不应该只有代码和解决方案,重点应该在于给出解决方案的同时分享思维模式,只有思维才能可持续地解决问题,只有思维才是真正值得学习和分享的核心要素。如果这篇博客能给您带来一点帮助,麻烦您点个赞支持一下,还可以收藏起来以备不时之需,有疑问和错误欢迎在评论区指出~
|
29天前
|
JavaScript
vue实现任务周期cron表达式选择组件
vue实现任务周期cron表达式选择组件
115 4
|
5月前
|
JavaScript
vue使用iconfont图标
vue使用iconfont图标
234 1
|
19天前
|
缓存 JavaScript 前端开发
Vue 基础语法介绍
Vue 基础语法介绍
|
2月前
|
JavaScript 前端开发 算法
vue渲染页面的原理
vue渲染页面的原理
140 56
|
2月前
|
SQL JavaScript 前端开发
Vue实现动态数据透视表(交叉表)
Vue实现动态数据透视表(交叉表)
188 13