Skip to content

Commit c226444

Browse files
authored
refactor: docs (#117)
* chore: docs * chore: docs
1 parent a6f8442 commit c226444

File tree

122 files changed

+3441
-3475
lines changed

Some content is hidden

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

122 files changed

+3441
-3475
lines changed

packages/accelerometer/README-zh_CN.md renamed to packages/accelerometer/README-en-US.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# universal-accelerometer [![npm](https://img.shields.io/npm/v/universal-accelerometer.svg)](https://www.npmjs.com/package/universal-accelerometer)
22

3-
加速度监听与取消.
3+
Accelerometer monitor and cancel.
44

5-
## 支持
5+
## Support
66
<img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px">
77

8-
## 安装
8+
## Install
99

1010
```bash
1111
$ npm install universal-accelerometer --save
1212
```
1313

14-
## 方法
14+
## Methods
1515

1616
### `onChange(callback): void`
1717

18-
监听加速度数据,频率:5次/秒,接口调用后会自动开始监听,可以使用 offChange() 停止监听。
18+
Monitoring acceleration data, the callback interval is 500ms, the interface calls will automatically start listening, can use offChange() to stop listening.
1919

20-
#### 参数
21-
| 属性 | 类型 | 描述 | 支持 |
20+
#### Parameters
21+
| Property | Type | Description | Support |
2222
| -------- | -------- | ------------- | :-----: |
23-
| callback | `Function` | 回调函数 | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px"> |
23+
| callback | `Function` | The callback function | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px"> |
2424

2525
### `offChange(): void`
2626

27-
停止监听加速度数据
27+
Stop listening for acceleration data.
2828

29-
## 示例
29+
## Example
3030

3131
```js
3232
import Accelerometer from 'universal-accelerometer';

packages/accelerometer/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# universal-accelerometer [![npm](https://img.shields.io/npm/v/universal-accelerometer.svg)](https://www.npmjs.com/package/universal-accelerometer)
22

3-
Accelerometer monitor and cancel.
3+
加速度监听与取消.
44

5-
## Support
5+
## 支持
66
<img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px">
77

8-
## Install
8+
## 安装
99

1010
```bash
1111
$ npm install universal-accelerometer --save
1212
```
1313

14-
## Methods
14+
## 方法
1515

1616
### `onChange(callback): void`
1717

18-
Monitoring acceleration data, the callback interval is 500ms, the interface calls will automatically start listening, can use offChange() to stop listening.
18+
监听加速度数据,频率:5次/秒,接口调用后会自动开始监听,可以使用 offChange() 停止监听。
1919

20-
#### Parameters
21-
| Property | Type | Description | Support |
20+
#### 参数
21+
| 属性 | 类型 | 描述 | 支持 |
2222
| -------- | -------- | ------------- | :-----: |
23-
| callback | `Function` | The callback function | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px"> |
23+
| callback | `Function` | 回调函数 | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px"> |
2424

2525
### `offChange(): void`
2626

27-
Stop listening for acceleration data.
27+
停止监听加速度数据
2828

29-
## Example
29+
## 示例
3030

3131
```js
3232
import Accelerometer from 'universal-accelerometer';

packages/accelerometer/docs-template/README-zh_CN.md renamed to packages/accelerometer/docs-template/README-en-US.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# universal-accelerometer [![npm](https://img.shields.io/npm/v/universal-accelerometer.svg)](https://www.npmjs.com/package/universal-accelerometer)
22

3-
加速度监听与取消.
3+
Accelerometer monitor and cancel.
44

5-
## 支持
5+
## Support
66
__icon_miniapp_mp__ __icon_miniapp_wx__
77

8-
## 安装
8+
## Install
99

1010
```bash
1111
$ npm install universal-accelerometer --save
1212
```
1313

14-
## 方法
14+
## Methods
1515

1616
### `onChange(callback): void`
1717

18-
监听加速度数据,频率:5次/秒,接口调用后会自动开始监听,可以使用 offChange() 停止监听。
18+
Monitoring acceleration data, the callback interval is 500ms, the interface calls will automatically start listening, can use offChange() to stop listening.
1919

20-
#### 参数
21-
| 属性 | 类型 | 描述 | 支持 |
20+
#### Parameters
21+
| Property | Type | Description | Support |
2222
| -------- | -------- | ------------- | :-----: |
23-
| callback | `Function` | 回调函数 | __icon_miniapp_mp__ __icon_miniapp_wx__ |
23+
| callback | `Function` | The callback function | __icon_miniapp_mp__ __icon_miniapp_wx__ |
2424

2525
### `offChange(): void`
2626

27-
停止监听加速度数据
27+
Stop listening for acceleration data.
2828

29-
## 示例
29+
## Example
3030

3131
```js
3232
import Accelerometer from 'universal-accelerometer';

packages/accelerometer/docs-template/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# universal-accelerometer [![npm](https://img.shields.io/npm/v/universal-accelerometer.svg)](https://www.npmjs.com/package/universal-accelerometer)
22

3-
Accelerometer monitor and cancel.
3+
加速度监听与取消.
44

5-
## Support
5+
## 支持
66
__icon_miniapp_mp__ __icon_miniapp_wx__
77

8-
## Install
8+
## 安装
99

1010
```bash
1111
$ npm install universal-accelerometer --save
1212
```
1313

14-
## Methods
14+
## 方法
1515

1616
### `onChange(callback): void`
1717

18-
Monitoring acceleration data, the callback interval is 500ms, the interface calls will automatically start listening, can use offChange() to stop listening.
18+
监听加速度数据,频率:5次/秒,接口调用后会自动开始监听,可以使用 offChange() 停止监听。
1919

20-
#### Parameters
21-
| Property | Type | Description | Support |
20+
#### 参数
21+
| 属性 | 类型 | 描述 | 支持 |
2222
| -------- | -------- | ------------- | :-----: |
23-
| callback | `Function` | The callback function | __icon_miniapp_mp__ __icon_miniapp_wx__ |
23+
| callback | `Function` | 回调函数 | __icon_miniapp_mp__ __icon_miniapp_wx__ |
2424

2525
### `offChange(): void`
2626

27-
Stop listening for acceleration data.
27+
停止监听加速度数据
2828

29-
## Example
29+
## 示例
3030

3131
```js
3232
import Accelerometer from 'universal-accelerometer';
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# universal-action-sheet [![npm](https://img.shields.io/npm/v/universal-action-sheet.svg)](https://www.npmjs.com/package/universal-action-sheet)
2+
3+
Action sheet.
4+
5+
## Support
6+
<img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px">
7+
8+
## Install
9+
10+
```bash
11+
$ npm install universal-action-sheet --save
12+
```
13+
14+
## Methods
15+
16+
### `show(options)`
17+
18+
Display action sheet.
19+
20+
#### Parameters
21+
| Property | Type | Default | Description | Support |
22+
| -------- | -------- | ------- | -------------- | ----------------- |
23+
| title | `String` | - | The menu title | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> |
24+
| items | `Array` | - | Menu button text array | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px"> |
25+
| cancelButtonText | `String` | 取消 | Cancel button | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> |
26+
27+
## Example
28+
29+
```js
30+
import ActionSheet from 'universal-action-sheet';
31+
32+
ActionSheet.show({
33+
items: ['one', 'two', 'three'],
34+
success: res => {
35+
console.log(res.index);
36+
},
37+
fail: res => {
38+
console.log(res.errMsg);
39+
}
40+
});
41+
42+
```
43+

packages/action-sheet/README-zh_CN.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

packages/action-sheet/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
# universal-action-sheet [![npm](https://img.shields.io/npm/v/universal-action-sheet.svg)](https://www.npmjs.com/package/universal-action-sheet)
22

3-
Action sheet.
3+
显示操作菜单.
44

5-
## Support
5+
## 支持
66
<img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px">
77

8-
## Install
8+
## 安装
99

1010
```bash
1111
$ npm install universal-action-sheet --save
1212
```
1313

14-
## Methods
14+
## 方法
1515

1616
### `show(options)`
1717

18-
Display action sheet.
18+
显示操作菜单。
1919

20-
#### Parameters
21-
| Property | Type | Default | Description | Support |
22-
| -------- | -------- | ------- | -------------- | ----------------- |
23-
| title | `String` | - | The menu title | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> |
24-
| items | `Array` | - | Menu button text array | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px"> |
25-
| cancelButtonText | `String` | 取消 | Cancel button | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> |
20+
#### 参数
21+
| 属性 | 类型 | 默认值 | 描述 | 支持 |
22+
| ---------------- | -------- | ------ | ---------------- | --------------------------------------- |
23+
| title | `String` | - | 菜单标题 | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> |
24+
| items | `Array` | - | 菜单按钮文字数组 | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> <img alt="wechatMiniprogram" src="https://img.alicdn.com/tfs/TB1slcYdxv1gK0jSZFFXXb0sXXa-200-200.svg" width="25px" height="25px"> |
25+
| cancelButtonText | `String` | 取消 | 取消按钮文案 | <img alt="miniApp" src="https://gw.alicdn.com/tfs/TB1bBpmbRCw3KVjSZFuXXcAOpXa-200-200.svg" width="25px" height="25px" /> |
2626

27-
## Example
27+
28+
## 示例
2829

2930
```js
3031
import ActionSheet from 'universal-action-sheet';
@@ -40,4 +41,3 @@ ActionSheet.show({
4041
});
4142

4243
```
43-
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# universal-action-sheet [![npm](https://img.shields.io/npm/v/universal-action-sheet.svg)](https://www.npmjs.com/package/universal-action-sheet)
2+
3+
Action sheet.
4+
5+
## Support
6+
__icon_miniapp_mp__ __icon_miniapp_wx__
7+
8+
## Install
9+
10+
```bash
11+
$ npm install universal-action-sheet --save
12+
```
13+
14+
## Methods
15+
16+
### `show(options)`
17+
18+
Display action sheet.
19+
20+
#### Parameters
21+
| Property | Type | Default | Description | Support |
22+
| -------- | -------- | ------- | -------------- | ----------------- |
23+
| title | `String` | - | The menu title | __icon_miniapp_mp__ |
24+
| items | `Array` | - | Menu button text array | __icon_miniapp_mp__ __icon_miniapp_wx__ |
25+
| cancelButtonText | `String` | 取消 | Cancel button | __icon_miniapp_mp__ |
26+
27+
## Example
28+
29+
```js
30+
import ActionSheet from 'universal-action-sheet';
31+
32+
ActionSheet.show({
33+
items: ['one', 'two', 'three'],
34+
success: res => {
35+
console.log(res.index);
36+
},
37+
fail: res => {
38+
console.log(res.errMsg);
39+
}
40+
});
41+
42+
```
43+

packages/action-sheet/docs-template/README-zh_CN.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)