Vue.js 3.0 结合 TypeScript 如何定义可跨组件复用的枚举?
Vue3 + TypeScript 跨组件复用枚举实现方案
枚举存放位置规则
不要将通用枚举直接定义在单个组件的<script setup lang="ts">块内,这类定义的作用域仅限当前组件,必然会造成跨组件重复编码的冗余。
结合你当前的项目目录结构,按项目规模选择对应的存放位置即可:
- 小型轻量项目:直接在
src根目录新建enums.ts单文件,所有跨组件复用的枚举统一存入该文件,无需额外创建子目录 - 中大型项目:在
src根目录新建src/types目录,专门存放公共TS类型、枚举;枚举数量增多后可以按业务模块拆分独立文件(比如color.ts、order-status.ts),避免单文件过大难以维护
调整后的目录参考:
src/ ├─ components/ │ ├─ ParentComponent.vue │ └─ ChildComponent.vue ├─ types/ │ └─ color.ts // 存储Color枚举的独立文件 └─ App.vue
枚举的标准编写方式
TS枚举只要做了显式导出,就可以被任意文件引入复用,没有特殊语法要求,推荐两个实用编写规范:
- 优先使用字符串枚举而非数字枚举,运行时可以直接看到枚举值的语义,调试排查更方便
- 不要在枚举内部依赖仅当前组件存在的局部类型,避免跨文件引用时出现类型报错
以你需要用到的Color枚举为例,在src/types/color.ts中的写法:
// 必须添加export关键字,否则其他文件无法正常引入 export enum Color { Red = 'RED', Green = 'GREEN', Blue = 'BLUE' }
组件内的引入方式
不再需要在各个组件内重复定义枚举,直接在业务组件中引入导出的枚举即可:
ChildComponent.vue 示例
<script setup lang="ts"> // 配置了@别名指向src时使用该路径;未配置别名时替换为相对路径 '../types/color' import { Color } from '@/types/color' // 业务逻辑中正常使用枚举 const currentColor = Color.Red </script>
ParentComponent.vue 示例
<script setup lang="ts"> import { Color } from '@/types/color' // 如需在模板中调用枚举,可将枚举赋值给常量暴露给模板 const colorEnum = Color </script> <template> <span :class="colorEnum.Green">绿色状态标记</span> </template>
注意事项
- Vue3 + Vite构建场景下,尽量避免使用
const enum写法,该写法存在兼容性问题,普通导出的枚举完全可以满足复用需求 - 跨组件枚举数量增多后,按业务模块拆分独立文件,不要将所有枚举堆砌在单文件中,降低后续维护成本
内容的提问来源于stack exchange,提问作者kusumoto_teruya
相关产品推荐
相关产品推荐

