iis服务器助手广告广告
返回顶部
首页 > 资讯 > 前端开发 > 其他 >vue3获取ref实例结合ts的InstanceType问题怎么解决
  • 539
分享到

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

Vue3tsref 2023-05-21 05:05:57 539人浏览 八月长安
摘要

vue3获取ref实例结合ts的InstanceType有时候我们模板引用,但是在使用的时候,ts提示却不行,没有提示组件通过defineExpose暴露的方法名称,虽然这不是很影响,但是可以解决还是可以解决下~<!-- MyModa

    vue3获取ref实例结合ts的InstanceType

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

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

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

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

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

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

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

    父级使用

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

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

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

    如何为vue3组件标注TS类型

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

    为 props 标注类型

    使用 <script setup>

    当使用 <script setup> 时,defineProps() 宏函数支持从它的参数中推到类型:

    <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默认值的能力已经丧失。使用 withDefaults 编译器可以解决这个问题

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

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

    非 <script setup>

    如果没有使用 <script setup>,那么为了开启 props 的类型推导,必须使用 defineComponent() 。props 对象的类型是由 props 选项推断而来,用于传递到 setup() 函数。

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

    为 emits 标注类型

    使用 <script setup>

    在 <script setup> 中,emit 函数的类型标注也可以使用 运行时声明 或者 基于类型的声明 :

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

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

    非<script setup>

    若没有使用 <script setup>,defineComponent() 也可以根据 emits 选项推导暴露在 setup 上下文中的 emit 函数的类型:

    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'

    通过接口指定类型

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

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

    通过泛型指定类型

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

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

    如果你指定了一个泛型参数但没有给出初始值,那么最后得到的就将是一个包含 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 = component<number>(() => {
      // 若返回值不是 number 类型则会报错
    })

    为事件处理函数标注类型

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

    <script srtup lang="ts">
    function handleChange(event) {
      // `event` 隐式地标注为 `any`类型
      console.log(event.target.value)
    }
    </script>
     
    <template>
      <input type="text" @change="handleChange" />
    </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

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

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

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

    由于提供者在运行时可能没有提供这个值,因此请注意注入的值可能仍然是未定义的。移除 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。

    为组件模板引用标注类型

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

    <script setup lang="ts">
    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>

    以上就是vue3获取ref实例结合ts的InstanceType问题怎么解决的详细内容,更多请关注编程网其它相关文章!

    --结束END--

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

    本文链接: https://www.lsjlt.com/news/214966.html(转载时请注明来源链接)

    有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

    本篇文章演示代码以及资料文档资料下载

    下载Word文档到电脑,方便收藏和打印~

    下载Word文档
    猜你喜欢
    • vue3获取ref实例结合ts的InstanceType问题
      目录vue3获取ref实例结合ts的InstanceType如何为vue3组件标注TS类型为 props 标注类型非 <script setup>为 emits 标注类型...
      99+
      2023-03-06
      vue3获取ref实例 ref ts InstanceType vue3 ts
    • vue3获取ref实例结合ts的InstanceType问题怎么解决
      vue3获取ref实例结合ts的InstanceType有时候我们模板引用,但是在使用的时候,ts提示却不行,没有提示组件通过defineExpose暴露的方法名称,虽然这不是很影响,但是可以解决还是可以解决下~<!-- MyModa...
      99+
      2023-05-21
      Vue3 ts ref
    • VUE3+TS获取组件类型遇到的坑怎么解决
      VUE3+TS获取组件类型的方法踩坑获取组件类型的方法const AccountRef = ref<InstanceType<typeof LoginAccount>>()遇到的坑typeof LoginAccoun...
      99+
      2023-05-14
      Vue3 ts
    • vue3使用ref的性能警告问题怎么解决
      markRaw: 标记一个对象,使其永远不会转换为 proxy。返回对象本身。shallowRef: 创建一个跟踪自身 .value 变化的 ref,但不会使其值也变成响应式的。解决我通过将对象标记为shallowRef解决了这个问题因此,...
      99+
      2023-05-14
      Vue3 ref
    • vue中this.$refs有值,但无法获取ref的值问题及解决
      目录vue中this.$refs有值,但无法获取ref的值解决方法ant-design-vue中this.$refs使用笔记总结vue中this.$refs有值,但无法获取ref的值...
      99+
      2023-01-28
      vue this.$refs vue无法获取ref的值 vue获取ref的值
    • vue中ref的使用问题怎么解决
      本文小编为大家详细介绍“vue中ref的使用问题怎么解决”,内容详细,步骤清晰,细节处理妥当,希望这篇“vue中ref的使用问题怎么解决”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。vue的ref(this.$r...
      99+
      2023-06-29
    • 怎么解决vuejs获取不到dom问题
      这篇文章主要介绍“怎么解决vuejs获取不到dom问题”,在日常操作中,相信很多人在怎么解决vuejs获取不到dom问题问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”怎么解决vuejs获取不到dom问题”的疑...
      99+
      2023-06-25
    • 获取ssl证书有问题怎么解决
      1、证书申请被拒绝:如果证书申请被拒绝,可以检查证书申请信息是否填写正确、证书颁发机构是否有特殊要求等,根据拒绝原因进行调整和修改。...
      99+
      2023-05-13
      获取ssl证书 ssl证书
    • 怎么解决Ajax获取页面被缓存的问题
      本篇内容主要讲解“怎么解决Ajax获取页面被缓存的问题”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“怎么解决Ajax获取页面被缓存的问题”吧! ...
      99+
      2024-04-02
    • C#中获取文件大小问题怎么解决
      本篇内容主要讲解“C#中获取文件大小问题怎么解决”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“C#中获取文件大小问题怎么解决”吧!C# 获取文件大小直接贴代码吧   ...
      99+
      2023-07-05
    • 微信小程序怎么解决获取流量的问题
      这篇文章主要介绍“微信小程序怎么解决获取流量的问题”,在日常操作中,相信很多人在微信小程序怎么解决获取流量的问题问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”微信小程序怎么解决获取流量的问题”的疑惑有所帮助!...
      99+
      2023-06-27
    • vue3结构赋值失去响应式引发的问题怎么解决
      这篇文章主要介绍“vue3结构赋值失去响应式引发的问题怎么解决”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“vue3结构赋值失去响应式引发的问题怎么解决”文章能帮助大家解决问题。原始值的响应式系统的...
      99+
      2023-07-02
    • BAT怎么获取时间有空格问题的解决方法
      小编给大家分享一下BAT怎么获取时间有空格问题的解决方法,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!最近在项目上需要把文件定时备份,用BAT文件来自动生成文件夹名,精确到秒:bat脚本时间设定如下:pushd ...
      99+
      2023-06-08
    • 怎么解决获取VirtualBox COM对象失败错误问题
      这篇文章主要介绍“怎么解决获取VirtualBox COM对象失败错误问题”,在日常操作中,相信很多人在怎么解决获取VirtualBox COM对象失败错误问题问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”怎...
      99+
      2023-06-22
    • vue获取v-for异步数据dom问题怎么解决
      这篇文章主要讲解了“vue获取v-for异步数据dom问题怎么解决”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“vue获取v-for异步数据dom问题怎么解决”吧!vue获取v-for异步数...
      99+
      2023-07-05
    • vue3使用socket.io的出现的问题怎么解决
      今天小编给大家分享一下vue3使用socket.io的出现的问题怎么解决的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。问题一...
      99+
      2023-07-05
    • 怎么解决Struts Hibernate的整合问题
      这篇文章主要介绍“怎么解决Struts Hibernate的整合问题”,在日常操作中,相信很多人在怎么解决Struts Hibernate的整合问题问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”怎么解决Str...
      99+
      2023-06-17
    • mybatis plus新增数据获取主键id的问题怎么解决
      这篇文章主要介绍了mybatis plus新增数据获取主键id的问题怎么解决的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇mybatis plus新增数据获取主键id的问题怎么解决文章都会有...
      99+
      2023-07-05
    • requests.gPython用requests.get获取网页内容为空的问题怎么解决
      requests.gPython用requests.get获取网页内容为空的问题怎么解决,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。下面先来看一个例子:import&nb...
      99+
      2023-06-26
    • vue3中使用swiper遇到的问题怎么解决
      这篇文章主要介绍了vue3中使用swiper遇到的问题怎么解决的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇vue3中使用swiper遇到的问题怎么解决文章都会有所收获,下面我们一起来看看吧。一、安装swipe...
      99+
      2023-07-06
    软考高级职称资格查询
    编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
    • 官方手机版

    • 微信公众号

    • 商务合作