如何在 Vue3 组件中使用 TS 类型，看完这篇就够了

作者：前端阿飞

https://juejin.cn/post/7129130323148800031

要说今年最热门的前端技术，Vue3 和 TS 绝对榜上有名了。据了解，已经有很多公司在使用 Vue3 + TS + Vite 开发新项目了。那么我们也不能落后，今天就给大家分享一下如何在 Vue3 组件中结合 Composition-Api 使用 TS 类型。如果有不会或者不熟的小伙伴，一起学起来吧！

为 props 标注类型

使用


这被称为 运行时声明 ，因为传递给 defineProps() 的参数会作为运行时的 props 选项使用。

第二种方式，通过泛型参数来定义 props 的类型，这种方式更加直接：


const props = defineProps<{
  foo: string
  bar?: number
}>()


// or

interface Props {
  foo: string
  bar?: number
}

const props = defineProps()



这被称为 基于类型的声明 ，编译器会尽可能地尝试根据类型参数推导出等价的运行时选项。这种方式的不足之处在于，失去了定义 props 默认值的能力。为了解决这个问题，我们可以使用 withDefaults 编译器宏：

interface Props {
  msg?: string
  labels?: string[]
}

const props = withDefaults(defineProps(), {
  msg: 'hello',
  labels: () => ['one', 'two']
})


上面代码会被编译为等价的运行时 props 的 default 选项。

非


我们可以看到，基于类型的声明 可以使我们对所触发事件的类型进行更细粒度的控制。

非




没有类型标注时，这个 event 参数会隐式地标注为 any 类型。这也会在 tsconfig.json 中配置了 "strict": true 或 "noImplicitAny": true 时报出一个 TS 错误。因此，建议显式地为事件处理函数的参数标注类型。此外，你可能需要显式地强制转换 event 上的属性：

function handleChange(event: Event) {
  console.log((event.target as HTMLInputElement).value)
}


为 provide / inject 标注类型

provide 和 inject 通常会在不同的组件中运行。要正确地为注入的值标记类型，Vue 提供了一个 InjectionKey 接口，它是一个继承自 Symbol 的泛型类型，可以用来在提供者和消费者之间同步注入值的类型：

import { provide, inject } from 'vue'
import type { InjectionKey } from 'vue'

const key = Symbol() as InjectionKey

provide(key, 'foo') // 若提供的是非字符串值会导致错误

const foo = inject(key) // foo 的类型：string | undefined


建议将注入 key 的类型放在一个单独的文件中，这样它就可以被多个组件导入。

当使用字符串注入 key 时，注入值的类型是 unknown，需要通过泛型参数显式声明：

const foo = inject('key') // 类型：string | undefined


注意注入的值仍然可以是 undefined，因为无法保证提供者一定会在运行时 provide 这个值。当提供了一个默认值后，这个 undefined 类型就可以被移除：

const foo = inject('foo', 'bar') // 类型：string


如果你确定该值将始终被提供，则还可以强制转换该值：

const foo = inject('foo') as string


为 dom 模板引用标注类型

模板 ref 需要通过一个显式指定的泛型参数和一个初始值 null 来创建：


import { ref, onMounted } from 'vue'

const el = ref(null)

onMounted(() => {
  el.value?.focus()
})





注意为了严格的类型安全，有必要在访问 el.value 时使用可选链或类型守卫。这是因为直到组件被挂载前，这个 ref 的值都是初始的 null，并且 v-if 将引用的元素卸载时也会被设置为 null。

为组件模板引用标注类型

有时，我们需要为一个子组件添加一个模板 ref，以便调用它公开的方法。比如，我们有一个 MyModal 子组件，它有一个打开模态框的方法：



import { ref } from 'vue'

const isContentShown = ref(false)
const open = () => (isContentShown.value = true)

defineExpose({
  open
})



为了获取 MyModal 的类型，我们首先需要通过 typeof 得到其类型，再使用 TypeScript 内置的 InstanceType 工具类型来获取其实例类型：



import MyModal from './MyModal.vue'

const modal = ref | null>(null)

const openModal = () => {
  modal.value?.open()
}



Ok，以上就是在 Vue3 组件中使用 TS 类型的基本方法，也是我最近的 Vue3 学习笔记。欢迎在评论区交流讨论，一起学习成长！

如果对你有所帮助，不要忘了点赞支持一下哦 ~

参考文档：v3.cn.vuejs.org/guide/introduction.html

- EOF -