基于vue3+ts+vite的项目使用‘unplugin-auto-import/vite’插件,自动全局导入api的注意事项
在Vue 3, TypeScript 和 Vite 项目中使用 unplugin-auto-import
插件自动全局导入 API 的基本步骤如下:
- 安装插件:
npm install unplugin-auto-import -D
- 在
vite.config.ts
中配置插件:
import AutoImport from 'unplugin-auto-import/vite';
export default {
plugins: [
AutoImport({
imports: ['vue'],
dts: 'src/auto-imports.d.ts',
}),
],
};
- 在
src/auto-imports.d.ts
中添加类型声明(如果你想要 TypeScript 能够识别这些自动导入的变量):
/// <reference types="vue/macros-global" />
- 现在你可以在任何组件或者脚本中直接使用自动导入的 API,无需显式导入。例如,如果你想要自动导入 Vue 的
ref
函数,你只需直接使用它而不需要导入:
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const count = ref(0);
// ...
}
});
unplugin-auto-import
插件会在构建时自动在需要的地方注入相应的导入语句。这样你可以节省手动导入的时间,并使代码更加简洁和高效。
评论已关闭