Skip to content

Commit

Permalink
docs(mobx): 修正格式,名词规范化
Browse files Browse the repository at this point in the history
  • Loading branch information
Garfield550 committed Mar 11, 2019
1 parent a88edbb commit 0dae6fc
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/mobx.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 使用 Mobx
title: 使用 MobX
---

> `1.2.0-beta.1` 开始支持
[Mobx](https://mobx.js.org/) 为复杂项目中状态管理提供了一种简单高效的机制;Taro 提供了 `@tarojs/mobx` 来让开发人员在使用Mobx的过程中获得更加良好的开发体验
[MobX](https://mobx.js.org/) 为复杂项目中状态管理提供了一种简单高效的机制;Taro 提供了 `@tarojs/mobx` 来让开发人员在使用 MobX 的过程中获得更加良好的开发体验

> 下文中示例代码均在 [taro-mobx-sample](https://github.com/nanjingboy/taro-mobx-sample)
Expand Down Expand Up @@ -158,18 +158,18 @@ export default Index

```

上例中 `Provider``inject``observer`的使用方式基本上与[mobx-react](https://github.com/mobxjs/mobx-react) 保持了一致,但也有以下几点需要注意:
上例中 `Provider``inject``observer` 的使用方式基本上与 [mobx-react](https://github.com/mobxjs/mobx-react) 保持了一致,但也有以下几点需要注意:

* `Provider`不支持嵌套,即全局只能存在一个`Provider`
*`mobx-react`中,可通过以下方式设置`store`
* `Provider` 不支持嵌套,即全局只能存在一个 `Provider`
*`mobx-react` 中,可通过以下方式设置 `store`

```jsx
<Provider store1={xxxx} store2={xxxx}>
<XXX />
</Provider>
```

而在`@tarojs/mobx`中,我们需要使用以下方式设置:
而在 `@tarojs/mobx` 中,我们需要使用以下方式设置:

```jsx
const store = {
Expand All @@ -181,9 +181,9 @@ export default Index
</Provider>
```

* `inject``observer` 不能在stateless组件上使用
* `inject``observer` 不能在 stateless 组件上使用
* `observer` 不支持任何参数
* 按照以下方式使用 `inject` 时,不能省略`observer`的显式调用:
* 按照以下方式使用 `inject` 时,不能省略 `observer` 的显式调用:

```jsx
@inject((stores, props) => ({
Expand All @@ -194,12 +194,12 @@ export default Index

注意事项:

*`Component``render`方法中,如果需要使用一个`observable` 对象(该例中为`counter`),您需要:
* `Component``render` 方法中,如果需要使用一个 `observable` 对象(该例中为 `counter`),您需要:

```js
const { counterStore: { counter } } = this.props
return (
<Text>{counter}</Text>
<Text>{counter}</Text>
)
```

Expand All @@ -208,7 +208,7 @@ export default Index
```js
const { counterStore } = this.props
return (
<Text>{counterStore.counter}</Text>
<Text>{counterStore.counter}</Text>
)
```

Expand All @@ -219,12 +219,12 @@ export default Index
@observable counter = 0 // 正确
```

*`1.2.0-beta.5`后,`propTypes`已从`taro-mobx``taro-mobx-h5``taro-mobx-rn`中剥离,如需使用,请单独进行安装:
* `1.2.0-beta.5` 后,`propTypes` 已从 `taro-mobx``taro-mobx-h5``taro-mobx-rn` 中剥离,如需使用,请单独进行安装:

```bash
$ yarn add @tarojs/mobx-prop-types
# 或者使用 npm
$ npm install --save @tarojs/mobx-prop-types
```

`propTypes` 使用与[mobx-react](https://github.com/mobxjs/mobx-react#proptypes) 一致
`propTypes` 使用与 [mobx-react](https://github.com/mobxjs/mobx-react#proptypes) 一致

0 comments on commit 0dae6fc

Please sign in to comment.