Преглед на файлове

[stdf]Update AsyncPicker documents.

dufu1991 преди 1 година
родител
ревизия
e1c302cba8
променени са 2 файла, в които са добавени 42 реда и са изтрити 42 реда
  1. 25 25
      doc/components/asyncPicker/api.md
  2. 17 17
      doc/components/asyncPicker/api_en.md

+ 25 - 25
doc/components/asyncPicker/api.md

@@ -1,30 +1,30 @@
 ## AsyncPicker Props
 
-| 名称         | 类型                            | 默认值                            | 必传 | 说明                                                                                          |
-| ------------ | ------------------------------- | --------------------------------- | ---- | --------------------------------------------------------------------------------------------- |
-| visible      | `boolean`                       | false                             | N    | 是否显示。                                                                                    |
-| data         | `array`                         | []                                | Y    | 列数据,具体使用请参考示例。                                                                  |
-| lastLevel    | `boolean`                       | false                             | N    | 是否是最后一级。                                                                              |
-| firstLevel   | `boolean`                       | false                             | N    | 是否是第一级。                                                                                |
-| showRow      | `3` \| `5` \| `7`               | 5                                 | N    | 列显示行数。                                                                                  |
-| labelKey     | `string`                        | 'label'                           | N    | 自定义 label 的 key。                                                                         |
-| align        | `'left' \| 'center' \| 'right'` | 'center'                          | N    | 对齐方式。                                                                                    |
-| cancelText   | `string`                        | 当前语言的 picker.defaultCancel   | N    | 取消选项文本。                                                                                |
-| confirmText  | `string`                        | 当前语言的 picker.defaultConfirm  | N    | 确定选项文本。                                                                                |
-| title        | `string`                        | 当前语言的 picker.defaultTitle    | N    | 中间标题文本。                                                                                |
-| nextText     | `string`                        | 当前语言的 picker.defaultNext     | N    | 下一级文本。                                                                                  |
-| prevText     | `string`                        | 当前语言的 picker.defaultPrev     | N    | 上一级文本。                                                                                  |
-| showSelected | `boolean`                       | false                             | N    | 是否显示已选项。                                                                              |
-| selectedText | `string`                        | 当前语言的 picker.defaultSelected | N    | 已选文本。                                                                                    |
-| popup        | `Popup`                         | {}                                | N    | 弹出层参数 [Popup Props](https://stdf.design/#/components?nav=popup&tab=1)。                  |
-| loading      | `Loading`                       | {}                                | N    | 加载数据时 Loading 参数 [Loading Props](https://stdf.design/#/components?nav=loading&tab=1)。 |
+| 名称         | 类型                        | 默认值                            | 必传 | 说明                                                                                          |
+| ------------ | --------------------------- | --------------------------------- | ---- | --------------------------------------------------------------------------------------------- |
+| visible      | `boolean`                   | `false`                           | N    | 是否显示。                                                                                    |
+| data         | `array`                     | `[]`                              | Y    | 列数据,具体使用请参考示例。                                                                  |
+| lastLevel    | `boolean`                   | `false`                           | N    | 是否是最后一级。                                                                              |
+| firstLevel   | `boolean`                   | `false`                           | N    | 是否是第一级。                                                                                |
+| showRow      | `3\|5\|7`                   | `5`                               | N    | 列显示行数。                                                                                  |
+| labelKey     | `string`                    | `'label'`                         | N    | 自定义 label 的 key。                                                                         |
+| align        | `'left'\|'center'\|'right'` | `'center'`                        | N    | 对齐方式。                                                                                    |
+| cancelText   | `string`                    | 当前语言的 picker.defaultCancel   | N    | 取消选项文本。                                                                                |
+| confirmText  | `string`                    | 当前语言的 picker.defaultConfirm  | N    | 确定选项文本。                                                                                |
+| title        | `string`                    | 当前语言的 picker.defaultTitle    | N    | 中间标题文本。                                                                                |
+| nextText     | `string`                    | 当前语言的 picker.defaultNext     | N    | 下一级文本。                                                                                  |
+| prevText     | `string`                    | 当前语言的 picker.defaultPrev     | N    | 上一级文本。                                                                                  |
+| showSelected | `boolean`                   | `false`                           | N    | 是否显示已选项。                                                                              |
+| selectedText | `string`                    | 当前语言的 picker.defaultSelected | N    | 已选文本。                                                                                    |
+| popup        | `Popup`                     | `{}`                              | N    | 弹出层参数 [Popup Props](https://stdf.design/#/components?nav=popup&tab=1)。                  |
+| loading      | `Loading`                   | `{}`                              | N    | 加载数据时 Loading 参数 [Loading Props](https://stdf.design/#/components?nav=loading&tab=1)。 |
 
 ## AsyncPicker Events
 
-| 名称      | 类型                                       | 参数                                                                | 描述                   |
-| --------- | ------------------------------------------ | ------------------------------------------------------------------- | ---------------------- |
-| onclose   | `() => void`                               | -                                                                   | 关闭时触发。           |
-| oncancel  | `() => void`                               | -                                                                   | 点击左侧取消时触发。   |
-| onprev    | `() => void`                               | -                                                                   | 点击左侧上一级时触发。 |
-| onnext    | `(index: number) => void`                  | index - 当前选定项在所在列的索引                                    | 点击右侧下一级时触发。 |
-| onconfirm | `(items: any[], indexs: number[]) => void` | items - 选定多列数据组成的数组indexs - 选定多列数据索引组成的数组 | 点击右侧确定时触发。   |
+| 名称      | 类型                                       | 参数                                                                    | 描述                   |
+| --------- | ------------------------------------------ | ----------------------------------------------------------------------- | ---------------------- |
+| onclose   | `() => void`                               | -                                                                       | 关闭时触发。           |
+| oncancel  | `() => void`                               | -                                                                       | 点击左侧取消时触发。   |
+| onprev    | `() => void`                               | -                                                                       | 点击左侧上一级时触发。 |
+| onnext    | `(index: number) => void`                  | index - 当前选定项在所在列的索引                                        | 点击右侧下一级时触发。 |
+| onconfirm | `(items: any[], indexs: number[]) => void` | items - 选定多列数据组成的数组<br />indexs - 选定多列数据索引组成的数组 | 点击右侧确定时触发。   |

+ 17 - 17
doc/components/asyncPicker/api_en.md

@@ -2,29 +2,29 @@
 
 | Name         | Type                            | Default                                 | Required | Description                                                                             |
 | ------------ | ------------------------------- | --------------------------------------- | -------- | --------------------------------------------------------------------------------------- |
-| visible      | `boolean`                       | false                                   | N        | Whether to show the picker.                                                             |
-| data         | `array`                         | []                                      | Y        | Column data. Please refer to examples for specific usage.                               |
-| lastLevel    | `boolean`                       | false                                   | N        | Whether it is the last level.                                                           |
-| firstLevel   | `boolean`                       | false                                   | N        | Whether it is the first level.                                                          |
-| showRow      | `3` \| `5` \| `7`               | 5                                       | N        | Number of rows to display in the column.                                                |
-| labelKey     | `string`                        | 'label'                                 | N        | Custom key for label.                                                                   |
-| align        | `'left' \| 'center' \| 'right'` | 'center'                                | N        | Text alignment.                                                                         |
+| visible      | `boolean`                       | `false`                                 | N        | Whether to show the picker.                                                             |
+| data         | `array`                         | `[]`                                    | Y        | Column data. Please refer to examples for specific usage.                               |
+| lastLevel    | `boolean`                       | `false`                                 | N        | Whether it is the last level.                                                           |
+| firstLevel   | `boolean`                       | `false`                                 | N        | Whether it is the first level.                                                          |
+| showRow      | `3\|5\|7`                       | `5`                                     | N        | Number of rows to display in the column.                                                |
+| labelKey     | `string`                        | `'label'`                               | N        | Custom key for label.                                                                   |
+| align        | `'left' \| 'center' \| 'right'` | `'center'`                              | N        | Text alignment.                                                                         |
 | cancelText   | `string`                        | Current language picker.defaultCancel   | N        | Cancel button text.                                                                     |
 | confirmText  | `string`                        | Current language picker.defaultConfirm  | N        | Confirm button text.                                                                    |
 | title        | `string`                        | Current language picker.defaultTitle    | N        | Title text.                                                                             |
 | nextText     | `string`                        | Current language picker.defaultNext     | N        | Next level text.                                                                        |
 | prevText     | `string`                        | Current language picker.defaultPrev     | N        | Previous level text.                                                                    |
-| showSelected | `boolean`                       | false                                   | N        | Whether to show selected items.                                                         |
+| showSelected | `boolean`                       | `false`                                 | N        | Whether to show selected items.                                                         |
 | selectedText | `string`                        | Current language picker.defaultSelected | N        | Selected text.                                                                          |
-| popup        | `Popup`                         | {}                                      | N        | Popup parameters [Popup Props](https://stdf.design/#/components?nav=popup&tab=1).       |
-| loading      | `Loading`                       | {}                                      | N        | Loading parameters [Loading Props](https://stdf.design/#/components?nav=loading&tab=1). |
+| popup        | `Popup`                         | `{}`                                    | N        | Popup parameters [Popup Props](https://stdf.design/#/components?nav=popup&tab=1).       |
+| loading      | `Loading`                       | `{}`                                    | N        | Loading parameters [Loading Props](https://stdf.design/#/components?nav=loading&tab=1). |
 
 ## AsyncPicker Events
 
-| Name      | Type                                       | Parameters                                                                | Description                             |
-| --------- | ------------------------------------------ | ------------------------------------------------------------------------- | --------------------------------------- |
-| onclose   | `() => void`                               | -                                                                         | Triggered when closing.                 |
-| oncancel  | `() => void`                               | -                                                                         | Triggered when clicking cancel.         |
-| onprev    | `() => void`                               | -                                                                         | Triggered when clicking previous level. |
-| onnext    | `(index: number) => void`                  | index - Index of selected item in current column                          | Triggered when clicking next level.     |
-| onconfirm | `(items: any[], indexs: number[]) => void` | items - Array of selected column data; indexs - Array of selected indexes | Triggered when clicking confirm.        |
+| Name      | Type                                       | Parameters                                                                    | Description                             |
+| --------- | ------------------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------- |
+| onclose   | `() => void`                               | -                                                                             | Triggered when closing.                 |
+| oncancel  | `() => void`                               | -                                                                             | Triggered when clicking cancel.         |
+| onprev    | `() => void`                               | -                                                                             | Triggered when clicking previous level. |
+| onnext    | `(index: number) => void`                  | index - Index of selected item in current column                              | Triggered when clicking next level.     |
+| onconfirm | `(items: any[], indexs: number[]) => void` | items - Array of selected column data<br />indexs - Array of selected indexes | Triggered when clicking confirm.        |