https://github.com/umijs/umi-plugin-mobx-state-tree

use mobx-state-tree in umijs@3
https://github.com/umijs/umi-plugin-mobx-state-tree

Last synced: 3 months ago
JSON representation

use mobx-state-tree in umijs@3

• Host: GitHub
• URL: https://github.com/umijs/umi-plugin-mobx-state-tree
• Owner: umijs
• Created: 2018-10-12T13:18:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-09T03:10:07.000Z (about 4 years ago)
• Last Synced: 2024-03-21T22:02:58.995Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 841 KB
• Stars: 21
• Watchers: 4
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Lists

• awesome-umi - umi-plugin-mobx-state-tree - Use mobx-state-tree in umijs@2. (Plugins / Open Source)

README

        
# umi-plugin-mobx-state-tree

umi@3 的 mobx 插件。

约定加载 src/stores 下的所有文件(可通过设置 exclude 排除某些文件)

所有store全部加载到统一的store对象上，默认取文件名作为inject查找的对象名。

```

inject(({stores}) => ({

    list: stores.list

}))(observer(App));

注意：这里的list，实际上是stores.stores.list

```

## 快速使用

安装

```

$ npm i umi-plugin-mobx-state-tree

```

## 支持配置

```js

export default {

  mobx: {

    exclude: [/^\$/] //这里是以$开头的stores不会被引用

  }

};

```

exclude:提供 src/stores 下的文件不被注册的功能，比如加上$前缀就不会被注册了,值为正则表达式

## /src/mobx.js

可以通过src/mobx.js配置初始值和开启mobx-react-devtools调试工具

```

export function config() {

  return {

    devTools: true,

    mstTools: false,

    initStores: {

      list: {

        name: "init list name"

      }

    }

  };

}

```

可以通过设置``mstTools: true``开启mobx-devtools-mst，这个功能需要依赖[mobx浏览器调试工具](https://github.com/mobxjs/mobx-devtools/blob/master/README.md#features)使用。

这个配置可以通过runtime修改。

[examples codesandbox](https://codesandbox.io/s/zw15r4yrrl)