All skills
vuejs-ai avatar

/vue-best-practices

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

MUST be used for Vue.js tasks. Strongly recommends Composition API with `<script setup>` and TypeScript as the standard approach. Covers Vue 3, SSR, Volar, vue-tsc. Load for any Vue, .vue files, Vue Router, Pinia, or Vite with Vue work. ALWAYS use Composition API unless the project explicitly requires Options API.

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

This session only. Nothing lands on disk.

referencesupdated-hook-performance.md

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

Avoid Expensive Operations in Updated Hook

Impact: MEDIUM - The updated hook runs after every reactive state change that causes a re-render. Placing expensive operations, API calls, or state mutations here can cause severe performance degradation, infinite loops, and dropped frames below the optimal 60fps threshold.

Use updated/onUpdated sparingly for post-DOM-update operations that cannot be handled by watchers or computed properties. For most reactive data handling, prefer watchers (watch/watchEffect) which provide more control over what triggers the callback.

Task List

  • Never perform API calls in updated hook
  • Never mutate reactive state inside updated (causes infinite loops)
  • Use conditional checks to verify updates are relevant before acting
  • Prefer watch or watchEffect for reacting to specific data changes
  • Use throttling/debouncing if updated operations are expensive
  • Reserve updated for low-level DOM synchronization tasks

BAD:

// BAD: API call in updated - fires on every re-render
export default {
  data() {
    return { items: [], lastUpdate: null }
  },
  updated() {
    // This runs after every single state change!
    fetch('/api/sync', {
      method: 'POST',
      body: JSON.stringify(this.items)
    })
  }
}
// BAD: State mutation in updated - infinite loop
export default {
  data() {
    return { renderCount: 0 }
  },
  updated() {
    // This causes another update, which triggers updated again!
    this.renderCount++ // Infinite loop
  }
}
// BAD: Heavy computation on every update
export default {
  updated() {
    // Expensive operation runs on every keystroke, every state change
    this.processedData = this.heavyComputation(this.rawData)
    this.analytics = this.calculateMetrics(this.allData)
  }
}

GOOD:

import debounce from 'lodash-es/debounce'

// GOOD: Use watcher for specific data changes
export default {
  data() {
    return { items: [] }
  },
  watch: {
    // Only fires when items actually changes
    items: {
      handler(newItems) {
        this.syncToServer(newItems)
      },
      deep: true
    }
  },
  methods: {
    syncToServer: debounce(function(items) {
      fetch('/api/sync', {
        method: 'POST',
        body: JSON.stringify(items)
      })
    }, 500)
  }
}
<!-- GOOD: Composition API with targeted watchers -->
<script setup>
import { ref, watch, onUpdated } from 'vue'
import { useDebounceFn } from '@vueuse/core'

const items = ref([])
const scrollContainer = ref(null)

// Watch specific data - not all updates
watch(items, (newItems) => {
  syncToServer(newItems)
}, { deep: true })

const syncToServer = useDebounceFn((items) => {
  fetch('/api/sync', { method: 'POST', body: JSON.stringify(items) })
}, 500)

// Only use onUpdated for DOM synchronization
onUpdated(() => {
  // Scroll to bottom only if content changed height
  if (scrollContainer.value) {
    scrollContainer.value.scrollTop = scrollContainer.value.scrollHeight
  }
})
</script>
// GOOD: Conditional check in updated hook
export default {
  data() {
    return {
      content: '',
      lastSyncedContent: ''
    }
  },
  updated() {
    // Only act if specific condition is met
    if (this.content !== this.lastSyncedContent) {
      this.syncContent()
      this.lastSyncedContent = this.content
    }
  },
  methods: {
    syncContent: debounce(function() {
      // Sync logic
    }, 300)
  }
}

Valid Use Cases for Updated Hook

// GOOD: Low-level DOM synchronization
export default {
  updated() {
    // Sync third-party library with Vue's DOM
    this.thirdPartyWidget.refresh()

    // Update scroll position after content change
    this.$nextTick(() => {
      this.maintainScrollPosition()
    })
  }
}

Prefer Computed Properties for Derived Data

// BAD: Calculating derived data in updated
export default {
  data() {
    return { numbers: [1, 2, 3, 4, 5] }
  },
  updated() {
    this.sum = this.numbers.reduce((a, b) => a + b, 0) // Causes another update!
  }
}

// GOOD: Use computed property instead
export default {
  data() {
    return { numbers: [1, 2, 3, 4, 5] }
  },
  computed: {
    sum() {
      return this.numbers.reduce((a, b) => a + b, 0)
    }
  }
}

Source: SKILL.md on GitHub

No alerts16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    This skill provides a comprehensive set of best practices for Vue.js development, focusing on the Composition API, reactivity, and performance optimization. It includes standard coding guidelines and explicitly recommends security best practices such as sanitizing untrusted content to prevent XSS.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer7mo

    23 files scanned · No issues

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at b9d14d0. 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
metadata
{
  "author": "github.com/vuejs-ai",
  "version": "18.0.0"
}
  • Vue
  • TypeScript
  • composition-api
  • script-setup
  • vue-router
  • pinia
  • vite
  • ssr
  • volar
  • component-design

README badge

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

Instructs Claude to follow Vue 3 best practices using Composition API with `<script setup>` and TypeScript, covering reactivity, component splitting, data flow, and composables. Load this skill for any Vue work—it enforces a workflow that prioritizes minimal state, explicit props/events, focused components, and defers optional features until requirements demand them.

Generated from the current SKILL.md.

Should I use Options API or Composition API?
Use Composition API with <script setup> and TypeScript as the default. Only switch to Options API if the project explicitly requires it.
Does this skill cover Vue 2?
No. This skill targets Vue 3, Composition API, <script setup>, and TypeScript.
When should I split a component into smaller components?
Split when a component has more than one clear responsibility, contains 3+ distinct UI sections, or has repeated template blocks. Keep entry/root and route view components thin unless the feature is a small throwaway demo.
What references should I read before starting a Vue task?
You must read and keep active: reactivity.md, sfc.md, component-data-flow.md, and composables.md. Load additional optional references only when requirements call for slots, animations, state management, or other specific features.
When should I add state management like Pinia?
Only when app-wide shared state crosses feature boundaries. For most features, use composables and props/events for data flow instead.

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