vue3获取ref实例结合ts的InstanceType问题怎么解决

梦涛大大_7962

梦涛大大_7962

2023-05-20

2432人浏览

转载

    vue3获取ref实例结合ts的InstanceType

    有时候我们模板引用,但是在使用的时候,ts提示却不行,没有提示组件通过defineexpose暴露的方法名称,虽然这不是很影响,但是可以解决还是可以解决下~

    <!-- MyModal.vue -->
    <script>
    import { ref } from 'vue'
    
    const sayHello = () => (console.log('我会说hello'))
    
    defineExpose({
      sayHello
    })
    </script>

    然后我们在父级使用,输入完成MyModalRef.value会发现没有sayHello这个函数提示,所以这个时候我们就需要使用InstanceType 工具类型来获取其实例类型

    <!-- App.vue -->
    <script>
    import MyModal from './MyModal.vue'
    const MyModalRef = ref()
    
    const handleOperation = () => {
      MyModalRef.value.sayHello
    }
    </script>

    vue3获取ref实例结合ts的InstanceType问题怎么解决

    使用InstanceType 工具类型获取其实例类型:

    <!-- MyModal.vue -->
    <script>
    import { ref } from 'vue'
    
    const sayHello = () => (console.log('我会说hello'))
    
    defineExpose({
      open
    })
    </script>

    父级使用

    <!-- App.vue -->
    <script>
    import MyModal from './MyModal.vue'
    
    const MyModalRef = ref<InstanceType<typeof MyModal> | null>(null)
    
    const handleOperation = () => {
      MyModalRef.value?.sayHello()
    }
    </script>

    貌似依旧没有提示使用InstanceType在提示的时候,然后输入错误内容也没有在编译前进行报错…,不过vue官方这样子说了,那就听他的吧(其实我一般不用,不过也学到了)

    @vue官方API为组件模板引用标注类型

    如何为vue3组件标注TS类型

    Vue3和TS绝对是在今年最受欢迎的前端技术之列。许多公司正在使用 Vue3 + TS + Vite 组合来开发新项目。以下是重写后的句子:分享在Vue3组件中如何使用Composition-Api结合TS类型。

    为 props 标注类型

    使用 <script setup></script>

    当使用 <script setup> &#26102;&#65292;defineProps() &#23439;&#20989;&#25968;&#25903;&#25345;&#20174;&#23427;&#30340;&#21442;&#25968;&#20013;&#25512;&#21040;&#31867;&#22411;&#65306;</script>

    <script>
    const props = defineProps({
      foo: { type: String, required: true },
      bar: Number
    })
     
    props.foo // string
    props.bar // number / undefined
    </script>

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

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

    <script>
    const props = defineProps<{
      foo: string
      bar?: number
    }>()
    </script>
     
    /* or
    <sctipt>
    interface Props {
      foo: string
      bar?: number
    }
    const props = defineProps<props>()
    
    */</props></sctipt>

    编译器会尝试推导类型参数并生成相应的运行时选项,这种方法被称为基于类型的声明。这种方法的缺点在于无法定义props默认值的能力已经丧失。使用 withDefaults 编译器可以解决这个问题

    interface Props {
      msg?: string
      labels?: string[]
    }
     
    const props = withDefaults(defineProps<props>(), {
      msg: 'hello',
      label: () => ['one', 'two']
    })</props>

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

    非 <script setup></script>

    如果没有使用 <script setup>&#65292;&#37027;&#20040;&#20026;&#20102;&#24320;&#21551; props &#30340;&#31867;&#22411;&#25512;&#23548;&#65292;&#24517;&#39035;&#20351;&#29992; defineComponent() &#12290;props &#23545;&#35937;&#30340;&#31867;&#22411;&#26159;&#30001; props &#36873;&#39033;&#25512;&#26029;&#32780;&#26469;&#65292;&#29992;&#20110;&#20256;&#36882;&#21040; setup() &#20989;&#25968;&#12290;</script>

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

    为 emits 标注类型

    使用 <script setup></script>

    在 <script setup> &#20013;&#65292;emit &#20989;&#25968;&#30340;&#31867;&#22411;&#26631;&#27880;&#20063;&#21487;&#20197;&#20351;&#29992; &#36816;&#34892;&#26102;&#22768;&#26126; &#25110;&#32773; &#22522;&#20110;&#31867;&#22411;&#30340;&#22768;&#26126; &#65306;</script>

    <script>
    // 运行时
    const emit = defineEmits(['change', 'update'])
     
    //基于类型
    const emit = defineEmits<{
      (e: 'change', id: number): void
      (e: 'update', value: string): void
    }>()
    </script>

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

    非<script setup></script>

    若没有使用 <script setup>&#65292;defineComponent() &#20063;&#21487;&#20197;&#26681;&#25454; emits &#36873;&#39033;&#25512;&#23548;&#26292;&#38706;&#22312; setup &#19978;&#19979;&#25991;&#20013;&#30340; emit &#20989;&#25968;&#30340;&#31867;&#22411;&#65306;</script>

    import { defineComponent } from 'vue'
     
    export default definComponent({
      emits: ['change'],
      setup(props, { emit }) {
        emit('change') //类型检查 / 自动补全
      }
    })

    为 ref() 标注类型

    默认推导类型

    ref 会根据初始化时的值自动推导其类型:

    import { ref } from 'vue'
     
    // 推导出的类型:Ref<number>
     
    const year = ref(2022)
     
    // TS Error: Type 'string' is not assignable to type 'number'.
    year.value = '2022'</number>

    通过接口指定类型

    有时我们可能想为 ref 内的值指定一个更复杂的类型,可以通过使用 Ref 这个接口:

    Element Plus UI Vue3
    Element Plus UI Vue3

    Element Plus Vue3 桌面组件库。在开发 Vue 3.x 页面时调用,使用 Element Plus 组件(如 el-button、el-input、el-form、el-table 等)。

    下载
    import { ref } from 'vue'
    import type { Ref } from 'vue'
     
    const year: Ref<string> = ref(2022)
    year.value = 2022 //成功</string>

    通过泛型指定类型

    或者,在调用 ref() 时传入一个泛型参数,来覆盖默认的推导行为:

    // 得到的类型:Ref<string>
    const year = ref<string>('2022')
    year.value = 2022 //成功</string></string>

    如果你指定了一个泛型参数但没有给出初始值,那么最后得到的就将是一个包含 undefined 的联合类型:

    // 推导得到的类型:Ref<number>
    const n = ref<number>()</number></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('')</number>

    通过泛型指定类型

    const double = component<number>(() => {
      // 若返回值不是 number 类型则会报错
    })</number>

    为事件处理函数标注类型

    在处理原生 DOM事件时,应该给事件处理函数的参数正确地标注类型,如:

    <script>
    function handleChange(event) {
      // `event` 隐式地标注为 `any`类型
      console.log(event.target.value)
    }
    </script>
     
    <template>
      <input></template>

    当没有类型标注时,这个event参数将自动被识别为任意类型。这也会在 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 { Injectiokey } from 'vue'
     
    const key = Symbol() as Injectionkey<string>
    provide(key,'foo') // 若提供的是非字符串值会导致错误
     
    const foo = inject(key) // foo 的类型: string | undefined</string>

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

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

    const foo = inject<string>('key') // 类型:string | undefined</string>

    由于提供者在运行时可能没有提供这个值,因此请注意注入的值可能仍然是未定义的。移除 undefined 类型的方法是提供一个默认值

    const foo = inject<string>('foo', 'bar') // 类型:string</string>

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

    const foo = inject('foo') as string

    为 dom 模板引用标注类型

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

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

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

    为组件模板引用标注类型

    有时候,我们需要为一个子组件添加一个模板引用(template reference),以便可以调用它公开的方法。举个例子,我们有一个 MyModal 子组件,其中包含一个用于打开模态框的方法:

    <script>
    import { ref } from 'vue'
     
    const isContentShown = ref(false)
    const open = () => (isContentShow.value = true)
     
    defineExpose({
      open
    })
    </script>

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

    <script>
    import MyModal from './MyModal.vue'
     
    const modal = ref<InstanceType<typeof MyModal > | null>(null)
    const openModal = () => {
      modal.value?.open()
    }
    </script>

    前端入门到VUE实战笔记:立即使用
    在学习笔记中,你将探索 前端 的入门与实战技巧!

    相关文章

    PHP速学视频免费教程(入门到精通)
    PHP速学视频免费教程(入门到精通)

    PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

    下载

    相关标签:

    vue3

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

    相关专题

    更多
    Navicat创建数据库教程
    Navicat创建数据库教程

    本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。

    2026.11.20

    0

    7

    Navicat入门教程大全
    Navicat入门教程大全

    本专题整理Navicat入门教程,从认识软件界面到开展数据库操作,介绍初次使用需要了解的知识和方法。内容兼顾连接配置、数据管理及日常使用中的疑问,方便用户按学习进度查阅,为后续实践和独立操作打好基础。

    2026.11.20

    0

    17

    Navicat数据库连接配置指南
    Navicat数据库连接配置指南

    从确认数据库信息到建立可用连接,本专题串联Navicat连接数据库的相关知识和操作方法。既有初次配置时需要了解的基础内容,也有连接后的检查思路,方便用户按实际需求查阅教程,逐步熟悉数据库连接的设置流程。

    2026.11.20

    0

    10

    PHP8.6数组与数据处理教程
    PHP8.6数组与数据处理教程

    本专题汇总PHP8.6数组与数据处理教程,涵盖CSV读取和导出、引用遍历删除、array_filter回调模式、配置键名冲突、pathinfo文件名校验、GMP大整数进制转换及UTF-8正则筛选,说明升级兼容变化、输入范围和失败处理方法。

    2026.11.20

    0

    8

    PHP8.6升级迁移教程
    PHP8.6升级迁移教程

    本专题汇总PHP8.6升级迁移与弃用接口改造教程,涵盖反射调用、对象属性赋值、标识符更名、构造函数与__debugInfo调整,以及插件类名检查、常量导出、ArrayIterator排序、SPL和DTO查询参数转换,帮助梳理弃用提示并完成代码兼容改造。

    2026.11.20

    0

    10

    PHP8.6安装配置与FPM运维教程
    PHP8.6安装配置与FPM运维教程

    本专题汇总PHP8.6正式版安装部署与FPM运维教程,涵盖Linux并存安装、独立ini配置、扩展重新编译、Nginx切换与回滚、FPM状态监控和慢日志排查,以及环境变量、请求超时、OPcache刷新和预加载配置。

    2026.11.20

    0

    10

    Nginx CVE-2026-123007排查与防护指南
    Nginx CVE-2026-123007排查与防护指南

    Nginx HTTP/2漏洞该怎么修复?本专题围绕CVE-2026-123007,介绍安全版本升级、模块兼容检查和配置恢复方法,以及日志排查、权限设置等后续加固操作,方便你按实际部署情况查找对应教程。

    2026.11.20

    20

    8

    GoFrame框架Web开发与路由中间件
    GoFrame框架Web开发与路由中间件

    本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

    2026.11.17

    60

    15

    GoFrame框架安装与gf命令行工具
    GoFrame框架安装与gf命令行工具

    本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

    2026.11.17

    80

    15

    热门下载

    更多
    网站特效
    /
    网站源码
    /
    网站素材
    /
    前端模板

    精品课程

    更多
    相关推荐
    /
    热门推荐
    /
    最新课程
    Vue3.x 工具篇--十天技能课堂
    Vue3.x 工具篇--十天技能课堂

    共26课时 | 2.6万人学习

    Vue3.x 核心篇--十天技能课堂
    Vue3.x 核心篇--十天技能课堂

    共30课时 | 2.5万人学习

    Vue3.x新特性篇--十天基础课堂
    Vue3.x新特性篇--十天基础课堂

    共20课时 | 1.8万人学习