fix: 同步文档

ant-design · Feb 2, 2024 · bf7dd13 · bf7dd13
1 parent 6331e7e
commit bf7dd13
Show file tree

Hide file tree

Showing 85 changed files with 2,075 additions and 1,898 deletions.
diff --git a/compiled/alipay/src/ActionSheet/index.md b/compiled/alipay/src/ActionSheet/index.md
@@ -12,30 +12,34 @@ toc: 'content'
 <code src="../../docs/components/compatibility.tsx" inline="true"></code>
 
 从底部弹出的动作菜单面板。
-## 何时使用 
-由用户操作触发，提供一组与操作相关的两个或多个选项，让用户在不离场的情况下完成操作。相比于对话框，动作面板的位置更适合于在大屏幕时代的单手操作
+
+## 何时使用
+
+由用户操作触发，提供一组与操作相关的两个或多个选项，让用户在不离场的情况下完成操作。相比于对话框，动作面板的位置更适合于在大屏幕时代单手操作的场景。
+
 ## 代码示例
+
 <code src='pages/ActionSheet/index'></code>
 
-## API 
-| 属性 | 说明 | 类型 | 默认值 |
-| -----|-----|-----|-----|
-| actions | 面板选项列表 | [ActionSheetItem](#actionshetitem)[] | []  |
-| cancelText | 取消按钮文字 | string | 取消 |
-| className | 类名 | string | - |
-| style | 样式 | string | - |
-| title | 标题 | string | - |
-| visible | 是否展开 | boolean | false |
-| onClose | 关闭时触发| (event: [Event](https://opendocs.alipay.com/mini/framework/event-object)) => void | - | 
-| onAction | 点击选项时触发，禁用状态下不会触发 | (item: [ActionSheetItem](#actionsheetitem), index: number, event: [Event](https://opendocs.alipay.com/mini/framework/event-object)) => void | - | 
+## API
 
+| 属性        | 说明                | 类型                   | 默认值 |
+| ----------- | ------------------- | ---------------------- | ------ |
+| actions     | 面板选项列表        | `[ActionSheetItem](#actionshetitem)`[] | []     |
+| cancelText  | 取消按钮文字        | string                 | 取消   |
+| className   | 类名                | string                 | -      |
+| style       | 样式                | string                 | -      |
+| title       | 标题                | string                 | -      |
+| visible     | 是否展开            | boolean                | false  |
+| onClose     | 关闭时触发          | `(event: [Event](https://opendocs.alipay.com/mini/framework/event-object))` => void | - |
+| onAction    | 点击选项时触发，禁用状态下不会触发 | `(item: [ActionSheetItem](#actionsheetitem), index: number, event: [Event](https://opendocs.alipay.com/mini/framework/event-object))` => void | - |
 
-### ActionSheetItem
- 属性 | 说明 | 类型 | 默认值 |
-| -----|-----|-----|-----|
-| icon | 面板选项列表 | 图标 | - |
-| danger | 是否危险模式 | boolean | false |
-| description | 取消按钮文字 | string | 否 |
-| disabled | 是否禁用 | boolean | false |
 
+### ActionSheetItem
 
+| 属性        | 说明       | 类型    | 默认值 |
+| ----------- | ---------- | ------- | ------ |
+| icon        | 图标       | -       | -      |
+| danger      | 是否危险模式| boolean | false  |
+| description | 描述       | string  | -      |
+| disabled    | 是否禁用   | boolean | false  |
diff --git a/compiled/alipay/src/Avatar/index.md b/compiled/alipay/src/Avatar/index.md
@@ -4,26 +4,28 @@ nav:
 group:
   title: 信息展示
   order: 8
-toc: 'content'
+toc: content
 ---
 
 # Avatar 头像
 
 <code src="../../docs/components/compatibility.tsx" inline="true"></code>
 
-用来代表用户或事物
+用来代表用户或事物。
+
 ## 何时使用
-需要更加直观的展现人物或事物特征
+
+需要更加直观地展现人物或事物特征时。
 
 ## 代码示例
 
 <code src='pages/Avatar/index'></code>
 
 ## API
 
-| 属性 | 说明 | 类型 | 默认值 |
-| --- | --- | --- | --- |
-| className | 类名 | string | - |
-| size | 大小，可选 `x-small`，`small`，`medium`，`large` | string | `medium` |
-| src | 头像地址 | string | 灰色的内置图片 |
-| style | 样式 | string | - |
+| 属性      | 说明       | 类型   | 默认值       |
+|---------|----------|------|-----------|
+| className | 类名      | string | -         |
+| size     | 大小，可选 `x-small`、`small`、`medium`、`large` | string | `medium` |
+| src      | 头像地址    | string | 灰色的内置图片 |
+| style    | 样式      | string | -         |
diff --git a/compiled/alipay/src/Badge/index.md b/compiled/alipay/src/Badge/index.md
@@ -11,25 +11,24 @@ toc: 'content'
 
 <code src="../../docs/components/compatibility.tsx" inline="true"></code>
 
-徽标，红点、数字或文字。用于告诉用户待处理的事物或更新数。
+徽标，显示红点、数字或文字。用于提醒用户，有待处理的事项或者新的更新数量。
+
 ## 何时使用
-在右上角展示数字、文字、小红点	适用于产品化的新消息、新功能、新服务等内容的提醒，通过醒目视觉形式吸引用户处理
+当需要在右上角展示数字、文字或小红点时使用。适合于提示产品化的新消息、功能或服务等内容，通过显眼的视觉形式吸引用户注意，并促使其进行相关操作。
 
 ## 代码示例
-<code src='pages/Badge/index'></code>
-
-
+<code src="pages/Badge/index"></code>
 
 ## API
 
-| 属性 | 说明 | 类型 | 默认值 |
-| -----|-----|-----|----- |
-| bgColor | 自定义背景色，css色值 | string | - | 
-| className | 组件根节点类名 | string | - | 
-| offsetX | 水平方向偏移量 | string | -50% | 
-| offsetY | 垂直方向偏移量 | string | -50% | 
-| position | 相对于容器徽标的位置，可选`top-left` `top-right` `top-center` `left` `right` `bottom-left` `bottom-center` `bottom-right` | string | `top-right` | 
-| stroke | 是否有描边 | boolean | false | 
-| style | 样式 | string | - | 
-| text | 红点内容，为空时表示只显示红点；可以是数字，也可以是文字；如果是数字，超过 99 会自动变成 ... | string \| number \| slot | - |
-| type | badge 类型，可选`dot`(红点) `number`(数字类型，会自动做>99转换) `text`(文字气泡) `bubble`(气泡形态，带箭头) |  string | `dot` | 
+| 属性      | 说明                                 | 类型                 | 默认值       |
+| --------- | ------------------------------------ | -------------------- | ------------ |
+| bgColor   | 自定义背景色，CSS 色值              | string               | -            |
+| className | 组件根节点的类名                     | string               | -            |
+| offsetX   | 水平方向偏移量      | string               | '-50%'       |
+| offsetY   | 垂直方向的偏移量    | string               | '-50%'       |
+| position  | 徽标相对于容器的位置，选项包括：`top-left`、`top-right`、`top-center`、`left`、`right`、`bottom-left`、`bottom-center` 和 `bottom-right` | string | `top-right` |
+| stroke    | 徽标是否带有描边                    | boolean              | false        |
+| style     | 自定义样式                           | object               | -            |
+| text      | 徽标内容，为空代表仅展示红点；可以是数字或文字；若是数字且超过 99，则显示为 `...` | string \| number \| slot     | -            |
+| type      | 徽标类型，选项包括：`dot`（红点）、`number`（数字类型，超过 99 会自动转换）、`text`（文字气泡）和 `bubble`（气泡形态，带有箭头） | string | `dot`       |
diff --git a/compiled/alipay/src/Button/index.md b/compiled/alipay/src/Button/index.md
@@ -6,56 +6,71 @@ group:
   order: 2
 toc: 'content'
 ---
+
 # Button 按钮
 
 <code src="../../docs/components/compatibility.tsx" inline="true"></code>
 
-用于开始一个即时操作
+用于开始一个即时操作。
 
 ## 何时使用
-标记了一个（或封装一组）操作命令，响应用户点击行为，触发相应的业务逻辑
+
+标记了一个（或封装一组）操作命令，响应用户点击行为，触发相应的业务逻辑。
+
 ## 代码示例
+
 ### 基本使用
+
 <code src='pages/Button/index'></code>
 
 ### Inline
+
 <code src='pages/ButtonInline/index'></code>
 
 ### Icon
+
 <code src='pages/ButtonIcon/index'></code>
 
 ### 更多自定义
+
 <code src='pages/ButtonCustom/index'></code>
 
 ## API
+
 ### Button
+
+以下表格介绍了 Button 组件的 API 属性：
+
 | 属性 | 说明 | 类型 | 默认值 |
-| -----|-----|-----|-----|
-| type | 按钮类型, 可选 `primary` `default` `text`  | string | `default` |
+| --- | --- | --- | --- |
+| type | 按钮类型，可选 `primary`、`default`、`text` | string | `default` |
 | danger | 是否为危险按钮 | boolean | false |
 | disabled | 是否为失效按钮 | boolean | false |
 | activeClassName | 按下时的类名 | string | - |
 | className | 类名 | string | - |
 | style | 样式 | string | - |
-| inline | 是否为内联按钮  | boolean | false |
+| inline | 是否为内联按钮 | boolean | false |
 | icon | 按钮左侧图标 | string | - |
 | loading | 是否加载中，加载中时不可点击 | boolean | - |
-| size | 按钮大小。仅在 inline 下生效，可选 `small`, `medium`, `large`  | string | medium |
-| subText | 辅助文字，显示在第二行。inline 下不生效 | string | - |
-| catchTap | 点击按钮，触发此回调, 非冒泡 | (e: [Event](https://opendocs.alipay.com/mini/framework/event-object)) => void  | - |
-| onTap | 点击按钮，触发此回调 | (e: [Event](https://opendocs.alipay.com/mini/framework/event-object)) => void  | - |
+| size | 按钮大小。仅在 `inline` 下生效，可选 `small`、`medium`、`large` | string | `medium` |
+| subText | 辅助文字，显示在第二行。`inline` 下不生效 | string | - |
+| catchTap | 点击按钮，触发此回调，非冒泡 | (e: [Event](https://opendocs.alipay.com/mini/framework/event-object)) => void | - |
+| onTap | 点击按钮，触发此回调 | (e: [Event](https://opendocs.alipay.com/mini/framework/event-object)) => void | - |
 
 ### 更多属性
 
-- public-id
-- open-type
-- scope
-- form-type
-- onGetAuthorize
-- onFollowLifestyle
-- onError
-- onGetUserInfo
-- onGetPhoneNumber
+以下是 Button 组件支持的其他属性：
+
+- `public-id`
+- `open-type`
+- `scope`
+- `form-type`
+- `onGetAuthorize`
+- `onFollowLifestyle`
+- `onError`
+- `onGetUserInfo`
+- `onGetPhoneNumber`
 
-https://opendocs.alipay.com/mini/component/button#%E5%B1%9E%E6%80%A7%E8%AF%B4%E6%98%8E
+具体的属性说明，请参考支付宝小程序的官方文档。
 
+[Button 组件属性说明](https://opendocs.alipay.com/mini/component/button#%E5%B1%9E%E6%80%A7%E8%AF%B4%E6%98%8E)
diff --git a/compiled/alipay/src/Calendar/index.md b/compiled/alipay/src/Calendar/index.md
@@ -19,6 +19,8 @@ toc: 'content'
 
 ## API
 
+以下为日历组件的属性及描述：
+
 | 属性          | 说明                                            | 类型                                                        | 默认值      |
 | ------------- | ---------------------------------------------- | ----------------------------------------------------------- | ----------- |
 | defaultValue  | 初始值                                          | CalendarValue                                               | 无          |
@@ -29,17 +31,16 @@ toc: 'content'
 | onChange      | 日期变化回调                                    | (date: CalendarValue) => void                               | 无          |
 | onFormatter   | 用于设置单元格的自定义数据                        | (cell: CellState, currentValue: CalendarValue) => CellState  | 无          |
 | localeText    | 国际化文案                                      | Partial`<LocaleText>`                                       | 无          |
-
 ### 类型
 
-**CalendarValue** : 日历的 Value 类型为 `number | [number,number]`, 代表单选或者连续区间的日期。 是一个时间戳，单位为毫秒。
+**CalendarValue** : 日历的值类型，为数字或数字元组 `number | [number,number]`，表示单选或连续日期区间。单位为毫秒的时间戳。
 
-**CellState** : 日历单元格的状态
+**CellState** : 定义了日历单元格的各种状态。
 
 ```typescript
 interface CellState {
   /**
-   * 是否被禁止
+   * 是否禁用
    */
   disabled: boolean;
   /**
@@ -59,107 +60,109 @@ interface CellState {
    */
   date: number;
   /**
-   * 是否被选择
+   * 是否选中
    */
   isSelected: boolean;
 }
 ```
 
-**LocaleText** : 国际化文案
+**LocaleText** : 提供国际化支持的文案结构。
 
 ```typescript
 interface LocaleText {
   /**
-   * 星期的名称。从周一到周日
+   * 星期的名称，从周一至周日
    * 默认为 ['一', '二', '三', '四', '五', '六', '日']
    */
   weekdayNames: string[];
   /**
-   * 月份标题的格式。 默认为 'YYYY年MM月'
+   * 月份标题的格式，默认为 'YYYY年MM月'
    */
   title: string;
   /**
-   * 今日的文案。 默认为 '今日'
+   * 今天的文案，默认为 '今日'
    */
   today: string;
   /**
-   * 开始的文案。 默认为 '开始'
+   * 开始的文案，默认为 '开始'
    */
   start: string;
   /**
-   * 结束的文案。 默认为 '结束'
+   * 结束的文案，默认为 '结束'
    */
-  startAndEnd: string;
+  end: string;
   /**
-   * 开始/结束的文案。 默认为 '开始/结束'
+   * 开始与结束的文案，默认为 '开始/结束'
    */
-  end: string;
+  startAndEnd: string;
 }
 ```
 
 ## FAQ
 
-### 如何设置默认的开始与结束时间 ？
+### 如何设置默认的开始与结束时间？
 
-通过 `defaultValue` 设置默认的时间。 `defaultValue` 的类型为 CalendarValue。
+通过 `defaultValue` 可以设置默认的时间。`defaultValue` 的类型是 `CalendarValue`。
 
-CalendarValue 的类型为 `number | [number,number]`，代表单选或者连续区间的日期。 是一个时间戳，单位为毫秒。
+`CalendarValue` 的类型是 `number | [number, number]`，代表单选或者连续区间的日期。它是一个时间戳，单位是毫秒。
 
-举个例子，如果我们想要设置默认的开始时间为今天，结束时间为 7 天后，所以我们可以在 defaultValue 内传入
+例如，如果我们想设置默认的开始时间为今天，结束时间为七天后，我们可以在 `defaultValue` 中传入以下代码：
 
 ```ts
 [dayjs().startOf('date'), dayjs().add(7, 'days').startOf('date')];
 ```
 
 ### 通过 `onFormatter` 设置单元格的自定义数据
 
-我们可以通过 `onFormatter` 设置单元格的自定义数据， `onFormatter` 的格式为 `(cell: CellState, currentValue: CalendarValue) => CellState`。
+我们可以通过 `onFormatter` 方法设置单元格的自定义数据，`onFormatter` 的格式是 `(cell: CellState, currentValue: CalendarValue) => CellState`。
 
-我们会调用每一个单元格的状态，以及当前的 value。 通过返回新的单元格数据，我们可以设置单元格的状态。
+这个函数会获取每个单元格的状态以及当前的值。通过返回新的单元格数据，我们可以自定义单元格的状态。
 
-下面是一些常见的用例
+以下是一些常见的使用场景：
 
 #### 如何让当天之前的时间不可选？
 
-支付宝小程序，我们可以通过 page 上的方法来设置，在 wxml 里需要传入一个方法名字符串。
+在支付宝小程序中，我们可以通过页面上的方法设置，需要在 axml 文件中传入一个方法名字符串。
 
-axml:
+axml 文件：
 
 ```xml
 <calendar onFormatter="handleFormat" />
 ```
 
-ts:
+ts 文件：
 
 ```ts
 import dayjs from 'dayjs';
 
 Page({
   handleFormat(cell: CellState) {
+    // 如果单元格代表的时间早于今天的开始时间，则禁止选择
     return {
-      // 如果 cell 的时间小于今天的开始时间，那么就禁止选择
       disabled: dayjs(cell.time).isBefore(dayjs().startOf('date')),
     };
   },
 });
 ```
 
-支付宝小程序，我们可以通过 data 里的方法来设置。 在 wxml 里需要传入一个变量名。
+在微信小程序，我们也可以通过 data 中的函数来设置，此时在 wxml 文件中需要传入一个变量名。
 
-wxml:
+wxml 文件：
 
 ```xml
 <calendar onFormatter="{{ handleFormat }}" />
 ```
 
+ts 文件：
+
 ```ts
 import dayjs from 'dayjs';
 
 Page({
   data: {
     handleFormat: (cell: CellState) => {
+      // 如果单元格代表的时间早于今天的开始时间，则禁止选择
       return {
-        // 如果 cell 的时间小于今天的开始时间，那么就禁止选择
         disabled: dayjs(cell.time).isBefore(dayjs().startOf('date')),
       };
     },