This is vue-router-2-state which works only with Vue 2.0.

• For Vue Router 4 (for Vue 3) see vuejs/router.

---

Getting Started

Install using

npm install vue-router-2-state
# OR
yarn add vue-router-2-state

Get started with the documentation, or play with the examples (see how to run them below).

Quick Start

// src/App.vue
<template>
  <RouterView />
</template>

// src/main.js
import Vue from 'vue';
import Router from 'vue-router-2-state';
import HomePage from './pages/HomePage.vue';
import App from './App.vue';
Vue.use(Router);

const router = new Router({
  mode: 'history',
  // base: import.meta.env.BASE_URL // if using vite
  routes: [
    // Route definitions go here
    {
      path: '/',
      name: 'Home',
      component: HomePage
    }
  ]
});

new Vue({
  router,
  render: (h) => {
    return h(App);
  },
}).$mount('#app');

Composables

You can use the router with the composition API by importing from vue-router-2-state/composables

Type Issues

Vue 2 has unfortunate type issues when using moduleResolution: bundler or moduleResolution: nodenext which causes a lot of vue-2 libraries to lose type information.

To fix it, as with that PR, change line 33 of vue's package.json file using patch-package with --exclude // option to avoid excluding the package.json which it does by default:

-     "./types/*": "./types/*",
+     "./types/*": ["./types/*.d.ts", "./types/*"],

This library is set up so that it works around this fix at the cost of slightly more complex resolutions once the fix is actually merged in (or you patch the file on your end), but it shouldn't affect much.

Development Setup

# install deps
yarn

# build dist files
yarn build

# serve examples at localhost:8080
yarn dev

# lint & run all tests
yarn test

# serve docs at localhost:8080
yarn docs

Releasing

• yarn run release which does the following:
  • Ensure tests are passing yarn run test
  • Build dist files VERSION=<the_version> yarn run build
  • Build changelog yarn run changelog
  • Commit dist files git add dist CHANGELOG.md && git commit -m "[build $VERSION]"
  • Publish a new version `npm version $VERSION --message "[release] $VERSION"
  • Push tags git push origin refs/tags/v$VERSION && git push
  • Publish to npm npm publish

Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

Changelog

Details changes for each release are documented in the CHANGELOG.md file.

License

MIT