All skills
vuejs-ai avatar

/vue-options-api-best-practices

@bc922e4 official
by Vue AIvuejs-ai/skills2.9k stars
167

Vue 3 Options API style (data(), methods, this context). Each reference shows Options API solution only.

Use this Skill: https://skilld.dev/gh/vuejs-ai/skills/vue-options-api-best-practices

This session only. Nothing lands on disk.

referenceno-arrow-functions-in-lifecycle-hooks.md

≈730 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Never Use Arrow Functions for Options API Lifecycle Hooks

Impact: HIGH - Using arrow functions for lifecycle hooks in the Options API prevents Vue from binding this to the component instance. This causes this to be undefined or reference the wrong context, leading to runtime errors when accessing component data, methods, or other properties.

Arrow functions lexically bind this from their enclosing scope. Vue's Options API lifecycle hooks (created, mounted, updated, unmounted, etc.) require regular functions so Vue can set this to the component instance at runtime.

Task Checklist

  • Always use regular function syntax for Options API lifecycle hooks
  • Use ES6 method shorthand (preferred) for cleaner code
  • Arrow functions ARE allowed inside lifecycle hooks for callbacks

Incorrect:

export default {
  data() {
    return { message: 'Hello' }
  },
  // WRONG: Arrow function - `this` will be undefined
  created: () => {
    console.log(this.message) // Error: Cannot read property 'message' of undefined
  },
  // WRONG: Arrow function for mounted
  mounted: () => {
    this.initializePlugin() // Error: this.initializePlugin is not a function
  },
  // WRONG: Arrow function for beforeUnmount
  beforeUnmount: () => {
    this.cleanup() // Will fail!
  },
  methods: {
    initializePlugin() { /* ... */ },
    cleanup() { /* ... */ }
  }
}

Correct:

export default {
  data() {
    return { message: 'Hello' }
  },
  // CORRECT: ES6 method shorthand (preferred)
  created() {
    console.log(this.message) // Works! this refers to component instance
  },
  // CORRECT: Regular function expression
  mounted: function() {
    this.initializePlugin() // Works!
  },
  // CORRECT: Method shorthand
  beforeUnmount() {
    this.cleanup() // Works!
  },
  methods: {
    initializePlugin() {
      // Arrow functions ARE fine for callbacks inside lifecycle hooks
      this.$nextTick(() => {
        this.isReady = true // Arrow inherits `this` from mounted
      })
    },
    cleanup() { /* ... */ }
  }
}

All Affected Lifecycle Hooks

The following Options API hooks must NOT use arrow functions:

  • beforeCreate
  • created
  • beforeMount
  • mounted
  • beforeUpdate
  • updated
  • beforeUnmount (Vue 3) / beforeDestroy (Vue 2)
  • unmounted (Vue 3) / destroyed (Vue 2)
  • activated
  • deactivated
  • errorCaptured
  • renderTracked
  • renderTriggered

Reference

Source: SKILL.md on GitHub

No alerts17d5 checks · Risk SAFE
  • Gen Agent Trust Hub17d

    The skill provides comprehensive best practices and TypeScript integration guidelines for the Vue.js Options API. It contains educational content and code examples that are safe and consistent with official Vue.js documentation. No security issues were detected.

  • Socket17d

    No alerts

  • Snyk17d

    Risk: LOW · No issues

  • Runlayer7mo

    11 files scanned · No issues

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at bc922e4. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 months ago.

Steadyupdated 8 months ago
version
2.0.0
author
github.com/vuejs-ai
  • Vue
  • TypeScript
  • options-api
  • lifecycle-hooks
  • type-safety
  • prop-validation
  • computed-properties

README badge

README badge for vuejs-ai/skills/vue-options-api-best-practices

Teaches Vue 3 Options API patterns including TypeScript integration, method binding, and lifecycle hook best practices. Covers type inference for props, event handlers, computed properties, and the this-context gotchas specific to Options API syntax.

Generated from the current SKILL.md.

Does this skill cover Vue 3 Composition API?
No. This skill focuses exclusively on Vue 3 Options API (data(), methods, this context). Composition API patterns are not included.
How does this skill handle TypeScript with Options API?
The skill includes dedicated references for TypeScript integration, such as using defineComponent for type inference, strict mode for this context, and typing complex props, event handlers, computed properties, and provide/inject.
What common mistakes does this skill address?
It covers arrow functions in methods and lifecycle hooks (which break this binding), stateful methods leaking state across component instances, and missing type safety for injected properties.
Can I use this skill if I'm migrating from older Vue versions?
The skill addresses TypeScript compatibility with older versions in the context of prop validators and Options API patterns, but is designed for Vue 3.

Generated from the current SKILL.md. These answers refresh after source changes.