/vue-scxml-router

SCXML state machine vue router

Primary LanguageJavaScriptMIT LicenseMIT

vue-scmxl-router

SCXML state machine vue router

npm version Build Status Code Status

CURRENTLY POC: API subject to change

vue-scxml-router is state machine based router for Vue.js. It integrates with Vue.js to support well defined and predictable user navigation. Features include:

  • State-machine based router configuration
  • View transition effects powered by Vue.js' transition system
  • Links with automatic active CSS classes

Motivation

Why another vue-router alternative? For Web Applications (including Hybrid apps) that require users to follow an expected workflow through the system, it can be difficult to guarentee that flow is followed. Overheads can include stopping unwanted jumps through the system, and managing 'userHasDoneX' state. Splitting the navigation model out from the app, and using an existing standard, allows tools to rationalise and visualise a users navigation experiance.

Usage

TODO: Getting Started

TODO: API docs

Development Setup

# install deps
npm install

# lint files
npm run lint

# run all tests with coverage
npm run coverage

# run all tests
npm test