Skip to content

Commit 9af79e5

Browse files
committed
docs: 文档更新(二)
1 parent b35c941 commit 9af79e5

File tree

224 files changed

+6033
-3066
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

224 files changed

+6033
-3066
lines changed

Diff for: docs/apis/about/desc.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: API 说明
3+
---
4+
5+
Taro 的 API 包括 Taro 内置提供的 API 以及对小程序的端能力 API 的封装。
6+
7+
其中对小程序的端能力 API 的封装,主要会基于微信小程序的 API 规范,对于其他小程序类似的 API,会在 Taro 中适配为小程序 API 的规范格式,并且都挂载在 `Taro` 命名空间下。
8+
9+
例如,支付宝小程序中,`my.alert` 用于弹出一个警告的模态框,而微信小程序中没有这一 API,与之类似的有 `wx.showModal`,所以在 Taro 中会将支付宝的 `my.alert` 统一为 `Taro.showModal`,从而减少一些跨平台兼容代码的书写。
10+
11+
而对于微信小程序中没有,而某些小程序平台特有的 API,可以先尝试用 `Taro.` + API 名称来进行调用,如果出现未定义,则使用对应小程序平台的命名空间(如 `my``swan``tt` 等)来进行调用,并反馈给我们。
12+
13+
当然,由于各个小程序平台的迭代非常快速,Taro 要不断跟进小程序的更新,有时候难免有些 API 没有加入 Taro 适配,你可以通过提 PR 或者 issue,来获得帮助。
14+
15+
同时,为了方便代码书写,Taro 默认对小程序的异步 API 进行了 `promisify` 化,你可以像使用 Promise 那样进行调用,例如
16+
17+
```js
18+
import Taro from '@tarojs/taro'
19+
20+
Taro.request(url).then(function (res) {
21+
console.log(res)
22+
})
23+
```
24+
25+
26+

Diff for: docs/apis/about/env.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: 环境判断
3+
---
4+
5+
## Taro.ENV_TYPE
6+
7+
`ENV_TYPE.WEAPP` 微信小程序环境
8+
9+
`ENV_TYPE.SWAN` 百度小程序环境
10+
11+
`ENV_TYPE.ALIPAY` 支付宝小程序环境
12+
13+
`ENV_TYPE.TT` 字节跳动小程序环境
14+
15+
`ENV_TYPE.WEB` WEB(H5)环境
16+
17+
`ENV_TYPE.RN` ReactNative 环境
18+
19+
## Taro.getEnv()
20+
21+
获取当前环境值,具体值如上 `Taro.ENV_TYPE`

Diff for: docs/apis/about/events.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: 消息机制
3+
---
4+
5+
Taro 提供了 `Taro.Events` 来实现消息机制,使用时需要实例化它,如下
6+
7+
```jsx
8+
import Taro, { Events } from '@tarojs/taro'
9+
10+
const events = new Events()
11+
12+
// 监听一个事件,接受参数
13+
events.on('eventName', (arg) => {
14+
// doSth
15+
})
16+
17+
// 监听同个事件,同时绑定多个 handler
18+
events.on('eventName', handler1)
19+
events.on('eventName', handler2)
20+
events.on('eventName', handler3)
21+
22+
// 触发一个事件,传参
23+
events.trigger('eventName', arg)
24+
25+
// 触发事件,传入多个参数
26+
events.trigger('eventName', arg1, arg2, ...)
27+
28+
// 取消监听一个事件
29+
events.off('eventName')
30+
31+
// 取消监听一个事件某个 handler
32+
events.off('eventName', handler1)
33+
34+
// 取消监听所有事件
35+
events.off()
36+
```
37+
38+
同时 Taro 还提供了一个全局消息中心 `Taro.eventCenter` 以供使用,它是 `Taro.Events` 的实例
39+
40+
```jsx
41+
import Taro from '@tarojs/taro'
42+
43+
Taro.eventCenter.on
44+
Taro.eventCenter.trigger
45+
Taro.eventCenter.off
46+
```

0 commit comments

Comments
 (0)