https://github.com/zvecr/vue-scxml-router

SCXML state machine vue router
https://github.com/zvecr/vue-scxml-router

scxml vue vue-router vuejs2

Last synced: 2 months ago
JSON representation

SCXML state machine vue router

• Host: GitHub
• URL: https://github.com/zvecr/vue-scxml-router
• Owner: zvecr
• License: mit
• Created: 2019-06-15T15:12:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-06-25T21:19:35.000Z (over 6 years ago)
• Last Synced: 2025-01-30T04:15:36.349Z (8 months ago)
• Topics: scxml, vue, vue-router, vuejs2
• Language: JavaScript
• Homepage:
• Size: 59.6 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vue-scmxl-router

> SCXML state machine vue router

[![npm version](https://badge.fury.io/js/vue-scmxl-router.svg)](https://badge.fury.io/js/vue-scmxl-router)

[![Build Status](https://travis-ci.org/zvecr/vue-scmxl-router.svg?branch=master)](https://travis-ci.org/zvecr/vue-scmxl-router)

![Code Status](https://img.shields.io/badge/status-poc-red.svg)

## CURRENTLY POC: API subject to change

`vue-scxml-router` is state machine based router for [Vue.js](http://vuejs.org). 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

``` bash

# install deps

npm install

# lint files

npm run lint

# run all tests with coverage

npm run coverage

# run all tests

npm test

```