This release contains an important fix (#1883) that relies on the effectScope
API from Vue core, which is only available in Vue 3.2+.
__VUE_PROD_DEVTOOLS__
defined (#1991) (#1992) (7151622)This is the official Vuex 4 release.
The focus for Vuex 4 is compatibility. Vuex 4 supports Vue 3, and it provides the exact same API as Vuex 3, so users can reuse their existing Vuex code with Vue 3.
There are a few breaking changes described in a later section, so please check them out.
You can find basic usage with both Option and Composition API in the example
directory.
It’s still released under next
tag in NPM package as same as Vue 3. We’re planning to remove next
tag once Vue 3 is ready to remove it.
There have been a lot of contribution to make Vuex 4 stable. Thank you all for your very much appreciated help. It wouldn’t have been possible without this wonderful Vue community!
To check out docs, visit next.vuex.vuejs.org.
To align with the new Vue 3 initialization process, the installation process of Vuex has changed.
To create a new store instance, users are now encouraged to use the newly introduced createStore
function.
import { createStore } from 'vuex'
export const store = createStore({
state() {
return {
count: 1
}
}
})
Whilst this is not technically a breaking change, you may still use the
new Store(...)
syntax, we recommend this approach to align with Vue 3 and Vue Router Next.
To install Vuex to a Vue instance, pass the store instance instead of Vuex.
import { createApp } from 'vue'
import { store } from './store'
import App from './App.vue'
const app = createApp(App)
app.use(store)
app.mount('#app')
The following bundles are generated to align with Vue 3 bundles:
vuex.global(.prod).js
<script src="...">
in the browser. Exposes the Vuex global.<script src="...">
..prod.js
files for production.vuex.esm-browser(.prod).js
<script type="module">
.vuex.esm-bundler.js
webpack
, rollup
and parcel
.process.env.NODE_ENV
guards (must be replaced by bundler).vuex.cjs.js
require()
.ComponentCustomProperties
Vuex 4 removes its global typings for this.$store
within Vue Component to solve issue #994. When used with TypeScript, you must declare your own module augmentation.
Place the following code in your project to allow this.$store
to be typed correctly:
// vuex-shim.d.ts
import { ComponentCustomProperties } from 'vue'
import { Store } from 'vuex'
declare module '@vue/runtime-core' {
// Declare your own store states.
interface State {
count: number
}
interface ComponentCustomProperties {
$store: Store<State>
}
}
createLogger
function is exported from the core moduleIn Vuex 3, createLogger
function was exported from vuex/dist/logger
but it’s now included in the core package. You should import the function directly from vuex
package.
import { createLogger } from 'vuex'
storeKey
(4ab2947)hasModule
when parent does not exists (#1850) (f76d72d)logger.d.ts
file to the package (#1789) (a477334)createLogger
function in core export (afa566d)The bundles are generated as below to align with Vue 3 bundles.
vuex.global(.prod).js
<script src="...">
in the browser. Exposes the Vuex global.<script src="...">
..prod.js
files for production.vuex.esm-browser(.prod).js
<script type="module">
.vuex.esm-bundler.js
webpack
, rollup
and parcel
.process.env.NODE_ENV
guards (must be replaced by bundler).vuex.cjs.js
require()
.ComponentCustomProperties
Vuex 4 removes its global typings for this.$store
within Vue Component due to solving issue #994. When using TypeScript, you must provide your own augment declaration.
Please place the following code in your project to have this.$store
working.
// vuex-shim.d.ts
declare module "@vue/runtime-core" {
// Declare your own store states.
interface State {
count: number
}
interface ComponentCustomProperties {
$store: Store<State>;
}
}
This is the Vue 3 compatible version of Vuex. The focus is compatibility, and it provides the exact same API as Vuex 3, so users can reuse their existing Vuex code for Vue 3.
All Vuex 3 feature works. There are a few breaking changes described in a later section, so please check them out. You can find basic usage with both option and composition API at example
folder.
Please note that it’s still unstable, and there might be bugs. Please provide us feedback if you find anything. You may use vue-next-webpack-preview to test out Vue 3 with Vuex 4.
To align with the new Vue 3 initialization process, the installation process of Vuex has changed as well.
You should use a new createStore
function to create a new store instance.
import { createStore } from 'vuex'
const store = createStore({
state () {
return {
count: 1
}
}
})
This is technically not a breaking change because you could still use
new Store(...)
syntax. However, to align with Vue 3 and also with Vue Router Next, we recommend users to usecreateStore
function instead.
Then to install Vuex to Vue app instance, pass the store instance instead of Vuex.
import { createApp } from 'vue'
import store from './store'
import App from './APP.vue'
const app = createApp(Counter)
app.use(store)
app.mount('#app')
devtools
to store options type (#1478) (38c11dc)prepend
option for subscribe
and subscribeAction
(#1358) (a39d076)createLogger
can optionally log actions (#987) (18be128)state
option (#1132) (d39791b)typings: It is no longer compatible with the old Vue typings
chore(package): bump typescript and vue core typings
chore: bump vue
Update package.json