vue3組件TS類型聲明實例代碼

目錄 前言 為 props 標注類型 使用setup setup 為 emits 標注類型 setup 非setup 為 ref() 標注類型 默認推導類型 通過接口指定類型 通過泛型指定類型 為 reactive() 標注類型 默認推導類型 通過接口

目錄

• 前言
• 為 props 標注類型
• 使用setup
• setup
• 為 emits 標注類型
• setup
• 非setup
• 為 ref() 標注類型
• 默認推導類型
• 通過接口指定類型
• 通過泛型指定類型
• 為 reactive() 標注類型
• 默認推導類型
• 通過接口指定類型
• 為 computed() 標注類型
• 默認推導類型
• 通過泛型指定類型
• 為事件處理函數標注類型
• 為 provide / inject 標注類型
• 總結

前言

要說今年最熱門的前端技術，Vue3 和 TS 絕對榜上有名了。據了解，已經有很多公司在使用 Vue3 + TS + Vite 開發新項目了。那么我們也不能落后，今天就給大家分享一下如何在 Vue3 組件中結合 Composition-Api 使用 TS 類型。如果有不會或者不熟的小伙伴，一起學起來吧！

為 props 標注類型

使用setup

當使用

<script setup lang="ts">
const props = defineProps({
  foo: { type: String, required: true },
  bar: Number
})

props.foo // string
props.bar // number | undefined
</script>

這被稱為 運行時聲明 ，因為傳遞給 defineProps() 的參數會作為運行時的 props 選項使用。

第二種方式，通過泛型參數來定義 props 的類型，這種方式更加直接：

<script setup lang="ts">
const props = defineProps<{
  foo: string
  bar?: number
}>()
</script>

這被稱為 基于類型的聲明 ，編譯器會盡可能地嘗試根據類型參數推導出等價的運行時選項。

我們也可以將 props 的類型移入一個單獨的接口中：

<script setup lang="ts">
interface Props {
  foo: string
  bar?: number
}

const props = defineProps<Props>()
</script>

基于類型的方式更加簡潔，但失去了定義 props 默認值的能力。我們可以通過目前實驗性的 響應性語法糖 來解決：

<script setup lang="ts">
interface Props {
  foo: string
  bar?: number
}
// 響應性語法糖 默認值會被編譯為等價的運行時選項
const { foo, bar = 100 } = defineProps()

這個行為目前需要在配置中顯式地選擇開啟：

// vite.config.js
export default {
  plugins: [
    vue({
      reactivityTransform: true
    })
  ]
}
// vue.config.js
module.exports = {
  chainWebpack: (config) => {
    config.module
      .rule('vue')
      .use('vue-loader')
      .tap((options) => {
        return {
          ...options,
          reactivityTransform: true
        }
      })
  }
}

setup

如果沒有使用

import { defineComponent } from 'vue'
export default defineComponent({
  props: {
    message: String
  },
  setup(props) {
    props.message // <-- 類型：string
  }
})

為 emits 標注類型

setup

在

<script setup lang="ts">
// 運行時
const emit = defineEmits(['change', 'update'])
// 基于類型
const emit = defineEmits<{
  (e: 'change', id: number): void
  (e: 'update', value: string): void
}>()
</script>

我們可以看到，基于類型的聲明 可以使我們對所觸發事件的類型進行更細粒度的控制。

非setup

若沒有使用

import { defineComponent } from 'vue'
export default defineComponent({
  emits: ['change'],
  setup(props, { emit }) {
    emit('change') // <-- 類型檢查 / 自動補全
  }
})

為 ref() 標注類型

默認推導類型

ref 會根據初始化時的值自動推導其類型：

import { ref } from 'vue'

// 推導出的類型：Ref<number>
const year = ref(2020)

// => TS Error: Type 'string' is not assignable to type 'number'.
year.value = '2020'

通過接口指定類型

有時我們可能想為 ref 內的值指定一個更復雜的類型，可以通過使用 Ref 這個接口：

import { ref } from 'vue'
import type { Ref } from 'vue'

const year: Ref<string | number> = ref('2020')

year.value = 2020 // 成功！

通過泛型指定類型

