k-mst-router

Make a Router from mobx-state-tree model !

Contents

• Purpose
• Why ?
• Installation
• API
• Examples

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 })