docs: sort api endpoints alphabetically (Tencent#766)

Co-authored-by: Luozf <[email protected]>

Author: RSS1102

.github/workflows/preview-build.yml

@@ -10,9 +10,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
+      - name: Configure Git to not use symlinks
+        run: git config --global core.symlinks false
+
       - uses: actions/checkout@v4
         with:
           submodules: recursive
+          lfs: true
 
 
       - name: Set Node version
@@ -166,6 +170,13 @@ jobs:
       - name: demo tools build api md
         run: |
           cd $GITHUB_WORKSPACE/tdesign-component/demo_tool
+          # Make sure binary files are not symlinks
+          if [ -L ./bin/api_tool_linux ]; then
+            echo "Error: api_tool_linux is a symlink. This may be a Git configuration issue."
+            echo "Please check if Git LFS is properly configured or if the file should be a regular file."
+            exit 1
+          fi
+          chmod +x ./bin/api_tool_linux
           sh all_build.sh
       
       - name: Build site

tdesign-component/demo_tool/bin/api_tool_linux

@@ -6,13 +6,13 @@
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| label | String | - | 标提 |
-| textStyle | TextStyle? | - | 标题样式 |
-| icon | Widget? | - | 图标 |
 | badge | TDBadge? | - | 角标 |
 | disabled | bool | false | 是否禁用 |
-| iconSize | double? | - | 图标大小 |
 | group | String? | - | 分组，用于带描述多行滚动宫格 |
+| icon | Widget? | - | 图标 |
+| iconSize | double? | - | 图标大小 |
+| label | String | - | 标题 |
+| textStyle | TextStyle? | - | 标题样式 |
 
 ```
 ```
@@ -23,32 +23,32 @@
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| context | BuildContext | context | 上下文 |
 | align | TDActionSheetAlign | TDActionSheetAlign.center | 对齐方式 |
-| cancelText | String | '取消' | 取消按钮的文本 |
+| cancelText | String? | - | 取消按钮的文本 |
+| closeOnOverlayClick | bool | true | 点击蒙层时是否关闭 |
+| context | BuildContext | context | 上下文 |
 | count | int | 8 | 每页显示的项目数 |
-| rows | int | 2 | 显示的行数 |
+| description | String? | - | 描述文本 |
 | itemHeight | double | 96.0 | 项目的行高 |
 | itemMinWidth | double | 80.0 | 项目的最小宽度 |
-| description | String? | - | 描述文本 |
 | items | List<TDActionSheetItem> | - | ActionSheet的项目列表 |
-| showCancel | bool | true | 是否显示取消按钮 |
-| showPagination | bool | false | 是否显示分页 |
-| scrollable | bool | false | 是否可以横向滚动 |
-| theme | TDActionSheetTheme | TDActionSheetTheme.list | 主题样式 |
-| visible | bool | false | 是否立即显示 |
 | onCancel | VoidCallback? | - | 取消按钮的回调函数 |
 | onClose | VoidCallback? | - | 关闭时的回调函数 |
 | onSelected | TDActionSheetItemCallback? | - | 选择项目时的回调函数 |
+| rows | int | 2 | 显示的行数 |
+| scrollable | bool | false | 是否可以横向滚动 |
+| showCancel | bool | true | 是否显示取消按钮 |
 | showOverlay | bool | true | 是否显示遮罩层 |
-| closeOnOverlayClick | bool | true | 点击蒙层时是否关闭 |
+| showPagination | bool | false | 是否显示分页 |
+| theme | TDActionSheetTheme | TDActionSheetTheme.list | 主题样式 |
 | useSafeArea | bool | true | 使用安全区域 |
+| visible | bool | false | 是否立即显示 |
 
 
 #### 静态方法
 
 | 名称 | 返回类型 | 参数 | 说明 |
 | --- | --- | --- | --- |
-| showListActionSheet |  |   required BuildContext context,  required List<TDActionSheetItem> items,  TDActionSheetAlign align,  String cancelText,  bool showCancel,  VoidCallback? onCancel,  TDActionSheetItemCallback? onSelected,  bool showOverlay,  bool closeOnOverlayClick,  VoidCallback? onClose,  bool useSafeArea, | 显示列表类型面板 |
-| showGridActionSheet |  |   required BuildContext context,  required List<TDActionSheetItem> items,  TDActionSheetAlign align,  String cancelText,  bool showCancel,  TDActionSheetItemCallback? onSelected,  bool showOverlay,  bool closeOnOverlayClick,  int count,  int rows,  double itemHeight,  double itemMinWidth,  bool scrollable,  bool showPagination,  VoidCallback? onCancel,  String? description,  VoidCallback? onClose,  bool useSafeArea, | 显示宫格类型面板 |
-| showGroupActionSheet |  |   required BuildContext context,  required List<TDActionSheetItem> items,  TDActionSheetAlign align,  String cancelText,  bool showCancel,  TDActionSheetItemCallback? onSelected,  bool showOverlay,  bool closeOnOverlayClick,  double itemHeight,  double itemMinWidth,  VoidCallback? onCancel,  VoidCallback? onClose,  bool useSafeArea, | 显示分组类型面板 |
+| showGridActionSheet |  |   required BuildContext context,  required List<TDActionSheetItem> items,  TDActionSheetAlign align,  String? cancelText,  bool showCancel,  TDActionSheetItemCallback? onSelected,  bool showOverlay,  bool closeOnOverlayClick,  int count,  int rows,  double itemHeight,  double itemMinWidth,  bool scrollable,  bool showPagination,  VoidCallback? onCancel,  String? description,  VoidCallback? onClose,  bool useSafeArea, | 显示宫格类型面板 |
+| showGroupActionSheet |  |   required BuildContext context,  required List<TDActionSheetItem> items,  TDActionSheetAlign align,  String? cancelText,  bool showCancel,  TDActionSheetItemCallback? onSelected,  bool showOverlay,  bool closeOnOverlayClick,  double itemHeight,  double itemMinWidth,  VoidCallback? onCancel,  VoidCallback? onClose,  bool useSafeArea, | 显示分组类型面板 |
+| showListActionSheet |  |   required BuildContext context,  required List<TDActionSheetItem> items,  TDActionSheetAlign align,  String? cancelText,  bool showCancel,  VoidCallback? onCancel,  TDActionSheetItemCallback? onSelected,  bool showOverlay,  bool closeOnOverlayClick,  VoidCallback? onClose,  bool useSafeArea, | 显示列表类型面板 |

tdesign-component/example/assets/api/action-sheet_api.md

@@ -4,21 +4,21 @@
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| key |  | - |  |
-| size | TDAvatarSize | TDAvatarSize.medium | 头像尺寸 |
-| type | TDAvatarType | TDAvatarType.normal | 头像类型 |
-| shape | TDAvatarShape | TDAvatarShape.circle | 头像形状 |
-| text | String? | - | 自定义文字 |
-| radius | double? | - | 自定义圆角 |
-| icon | IconData? | - | 自定义图标 |
-| avatarUrl | String? | - | 头像地址 |
-| avatarSize | double? | - | 自定义头像大小 |
-| avatarDisplayList | List<String>? | - | 带操作\展示的头像列表 |
-| displayText | String? | - | 纯展示类型末尾文字 |
-| onTap |  Function()? | - | 操作点击事件 |
-| defaultUrl | String | '' | 默认图片（本地） |
+| avatarDisplayBorder | double | 2 | 带操作展示的头像描边宽度 |
+| avatarDisplayList | List<String>? | - | 带操作展示的头像列表 |
+| avatarDisplayListAsset | List<String>? | - | 带操作展示的头像列表（本地资源） |
 | avatarDisplayWidget | Widget? | - | 带操作头像自定义操作Widget |
-| avatarDisplayBorder | double | 2 | 带操作\展示的头像描边宽度 |
-| avatarDisplayListAsset | List<String>? | - | 带操作\展示的头像列表 (本地资源) |
+| avatarSize | double? | - | 自定义头像大小 |
+| avatarUrl | String? | - | 头像地址 |
 | backgroundColor | Color? | - | 自定义文案时背景色 |
+| defaultUrl | String | '' | 默认图片（本地） |
+| displayText | String? | - | 纯展示类型末尾文字 |
 | fit | BoxFit? | - | 自定义图片对齐方式 |
+| icon | IconData? | - | 自定义图标 |
+| key |  | - |  |
+| onTap |  Function()? | - | 操作点击事件 |
+| radius | double? | - | 自定义圆角 |
+| shape | TDAvatarShape | TDAvatarShape.circle | 头像形状 |
+| size | TDAvatarSize | TDAvatarSize.medium | 头像尺寸 |
+| text | String? | - | 自定义文字 |
+| type | TDAvatarType | TDAvatarType.normal | 头像类型 |

tdesign-component/example/assets/api/avatar_api.md

@@ -4,9 +4,9 @@
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| key |  | - |  |
 | controller | ScrollController? | - | 页面滚动的控制器 |
-| theme | TDBackTopTheme | TDBackTopTheme.light | 主题 |
-| style | TDBackTopStyle | TDBackTopStyle.circle | 样式，圆形和半圆 |
-| showText | bool | false | 是否展示文字 |
+| key |  | - |  |
 | onClick | VoidCallback? | - | 按钮点击事件 |
+| showText | bool | false | 是否展示文字 |
+| style | TDBackTopStyle | TDBackTopStyle.circle | 样式，圆形和半圆 |
+| theme | TDBackTopTheme | TDBackTopTheme.light | 主题 |

tdesign-component/example/assets/api/back-top_api.md

@@ -4,16 +4,16 @@
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| type | TDBadgeType | type | 红点样式 |
-| key |  | - |  |
+| border | TDBadgeBorder | TDBadgeBorder.large | 红点圆角大小 |
+| color | Color? | - | 红点颜色 |
 | count | String? | - | 红点数量 |
+| key |  | - |  |
 | maxCount | String? | '99' | 最大红点数量 |
-| border | TDBadgeBorder | TDBadgeBorder.large | 红点圆角大小 |
+| message | String? | - | 消息内容 |
+| padding | EdgeInsetsGeometry? | - | 角标自定义padding |
+| showZero | bool | true | 值为0是否显示 |
 | size | TDBadgeSize | TDBadgeSize.small | 红点尺寸 |
-| color | Color? | - | 红点颜色 |
 | textColor | Color? | - | 文字颜色 |
-| message | String? | - | 消息内容 |
+| type | TDBadgeType | type | 红点样式 |
 | widthLarge | double | 32 | 角标大三角形宽 |
 | widthSmall | double | 12 | 角标小三角形宽 |
-| padding | EdgeInsetsGeometry? | - | 角标自定义padding |
-| showZero | bool | true | 值为0是否显示 |

tdesign-component/example/assets/api/badge_api.md

@@ -6,19 +6,19 @@
 | --- | --- | --- | --- |
 | backgroundColor | Color? | - | 背景颜色 |
 | frameColor | Color? | - | 边框颜色 |
-| textColor | Color? | - | 文字颜色 |
 | frameWidth | double? | - | 边框宽度 |
 | radius | BorderRadiusGeometry? | - | 自定义圆角 |
+| textColor | Color? | - | 文字颜色 |
 
 
 #### 工厂构造方法
 
 | 名称  | 说明 |
 | --- |  --- |
 | TDButtonStyle.generateFillStyleByTheme  | 生成不同主题的填充按钮样式 |
+| TDButtonStyle.generateGhostStyleByTheme  | 生成不同主题的幽灵按钮样式 |
 | TDButtonStyle.generateOutlineStyleByTheme  | 生成不同主题的描边按钮样式 |
 | TDButtonStyle.generateTextStyleByTheme  | 生成不同主题的文本按钮样式 |
-| TDButtonStyle.generateGhostStyleByTheme  | 生成不同主题的幽灵按钮样式 |
 
 ```
 ```
@@ -27,27 +27,27 @@
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| key |  | - |  |
-| text | String? | - | 文本内容 |
-| size | TDButtonSize | TDButtonSize.medium | 尺寸 |
-| type | TDButtonType | TDButtonType.fill | 类型：填充，描边，文字 |
-| shape | TDButtonShape | TDButtonShape.rectangle | 形状：圆角，胶囊，方形，圆形，填充 |
-| theme | TDButtonTheme? | - | 主题 |
+| activeStyle | TDButtonStyle? | - | 自定义点击样式，有则优先用它，没有则根据 type 和 theme 选取 |
 | child | Widget? | - | 自控件 |
 | disabled | bool | false | 禁止点击 |
-| isBlock | bool | false | 是否为通栏按钮 |
-| style | TDButtonStyle? | - | 自定义样式，有则优先用它，没有则根据type和theme选取.如果设置了style,则activeStyle和disableStyle也应该设置 |
-| activeStyle | TDButtonStyle? | - | 自定义点击样式，有则优先用它，没有则根据type和theme选取 |
-| disableStyle | TDButtonStyle? | - | 自定义禁用样式，有则优先用它，没有则根据type和theme选取 |
-| textStyle | TextStyle? | - | 自定义可点击状态文本样式 |
+| disableStyle | TDButtonStyle? | - | 自定义禁用样式，有则优先用它，没有则根据 type 和 theme 选取 |
 | disableTextStyle | TextStyle? | - | 自定义不可点击状态文本样式 |
-| width | double? | - | 自定义宽度 |
 | height | double? | - | 自定义高度 |
-| onTap | TDButtonEvent? | - | 点击事件 |
 | icon | IconData? | - | 图标icon |
-| iconWidget | Widget? | - | 自定义图标icon控件 |
+| iconPosition | TDButtonIconPosition? | TDButtonIconPosition.left | 图标位置 |
 | iconTextSpacing | double? | - | 自定义图标与文本之间距离 |
+| iconWidget | Widget? | - | 自定义图标 icon 控件 |
+| isBlock | bool | false | 是否为通栏按钮 |
+| key |  | - |  |
+| margin | EdgeInsetsGeometry? | - | 自定义 margin |
 | onLongPress | TDButtonEvent? | - | 长按事件 |
-| margin | EdgeInsetsGeometry? | - | 自定义margin |
-| padding | EdgeInsetsGeometry? | - | 自定义padding |
-| iconPosition | TDButtonIconPosition? | TDButtonIconPosition.left | 图标位置 |
+| onTap | TDButtonEvent? | - | 点击事件 |
+| padding | EdgeInsetsGeometry? | - | 自定义 padding |
+| shape | TDButtonShape | TDButtonShape.rectangle | 形状：圆角，胶囊，方形，圆形，填充 |
+| size | TDButtonSize | TDButtonSize.medium | 尺寸 |
+| style | TDButtonStyle? | - | 自定义样式，有则优先用它，没有则根据 type 和 theme 选取。如果设置了 style，则 activeStyle 和 disableStyle 也应该设置 |
+| text | String? | - | 文本内容 |
+| textStyle | TextStyle? | - | 自定义可点击状态文本样式 |
+| theme | TDButtonTheme? | - | 主题 |
+| type | TDButtonType | TDButtonType.fill | 类型：填充，描边，文字 |
+| width | double? | - | 自定义宽度 |

tdesign-component/example/assets/api/button_api.md

@@ -1,18 +1,28 @@
 ## API
-### TDCalendarPopup
+### TDCalendarStyle
 #### 默认构造方法
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| context | BuildContext | context | 上下文 |
-| top | double? | - | 距离顶部的距离 |
-| autoClose | bool? | true | 自动关闭；在点击关闭按钮、确认按钮、遮罩层时自动关闭 |
-| confirmBtn | Widget? | - | 自定义确认按钮 |
-| visible | bool? | - | 默认是否显示日历 |
-| onClose | VoidCallback? | - | 关闭时触发 |
-| onConfirm | void Function(List<int> value)? | - | 点击确认按钮时触发 |
-| builder | CalendarBuilder? | - | 控件构建器，优先级高于[child] |
-| child | TDCalendar? | - | 日历控件 |
+| cellDecoration | BoxDecoration? | - | 日期decoration |
+| cellPrefixStyle | TextStyle? | - | 日期前面的字符串的样式 |
+| cellStyle | TextStyle? | - | 日期样式 |
+| cellSuffixStyle | TextStyle? | - | 日期后面的字符串的样式 |
+| centreColor | Color? | - | 日期范围内背景样式 |
+| decoration |  | - |  |
+| monthTitleStyle | TextStyle? | - | body区域 年月文字样式 |
+| titleCloseColor | Color? | - | header区域 关闭图标的颜色 |
+| titleMaxLine | int? | - | header区域 [TDCalendar.title]的行数 |
+| titleStyle | TextStyle? | - | header区域 [TDCalendar.title]的样式 |
+| weekdayStyle | TextStyle? | - | header区域 周 文字样式 |
+
+
+#### 工厂构造方法
+
+| 名称  | 说明 |
+| --- |  --- |
+| TDCalendarStyle.cellStyle  | 日期样式 |
+| TDCalendarStyle.generateStyle  | 生成默认样式 |
 
 ```
 ```
@@ -21,57 +31,48 @@
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| key |  | - |  |
+| animateTo | bool? | false | 动画滚动到指定位置 |
+| cellHeight | double? | 60 | 日期高度 |
+| cellWidget | Widget? Function(BuildContext context, TDate tdate, DateSelectType selectType)? | - | 自定义日期单元格组件 |
+| displayFormat | String? | 'year month' | 年月显示格式，`year`表示年，`month`表示月，如`year month`表示年在前、月在后、中间隔一个空格 |
 | firstDayOfWeek | int? | 0 | 第一天从星期几开始，默认 0 = 周日 |
 | format | CalendarFormat? | - | 用于格式化日期的函数，可定义日期前后的显示内容和日期样式 |
-| maxDate | int? | - | 最大可选的日期(fromMillisecondsSinceEpoch)，不传则默认半年后 |
-| minDate | int? | - | 最小可选的日期(fromMillisecondsSinceEpoch)，不传则默认今天 |
-| title | String? | - | 标题 |
-| titleWidget | Widget? | - | 标题组件 |
-| type | CalendarType? | CalendarType.single | 日历的选择类型，single = 单选；multiple = 多选; range = 区间选择 |
-| value | List<int>? | - | 当前选择的日期(fromMillisecondsSinceEpoch)，不传则默认今天，当 type = single 时数组长度为1 |
-| displayFormat | String? | 'year month' | 年月显示格式，`year`表示年，`month`表示月，如`year month`表示年在前、月在后、中间隔一个空格 |
-| cellHeight | double? | 60 | 日期高度 |
 | height | double? | - | 高度 |
-| width | double? | - | 宽度 |
-| style | TDCalendarStyle? | - | 自定义样式 |
-| onChange | void Function(List<int> value)? | - | 选中值变化时触发 |
+| isTimeUnit | bool? | true | 是否显示时间单位 |
+| key |  | - |  |
+| maxDate | int? | - | 最大可选的日期（fromMillisecondsSinceEpoch），不传则默认半年后 |
+| minDate | int? | - | 最小可选的日期（fromMillisecondsSinceEpoch），不传则默认今天 |
+| monthTitleBuilder | Widget Function(BuildContext context, DateTime monthDate)? | - | 月标题构建器 |
+| monthTitleHeight | double? | 22 | 月标题高度 |
 | onCellClick | void Function(int value, DateSelectType type, TDate tdate)? | - | 点击日期时触发 |
 | onCellLongPress | void Function(int value, DateSelectType type, TDate tdate)? | - | 长安日期时触发 |
+| onChange | void Function(List<int> value)? | - | 选中值变化时触发 |
 | onHeaderClick | void Function(int index, String week)? | - | 点击周时触发 |
-| useTimePicker | bool? | false | 是否显示时间选择器 |
-| timePickerModel | List<DatePickerModel>? | - | 自定义时间选择器 |
-| monthTitleHeight | double? | 22 | 月标题高度 |
-| monthTitleBuilder | Widget Function(BuildContext context, DateTime monthDate)? | - | 月标题构建器 |
 | pickerHeight | double? | 178 | 时间选择器List的视窗高度 |
 | pickerItemCount | int? | 3 | 选择器List视窗中item个数，pickerHeight / pickerItemCount即item高度 |
-| isTimeUnit | bool? | true | 是否显示时间单位 |
-| animateTo | bool? | false | 动画滚动到指定位置 |
-| cellWidget | Widget? Function(BuildContext context, TDate tdate, DateSelectType selectType)? | - | 自定义日期单元格组件 |
+| style | TDCalendarStyle? | - | 自定义样式 |
+| timePickerModel | List<DatePickerModel>? | - | 自定义时间选择器 |
+| title | String? | - | 标题 |
+| titleWidget | Widget? | - | 标题组件 |
+| type | CalendarType? | CalendarType.single | 日历的选择类型，single = 单选；multiple = 多选；range = 区间选择 |
+| useSafeArea | bool? | true | 是否使用安全区域，默认true |
+| useTimePicker | bool? | false | 是否显示时间选择器 |
+| value | List<int>? | - | 当前选择的日期（fromMillisecondsSinceEpoch），不传则默认今天，当 type = single 时数组长度为1 |
+| width | double? | - | 宽度 |
 
 ```
 ```
- ### TDCalendarStyle
+ ### TDCalendarPopup
 #### 默认构造方法
 
 | 参数 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| decoration |  | - |  |
-| titleStyle | TextStyle? | - | header区域 [TDCalendar.title]的样式 |
-| titleMaxLine | int? | - | header区域 [TDCalendar.title]的行数 |
-| titleCloseColor | Color? | - | header区域 关闭图标的颜色 |
-| weekdayStyle | TextStyle? | - | header区域 周 文字样式 |
-| monthTitleStyle | TextStyle? | - | body区域 年月文字样式 |
-| cellStyle | TextStyle? | - | 日期样式 |
-| centreColor | Color? | - | 日期范围内背景样式 |
-| cellDecoration | BoxDecoration? | - | 日期decoration |
-| cellPrefixStyle | TextStyle? | - | 日期前面的字符串的样式 |
-| cellSuffixStyle | TextStyle? | - | 日期后面的字符串的样式 |
-
-
-#### 工厂构造方法
-
-| 名称  | 说明 |
-| --- |  --- |
-| TDCalendarStyle.generateStyle  | 生成默认样式 |
-| TDCalendarStyle.cellStyle  | 日期样式 |
+| autoClose | bool? | true | 自动关闭；在点击关闭按钮、确认按钮、遮罩层时自动关闭 |
+| builder | CalendarBuilder? | - | 控件构建器，优先级高于[child] |
+| child | TDCalendar? | - | 日历控件 |
+| confirmBtn | Widget? | - | 自定义确认按钮 |
+| context | BuildContext | context | 上下文 |
+| onClose | VoidCallback? | - | 关闭时触发 |
+| onConfirm | void Function(List<int> value)? | - | 点击确认按钮时触发 |
+| top | double? | - | 距离顶部的距离 |
+| visible | bool? | - | 默认是否显示日历 |