When to use this skill
Use this skill whenever the user wants to:
- Install and set up Vuex in a Vue 2 project
- Manage application state with Vuex
- Use Vuex store in Vue components
- Understand Vuex core concepts (state, getters, mutations, actions)
- Use Vuex modules for large applications
- Handle Vuex plugins and devtools
- Understand Vuex API and methods
- Troubleshoot Vuex issues
How to use this skill
This skill is organized to match the Vuex official documentation structure (
https://vuex.vuejs.org/zh/,
https://vuex.vuejs.org/zh/guide/,
https://vuex.vuejs.org/zh/api/). When working with Vuex:
-
Identify the topic from the user's request:
- Installation/安装 →
examples/guide/installation.md
- Quick Start/快速开始 →
examples/guide/quick-start.md
- Core Concepts/核心概念 →
- Advanced/高级 →
- API/API 文档 →
-
Load the appropriate example file from the
directory:
Guide (使用指南):
- - Introduction to Vuex
examples/guide/installation.md
examples/guide/quick-start.md
examples/guide/what-is-vuex.md
Core Concepts (核心概念):
examples/core-concepts/state.md
examples/core-concepts/getters.md
examples/core-concepts/mutations.md
examples/core-concepts/actions.md
examples/core-concepts/modules.md
Advanced (高级):
examples/advanced/plugins.md
examples/advanced/strict-mode.md
examples/advanced/form-handling.md
examples/advanced/testing.md
examples/advanced/hot-reload.md
-
Follow the specific instructions in that example file for syntax, structure, and best practices
Important Notes:
- Vuex is for Vue 2.x
- Store is the central state management
- State is reactive
- Mutations are synchronous
- Actions are asynchronous
- Each example file includes key concepts, code examples, and key points
-
Reference API documentation in the
directory when needed:
- - Store API
- - State API
- - Getters API
- - Mutations API
- - Actions API
- - Modules API
- - Plugins API
-
Use templates from the
directory:
templates/installation.md
- - Store setup templates
templates/component-usage.md
1. Understanding Vuex
Vuex is a state management pattern and library for Vue.js applications. It serves as a centralized store for all the components in an application.
Key Concepts:
- Store: Centralized state container
- State: Application state (data)
- Getters: Computed properties for store
- Mutations: Synchronous state changes
- Actions: Asynchronous operations
- Modules: Store organization
2. Installation
Using npm:
Using yarn:
Using CDN:
html
<script src="https://unpkg.com/vuex@3"></script>
3. Basic Setup
javascript
// store/index.js
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)
const store = new Vuex.Store({
state: {
count: 0
},
mutations: {
increment(state) {
state.count++
}
}
})
export default store
javascript
// main.js
import Vue from 'vue'
import store from './store'
new Vue({
store,
render: h => h(App)
}).$mount('#app')
Doc mapping (one-to-one with official documentation)
Examples and Templates
This skill includes detailed examples organized to match the official documentation structure. All examples are in the
directory (see mapping above).
To use examples:
- Identify the topic from the user's request
- Load the appropriate example file from the mapping above
- Follow the instructions, syntax, and best practices in that file
- Adapt the code examples to your specific use case
To use templates:
- Reference templates in directory for common scaffolding
- Adapt templates to your specific needs and coding style
API Reference
Detailed API documentation is available in the
directory, organized to match the official Vuex API documentation structure (
https://vuex.vuejs.org/zh/api/):
Store API ()
- Store constructor options
- Store instance properties
- Store instance methods
State API ()
- State definition
- State access
- State reactivity
Getters API ()
- Getter definition
- Getter access
- Getter arguments
Mutations API ()
- Mutation definition
- Mutation commit
- Mutation payload
Actions API ()
- Action definition
- Action dispatch
- Action context
Modules API ()
- Module definition
- Module namespacing
- Module registration
Plugins API ()
- Plugin definition
- Plugin usage
- Built-in plugins
To use API reference:
- Identify the API you need help with
- Load the corresponding API file from the directory
- Find the API signature, parameters, return type, and examples
- Reference the linked example files for detailed usage patterns
- All API files include links to relevant example files in the directory
Best Practices
- Use mutations for synchronous changes: Mutations must be synchronous
- Use actions for async operations: Actions can contain async operations
- Keep state normalized: Avoid nested state structures
- Use modules for large apps: Organize store with modules
- Use getters for computed state: Derive state with getters
- Follow naming conventions: Use consistent naming patterns
- Use TypeScript: Leverage TypeScript for type safety
Resources
Keywords
Vuex, vuex, Vue 2, state management, 状态管理, store, state, getters, mutations, actions, modules, 存储, 状态, 获取器, 变更, 动作, 模块, Vuex store, Vuex state, Vuex getters, Vuex mutations, Vuex actions, Vuex modules, Vuex plugins, centralized state, reactive state, synchronous mutations, asynchronous actions