使用unplugin-auto-import自动导入vue3的api,不需要在每一个.vue文件中重复去导入操作

1、unplugin-auto-import包的作用

自动导入Vue3的API‌:自动导入Vue 3的Composition API(如ref、reactive、computed等)以及其他常用库的API,如Vue Router的useRoute、useRouter或Pinia的defineStore等

2、unplugin-auto-import的配制

import AutoImport from "unplugin-auto-import/vite";
export default defineConfig({
  plugins: [
    ...
    AutoImport({
      imports: [
        "vue",
        "vue-router"
      ],
      dts: true, //会生成一个auto-import.d.ts文件,默认在根目录下
    }),
  ],
  resolve: {
    alias: {
      "@": fileURLToPath(new URL("./src", import.meta.url)),
    },
  },
});

以下是可配制的参数:

3、配制完成以后会生成一个文件:

4、.vue文件中不需要import相应的api

### 配置 `unplugin-auto-import` 插件 为了在 Vue 3 项目中配置 `unplugin-auto-import` 插件,可以按照以下方法操作: #### 安装依赖包 首先安装必要的 npm 包。这包括 `unplugin-auto-import` 和其 Vite 或 Webpack 特定版本的适配器之一。 ```bash npm install unplugin-auto-import vite-plugin-vue @vue/compiler-sfc --save-dev ``` 对于使用 Vite 的 Vue 3 项目来说,上述命令会安装所需的工具集;如果是在其他构建环境下,则应替换相应的打包工具插件部分。 #### 修改配置文件 接着修改项目的构建配置文件(通常是 `vite.config.ts` 或者 `webpack.config.js`),加入该插件的支持并指定自动导入的内容范围。 针对 Vite 用户,在 `vite.config.ts` 中添加如下代码片段[^1]: ```typescript // vite.config.ts import { defineConfig } from &#39;vite&#39; import vue from &#39;@vitejs/plugin-vue&#39; import AutoImport from &#39;unplugin-auto-import/vite&#39; export default defineConfig({ plugins: [ vue(), AutoImport({ imports: [&#39;vue&#39;], dts: &#39;src/auto-imports.d.ts&#39;, // 可选:生成 TypeScript 声明文件的位置 }), ], }) ``` 这段脚本启用了 `AutoImport` 功能,并指定了要自动加载的对象列表以及可选项中的类型声明输出路径。 #### 使用自动生成的功能 完成以上设置之后,无需手动引入即可直接访问所列模块内的成员变量或函数。例如可以直接书写 `<script setup>` 组件而需要显式地写入 `import { ref, reactive } from &#39;vue&#39;` 这样的语句来获取响应式的 API 接口。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值