Nuxt•3w ago

Module author upgrading Kit versions

Hi, if I update my module's @nuxt/kit and @nuxt/schema version from 3.x.x to 4, will Nuxt 3 users still be able to use it? I assume as long as meta.compatibility.nuxt is like this it will still work?

meta: {
  compatibility: {
    nuxt: '>=3.0.0',
  },
},

meta: {
  compatibility: {
    nuxt: '>=3.0.0',
  },
},

thanks

2 Replies

kapa.ai•3w ago

Hi @Donald Biden. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave: ---------------------- If you update your module's @nuxt/kit and @nuxt/schema dependencies from 3.x.x to 4.x.x, Nuxt 3 users should still be able to use your module, provided that your module's meta.compatibility.nuxt is set to allow Nuxt 3 (e.g., nuxt: '>=3.0.0'). The Nuxt documentation states that Nuxt 3 will continue to receive maintenance updates and that modules can specify compatibility constraints using the compatibility.nuxt field. If a user tries to use your module with an incompatible Nuxt version, they will receive a warning, but as long as the version range includes Nuxt 3, it should work as expected Module Anatomy defineNuxtModule Examples. However, you should ensure that your module does not use any APIs or features that are exclusive to Nuxt 4, unless you guard them appropriately. The Nuxt Kit utilities (like defineNuxtModule) are designed to help maintain compatibility across versions, and the compatibility check will warn users if their Nuxt version does not meet your requirements defineNuxtModule Examples. Also, the Nuxt roadmap confirms that Nuxt 3 will remain in maintenance mode and receive updates until at least January 2026, so supporting both Nuxt 3 and 4 in your module is a valid approach Release Cycle. Summary:
Yes, Nuxt 3 users will still be able to use your module if you update to @nuxt/kit and @nuxt/schema v4, as long as your meta.compatibility.nuxt includes Nuxt 3 (e.g., '>=3.0.0') and you avoid using Nuxt 4-only APIs without proper guards. ---------------------- Note: you can ask me a follow up question by @ mentioning me again :speech_balloon: ----------------------

kapa.ai•3w ago

<@1214688654199496797> Kapa.ai is still learning and improving, please let me know how I did by reacting below.

Gaming

Programming

Module author upgrading Kit versions

Did you find this page helpful?