templateRef

Stability: experimental ⚠️ Experimental feature, use at your risk

Automatically infer type for templateRef and useTemplateRef (vue3.5).

Features	Supported
Volar Plugin	✅

Basic Usage

App.vue

<script setup lang="ts">
import { templateRef } from '@vueuse/core'
import { Comp } from './Comp.ts'

const comp = templateRef('comp')
comp.value?.foo
</script>

<template>
  <Comp ref="comp" />
</template>

Comp.ts

import { defineComponent } from 'vue'

export const Comp = defineComponent({
  setup() {
    return { foo: 1 }
  },
})

Volar Configuration

// tsconfig.json
{
  "vueCompilerOptions": {
    "plugins": ["@vue-macros/volar"],
    "vueMacros": {
      "templateRef": {
        /**
         * @default ["templateRef", "useTemplateRef"]
         */
        "alias": ["templateRef"],
      },
    },
  },
}

Contributors

Kevin Deng

zhiyuanzmj

Changelog

Last edited 1 day ago

View full history

6f71ef8-feat(volar): add @vue-macros/volar plugin (#746)

3a873f6-ci: deduplicate push & pr release