qixm-burnish / vue2-helpers

🔧 A util package to use Vue 2 with Composition API easily

Vue2 Helpers

A util package to use Vue 2 with Composition API easily.

⬇️ 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 are used 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

1. WeChat: ambit_tsai
2. QQ Group: 663286147
3. E-mail: [email protected]