Nuxt3-class-component NPM

nuxt3-class-component

A successor to nuxt-property-decorator for Nuxt 3, based on vue-facing-decorator.

Unlike the original nuxt-property-decorator, this package is implemented as a Nuxt module. This is because it uses defineNuxtComponent internally, which doesn't work outside of Nuxt compilation context.

Quick Setup

Install:

npm install nuxt3-class-component vue-facing-decorator

Add nuxt3-class-component to the modules section of nuxt.config.ts:

export default defineNuxtConfig({
  modules: ["nuxt3-class-component"],
})

Drop-in replacement for `nuxt-property-decorator`

Your previous Nuxt2 components will work automagically:

<script lang="ts">
// This pseudo-package is provided by nuxt3-class-component module
import { Component, Vue } from "nuxt-property-decorator"

@Component({
  async asyncData() {
    return { value: 42 }
  },
})
export default class App extends Vue {
  value!: number
}
</script>

<template>
  <div>value = {{ value }}</div>
</template>

New syntax

It is advised to use the auto-imported NuxtComponent and the underlying vue-facing-decorator instead:

<script lang="ts">
import { Vue } from "vue-facing-decorator"

@NuxtComponent({
  async asyncData() {
    return { value: 42 }
  },
})
export default class App extends Vue {
  value!: number
}
</script>

<template>
  <div>value = {{ value }}</div>
</template>