vue2-helpers
v2.1.1
Published
A util package to use Vue 2 with Composition API easily
Maintainers
Readme
Vue2 Helpers
A util package to use Vue 2 with Composition API easily.
NOTE:
- vue2-helpers@1 is for vue2.5 and 2.6
- vue2-helpers@2 is for vue2.7
⬇️ Install
npm i -S vue2-helpers📃 Usage
import { createVuexHelpers } from 'vue2-helpers';
import { useRouter } from 'vue2-helpers/vue-router';
const { useState } = createVuexHelpers<
RootState, RootGetters, RootMutations, RootActions
>();
// Get a reactive and mutable ref object "stateA"
const { stateA } = useState('module', ['stateA']);
const router = useRouter();
router.push('/login');✨ API
vue2-helpers
|Features|Description|
|-|-|
|createVuexHelpers< RootState, RootGetters, RootMutations, RootActions>(): { useState, useGetters, useMutations, useActions}|The helper methods in return value areused to replace mapState, mapGetters,mapMutations, mapActions|
vue2-helpers/vuex
|Features|Description|
|-|-|
|createStore<S>(options: StoreOptions<S>): Store<S>||
|useStore<S = any>(): Store<S>|
vue2-helpers/vue-router
|Features|Description|
|-|-|
|createRouter(options: RouterOptions): Router||
|onBeforeRouteLeave(leaveGuard: NavigationGuard): void||
|onBeforeRouteUpdate(updateGuard: NavigationGuard): void||
|useRoute(): RouteLocationNormalized||
|useRouter(): Router||
|router.isReady(): Promise<void>||
☎️ Contact
- WeChat: cai_fanwei
- QQ Group: 663286147
- E-mail: [email protected]
