# vue2-helpers

**Repository Path**: ambit/vue2-helpers

## Basic Information

- **Project Name**: vue2-helpers
- **Description**: 🔧 为 Vue2 提供 useRoute、useStore 等 composition 辅助工具
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: for-vue-2.7
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-07-23
- **Last Updated**: 2024-10-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: vue-router, vue3, Vuex, composition, usestate

## 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
```javascript
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`&lt;<br>&nbsp;&nbsp;&nbsp;&nbsp;RootState, RootGetters, RootMutations, RootActions<br>&gt;(): {<br>&nbsp;&nbsp;&nbsp;&nbsp;`useState`, `useGetters`, `useMutations`, `useActions`<br>}|The helper methods in return value are<br>used to replace `mapState`, `mapGetters`,<br>`mapMutations`, `mapActions`|

### vue2-helpers/vuex
|Features|Description|
|-|-|
|`createStore`&lt;S&gt;(options: StoreOptions&lt;S&gt;): Store&lt;S&gt;||
|`useStore`&lt;S = any&gt;(): Store&lt;S&gt;|

### 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: cai_fanwei
1. QQ Group: 663286147
1. E-mail: ambit_tsai@qq.com