Sem descrição

Kia Ishii 9a7982961b refactor: withdraw double install check há 5 anos atrás
.circleci 6416ebb1e7 feat!: add vue 3 support há 5 anos atrás
.github 24f9db5910 Add issue template (#693) há 8 anos atrás
build 71776ba683 chore: allow specifying release tag há 5 anos atrás
dist 2598b228af [build] 4.0.0-alpha.1 há 5 anos atrás
docs 4d7f3908df docs: make obvious where the store come from (#1687) há 5 anos atrás
docs-gitbook 91aa727d42 docs: Update link to flux in README (#1582) há 5 anos atrás
examples 35ca70a01b chore: fix composition counter example há 5 anos atrás
src 9a7982961b refactor: withdraw double install check há 5 anos atrás
test 8e12a6348f test: fix all pending tests há 5 anos atrás
types 9a9672050b fix(types): avoid broadening vue instance type when using map helpers (#1639) há 5 anos atrás
.babelrc 22fbb5bc6a update eslint config and deps há 8 anos atrás
.eslintrc 9b476358a0 update eslint config há 8 anos atrás
.gitignore 2a91153bfe [docs] using vuepress (#1277) há 7 anos atrás
LICENSE f053ae7e98 Avoid updating license every year (#1108) há 7 anos atrás
README.md 4799e819db chore: update the todo status há 5 anos atrás
package.json 98378c7073 build: update vue to 3.0.0-alpha.13 há 5 anos atrás
yarn.lock 98378c7073 build: update vue to 3.0.0-alpha.13 há 5 anos atrás

README.md

Vuex 4

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.

Status: Alpha

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.

Breaking changes

Installation process has changed

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 use createStore 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(App)

app.use(store)

app.mount('#app')

Known issues

  • The code is kept as close to Vuex 3 code base as possible, and there're plenty of places where we should refactor. However, we are waiting for all of the test cases to pass before doing so (some tests require Vue 3 update).
  • TypeScript support is not ready yet. Please use JS environment to test this for now.

TODOs as of 4.0.0-alpha.1

  • Add TypeScript support
  • ~Make all unit test working~
  • Refactor the codebase
  • Update the build system to align with Vue 3
  • Update docs