@fesjs/plugin-vuex

介绍

集成vuex插件

增强vuex,导出所有的mutationsactionsgetter的事件类型,编辑器提示

约定模式,module和plugin定义放在sotres目录下,文件名包含plugin被解析为插件,无需额外配置,定义即可用。

└── src
    ├── pages
    │    └── index.vue
    └── stores 
    │    └── foo
    │    │    └── bar.js
    │    ├── counter.js
    │    ├── plugin-logger.js       
    │    ├── user.js
    └── app.js
1
2
3
4
5
6
7
8
9
10

提示

为了防止fesjsvuex的export冲突,fesjs不提供导出vuex的任何api。你可以直接使用vuex的api

import { useStore } from 'vuex';
1

启用方式

package.json 中引入依赖:

{
    "dependencies": {
        "@fesjs/fes": "^2.0.0",
        "@fesjs/plugin-vuex": "^2.0.0"
    }
}
1
2
3
4
5
6

配置

.fes.js 中配置:

export default {
    vuex: {
        strict: true // 开启严格模式
    }
}
1
2
3
4
5

场景使用

先定义在stores下定义user模块,包含嵌套模块

stores/user.js

export default {
    namespaced: true,
    state: () => ({
        name: 'aring',
        age: 20
    }),
    actions: {
        login() {
            return new Promise((reslove) => {
                setTimeout(() => {
                    console.log('login');
                    reslove('OK');
                }, 1000);
            });
        }
    },
    modules: {
        address: {
            state: () => ({
                province: '广东省',
                city: '深圳市',
                zone: '南山区'
            }),
            getters: {
                address(state) {
                    return state.province + state.city + state.zone;
                }
            }
        }
    }
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

stores/foo/bar.js

export default {
    namespaced: true,
    state: () => ({
        count: 0
    }),
    mutations: {
        increment(state) {
            state.count++;
        }
    },
    getters: {
        doubleCount(state) {
            return state.count * 2;
        }
    },
    actions: {
        asyncIncrement({ commit }) {
            setTimeout(() => {
                commit('increment');
            }, 2000);
        }
    }
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

提示

导出的mutationsactionsgetter的事件类型,将会按文件命名;

ACTION_TYPES.user.login指向user模块中actions的login方法

GETTER_TYPES.user.address指向user模块中嵌套的address getter

MUTATION_TYPES.fooBar.increment指向foo/bar模块中mutations的increment方法

在vue文件中使用store

<template>
    <div>
        <h4>Vuex</h4>
        <div><button :disabled="disabled" @click="login">async login</button></div>
        <div><button @click="fooBarIncrement">foo/bar:{{fooBarDoubleCount}}</button></div>
        <div>{{address}}</div>
    </div>
</template>
<config>
{
    "name": "store",
    "title": "vuex测试"
}
</config>
<script>
import { computed, ref } from 'vue';
import { useStore } from 'vuex';
import { MUTATION_TYPES, GETTER_TYPES, ACTION_TYPES } from '@fesjs/fes';

export default {
    setup() {
        const store = useStore();
        console.log('store==>', store);
        const disabled = ref(false);
        // 可以利用导出的事件类型,不再通过字符传入(store.getters['user/address'])
        return {
            address: computed(() => store.getters[GETTER_TYPES.user.address]),
            disabled,
            login: () => {
                disabled.value = true;
                store.dispatch(ACTION_TYPES.user.login).then((res) => {
                    window.alert(res);
                    disabled.value = false;
                });
            },
            fooBarIncrement: () => store.commit(MUTATION_TYPES.fooBar.increment), // foo/bar目录会解析成驼峰fooBar
            fooBarDoubleCount: computed(() => store.getters[GETTER_TYPES.fooBar.doubleCount])
        };
    }
};
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

提示

由于该插件注册在onAppCreated中,如果在onAppCreated及之前使用useStore时,获取不到vuex实例

fesjs导出了vuex实例store,如在app.js文件中

import { store, GETTER_TYPES } from '@fesjs/fes';
console.log(store.getters[GETTER_TYPES.user.address])
1
2

vuex插件

stores文件夹下的文件名包含plugin被解析为插件,vuex插件写法参考官方文档在新窗口打开

API

store

  • 类型 Object
  • vuex实例

MUTATION_TYPES

  • 类型 Object
  • mutation的所有事件类型

GETTER_TYPES

  • 类型 Object
  • getter的所有方法名

ACTION_TYPES

  • 类型 Object
  • action的所有事件类型