或者，在調用 ref() 時傳入一個泛型參數，來覆蓋默認的推導行為：

// 得到的類型：Ref<string | number>
const year = ref<string | number>('2020')
year.value = 2020 // 成功！

如果你指定了一個泛型參數但沒有給出初始值，那么最后得到的就將是一個包含 undefined 的聯合類型：

// 推導得到的類型：Ref<number | undefined>
const n = ref<number>()

為 reactive() 標注類型

默認推導類型

reactive() 也會隱式地從它的參數中推導類型：

import { reactive } from 'vue'
// 推導得到的類型：{ title: string }
const book = reactive({ title: 'Vue 3 指引' })

通過接口指定類型

要顯式地指定一個 reactive 變量的類型，我們可以使用接口：

import { reactive } from 'vue'
interface Book {
  title: string
  year?: number
}
const book: Book = reactive({ title: 'Vue 3 指引' })

為 computed() 標注類型

默認推導類型

computed() 會自動從其計算函數的返回值上推導出類型：

import { ref, computed } from 'vue'
const count = ref(0)
// 推導得到的類型：ComputedRef<number>
const double = computed(() => count.value * 2)
// => TS Error: Property 'split' does not exist on type 'number'
const result = double.value.split('')

通過泛型指定類型

你還可以通過泛型參數顯式指定類型：

const double = computed<number>(() => {
  // 若返回值不是 number 類型則會報錯
})

為事件處理函數標注類型

在處理原生 DOM 事件時，應該給事件處理函數的參數正確地標注類型。讓我們看一下這個例子：

<script setup lang="ts">
function handleChange(event) {
  // `event` 隱式地標注為 `any` 類型
  console.log(event.target.value)
}
</script>
<template>
  <input type="text" @change="handleChange" />
</template>

沒有類型標注時，這個 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<string>

provide(key, 'foo') // 若提供的是非字符串值會導致錯誤

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

建議將注入 key 的類型放在一個單獨的文件中，這樣它就可以被多個組件導入。

當使用字符串注入 key 時，注入值的類型是 unknown，需要通過泛型參數顯式聲明：

const foo = inject<string>('key') // 類型：string | undefined

注意注入的值仍然可以是 undefined，因為無法保證提供者一定會在運行時 provide 這個值。當提供了一個默認值后，這個 undefined 類型就可以被移除：

const foo = inject<string>('foo', 'bar') // 類型：string

如果你確定該值將始終被提供，則還可以強制轉換該值：

const foo = inject('foo') as string

#為 dom 模板引用標注類型

模板 ref 需要通過一個顯式指定的泛型參數和一個初始值 null 來創建：

<script setup lang="ts">
import { ref, onMounted } from 'vue'
const el = ref<HTMLInputElement | null>(null)
onMounted(() => {
  el.value?.focus()
})
</script>
<template>
  <input ref="el" />
</template>

注意為了嚴格的類型安全，有必要在訪問 el.value 時使用可選鏈或類型守衛。這是因為直到組件被掛載前，這個 ref 的值都是初始的 null，并且 v-if 將引用的元素卸載時也會被設置為 null。

#為組件模板引用標注類型

有時，我們需要為一個子組件添加一個模板 ref，以便調用它公開的方法。比如，我們有一個 MyModal 子組件，它有一個打開模態框的方法：

<!-- MyModal.vue -->
<script setup lang="ts">
import { ref } from 'vue'
const isContentShown = ref(false)
const open = () => (isContentShown.value = true)
defineExpose({
  open
})
</script>

為了獲取 MyModal 的類型，我們首先需要通過 typeof 得到其類型，再使用 TypeScript 內置的 InstanceType 工具類型來獲取其實例類型：

<!-- App.vue -->
<script setup lang="ts">
import MyModal from './MyModal.vue'
const modal = ref<InstanceType<typeof MyModal> | null>(null)
const openModal = () => {
  modal.value?.open()
}
</script>

總結

到此這篇關于vue3組件TS類型聲明的文章就介紹到這了,更多相關vue3組件TS類型聲明內容請搜索技圈網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持技圈網！

【文章出處:香港多ip站群服務器 http://www.558idc.com/hkzq.html提供，感恩】