defineProps

Stability: stable

Correct types of destructured props using $defineProps.

See also Vue issue, Reactivity Transform RFC.

Features	Supported
Vue 3	✅
Nuxt 3	✅
Vue 2	✅
TypeScript / Volar Plugin	✅

WARNING

Reactivity Transform is required. You should enable it first.

Basic Usage

<script setup lang="ts">
const { foo } = $defineProps<{
  foo: string[]
}>()

const fooRef = $$(foo)
</script>

Volar Configuration

// tsconfig.json
{
  "vueCompilerOptions": {
    "target": 3,
    "plugins": [
      "@vue-macros/volar/define-props",
      // ...more feature
    ],
  },
}

Contributors

Kevin Deng

Changelog

Last edited about 11 hours ago

View full history

4e2cca7-refactor: remove dev condition from exports