Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

k-mst-router

fabienjuif11MIT0.1.1

mobx-state-tree model router

readme

k-mst-router

Make a Router from mobx-state-tree model !

CircleCI Coverage Status NPM Version Size

Contents

Purpose

TODO

Why

TODO

Installation

  • yarn add k-mst-router
  • npm i --save k-mst-router

API

  1. Import the Model from k-mst-router: import Router from 'k-mst-router'
  2. Use it to one of your model, and initialize it with a preProcessSnapshot :

    import { types } from 'mobx-state-tree'
    import Router from 'k-mst-router'
    
    export default types
     .model({
       router: Router,
     })
     .named('Store')
     .preProcessSnapshot(snapshot => ({
       ...snapshot,
       router: {
         screens: [
           {
             name: 'list',
             path: '/',
           },
           {
             name: 'new',
             path: '/new',
           },
           {
             name: 'authentication',
             path: '/login',
           },
           {
             name: 'edit',
             path: '/contacts/:id',
           }
         ],
       },
     }))
  3. Change routes with go action: store.router.go('new')
  4. It supports parameters: store.router.go('edit', { id: 3 })