Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions tdesign-component/example/assets/api/action-sheet_api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
## API
### TActionSheetItem
#### 简介
动作面板项目
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| badge | TBadge? | - | 角标 |
| description | String? | - | 描述信息 |
| disabled | bool | false | 是否禁用 |
| group | String? | - | 分组,用于带描述多行滚动宫格 |
| icon | Widget? | - | 图标 |
| iconSize | double? | - | 图标大小 |
| label | String | - | 标题 |
| textStyle | TextStyle? | - | 标题样式 |

```
```

### TActionSheet
#### 简介
动作面板
Expand Down Expand Up @@ -35,22 +54,3 @@
| showGridActionSheet | | required BuildContext context, required List<TActionSheetItem> items, TActionSheetAlign align, String? cancelText, bool showCancel, TActionSheetItemCallback? 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<TActionSheetItem> items, TActionSheetAlign align, String? cancelText, bool showCancel, TActionSheetItemCallback? onSelected, bool showOverlay, bool closeOnOverlayClick, double itemHeight, double itemMinWidth, VoidCallback? onCancel, VoidCallback? onClose, bool useSafeArea, | 显示分组类型面板 |
| showListActionSheet | | required BuildContext context, required List<TActionSheetItem> items, TActionSheetAlign align, String? cancelText, bool showCancel, VoidCallback? onCancel, TActionSheetItemCallback? onSelected, bool showOverlay, bool closeOnOverlayClick, VoidCallback? onClose, bool useSafeArea, | 显示列表类型面板 |

```
```

### TActionSheetItem
#### 简介
动作面板项目
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| badge | TBadge? | - | 角标 |
| description | String? | - | 描述信息 |
| disabled | bool | false | 是否禁用 |
| group | String? | - | 分组,用于带描述多行滚动宫格 |
| icon | Widget? | - | 图标 |
| iconSize | double? | - | 图标大小 |
| label | String | - | 标题 |
| textStyle | TextStyle? | - | 标题样式 |
50 changes: 25 additions & 25 deletions tdesign-component/example/assets/api/button_api.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,4 @@
## API
### TButtonStyle
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| backgroundColor | Color? | - | 背景颜色 |
| frameColor | Color? | - | 边框颜色 |
| frameWidth | double? | - | 边框宽度 |
| gradient | Gradient? | - | 渐变背景色 |
| radius | BorderRadiusGeometry? | - | 自定义圆角 |
| textColor | Color? | - | 文字颜色 |


#### 工厂构造方法

| 名称 | 说明 |
| --- | --- |
| TButtonStyle.generateFillStyleByTheme | 生成不同主题的填充按钮样式 |
| TButtonStyle.generateGhostStyleByTheme | 生成不同主题的幽灵按钮样式 |
| TButtonStyle.generateOutlineStyleByTheme | 生成不同主题的描边按钮样式 |
| TButtonStyle.generateTextStyleByTheme | 生成不同主题的文本按钮样式 |

```
```

### TButton
#### 默认构造方法

Expand Down Expand Up @@ -54,3 +29,28 @@
| theme | TButtonTheme? | - | 主题 |
| type | TButtonType | TButtonType.fill | 类型:填充,描边,文字 |
| width | double? | - | 自定义宽度 |

```
```

### TButtonStyle
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| backgroundColor | Color? | - | 背景颜色 |
| frameColor | Color? | - | 边框颜色 |
| frameWidth | double? | - | 边框宽度 |
| gradient | Gradient? | - | 渐变背景色 |
| radius | BorderRadiusGeometry? | - | 自定义圆角 |
| textColor | Color? | - | 文字颜色 |


#### 工厂构造方法

| 名称 | 说明 |
| --- | --- |
| TButtonStyle.generateFillStyleByTheme | 生成不同主题的填充按钮样式 |
| TButtonStyle.generateGhostStyleByTheme | 生成不同主题的幽灵按钮样式 |
| TButtonStyle.generateOutlineStyleByTheme | 生成不同主题的描边按钮样式 |
| TButtonStyle.generateTextStyleByTheme | 生成不同主题的文本按钮样式 |
64 changes: 32 additions & 32 deletions tdesign-component/example/assets/api/calendar_api.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,4 @@
## API
### TCalendarStyle
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| cellDecoration | BoxDecoration? | - | 日期decoration |
| cellPrefixStyle | TextStyle? | - | 日期前面的字符串的样式 |
| cellStyle | TextStyle? | - | 日期样式 |
| cellSuffixStyle | TextStyle? | - | 日期后面的字符串的样式 |
| centreColor | Color? | - | 日期范围内背景样式 |
| decoration | | - | |
| monthTitleStyle | TextStyle? | - | body区域 年月文字样式 |
| titleCloseColor | Color? | - | header区域 关闭图标的颜色 |
| titleMaxLine | int? | - | header区域 [TCalendar.title]的行数 |
| titleStyle | TextStyle? | - | header区域 [TCalendar.title]的样式 |
| weekdayStyle | TextStyle? | - | header区域 周 文字样式 |


#### 工厂构造方法

| 名称 | 说明 |
| --- | --- |
| TCalendarStyle.cellStyle | 日期样式 |
| TCalendarStyle.generateStyle | 生成默认样式 |

```
```

### TCalendar
#### 默认构造方法

Expand Down Expand Up @@ -69,10 +41,6 @@
```
```

### TCalendarDataSource
```
```

### TCalendarPopup
#### 默认构造方法

Expand All @@ -91,6 +59,38 @@
```
```

### TCalendarStyle
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| cellDecoration | BoxDecoration? | - | 日期decoration |
| cellPrefixStyle | TextStyle? | - | 日期前面的字符串的样式 |
| cellStyle | TextStyle? | - | 日期样式 |
| cellSuffixStyle | TextStyle? | - | 日期后面的字符串的样式 |
| centreColor | Color? | - | 日期范围内背景样式 |
| decoration | | - | |
| monthTitleStyle | TextStyle? | - | body区域 年月文字样式 |
| titleCloseColor | Color? | - | header区域 关闭图标的颜色 |
| titleMaxLine | int? | - | header区域 [TCalendar.title]的行数 |
| titleStyle | TextStyle? | - | header区域 [TCalendar.title]的样式 |
| weekdayStyle | TextStyle? | - | header区域 周 文字样式 |


#### 工厂构造方法

| 名称 | 说明 |
| --- | --- |
| TCalendarStyle.cellStyle | 日期样式 |
| TCalendarStyle.generateStyle | 生成默认样式 |

```
```

### TCalendarDataSource
```
```

### TLunarInfo
#### 默认构造方法

Expand Down
78 changes: 39 additions & 39 deletions tdesign-component/example/assets/api/cell_api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,43 @@
## API
### TCell
#### 简介
单元格组件
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| align | TCellAlign? | TCellAlign.middle | 内容的对齐方式,默认居中对齐。可选项:top/middle/bottom |
| arrow | bool? | false | 是否显示右侧箭头 |
| bordered | bool? | true | 是否显示下边框,仅在TCellGroup组件下起作用 |
| description | String? | - | 下方内容描述文字 |
| descriptionWidget | Widget? | - | 下方内容描述组件 |
| disabled | bool? | false | 禁用 |
| height | double? | - | 高度 |
| hover | bool? | true | 是否开启点击反馈 |
| image | ImageProvider? | - | 主图 |
| imageCircle | double? | 50 | 主图圆角,默认50(圆形) |
| imageSize | double? | - | 主图尺寸 |
| imageWidget | Widget? | - | 主图组件 |
| key | | - | |
| leftIcon | IconData? | - | 左侧图标,出现在单元格标题的左侧 |
| leftIconWidget | Widget? | - | 左侧图标组件 |
| note | String? | - | 和标题同行的说明文字 |
| noteMaxLine | int | 1 | 说明文字组件 最大行数 |
| noteMaxWidth | double? | - | 说明文字组件 最大宽度,超过部分显示省略号,防止文字溢出 |
| noteWidget | Widget? | - | 说明文字组件 |
| onClick | TCellClick? | - | 点击事件 |
| onLongPress | TCellClick? | - | 长按事件 |
| required | bool? | false | 是否显示表单必填星号 |
| rightIcon | IconData? | - | 最右侧图标 |
| rightIconWidget | Widget? | - | 最右侧图标组件 |
| showBottomBorder | bool? | false | 是否显示下边框(建议TCellGroup组件下false,避免与bordered重叠) |
| style | TCellStyle? | - | 自定义样式 |
| title | String? | - | 标题 |
| titleWidget | Widget? | - | 标题组件 |

```
```

### TCellGroup
#### 简介
单元格组组件
Expand Down Expand Up @@ -52,42 +91,3 @@
| 名称 | 说明 |
| --- | --- |
| TCellStyle.cellStyle | 生成单元格默认样式 |

```
```

### TCell
#### 简介
单元格组件
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| align | TCellAlign? | TCellAlign.middle | 内容的对齐方式,默认居中对齐。可选项:top/middle/bottom |
| arrow | bool? | false | 是否显示右侧箭头 |
| bordered | bool? | true | 是否显示下边框,仅在TCellGroup组件下起作用 |
| description | String? | - | 下方内容描述文字 |
| descriptionWidget | Widget? | - | 下方内容描述组件 |
| disabled | bool? | false | 禁用 |
| height | double? | - | 高度 |
| hover | bool? | true | 是否开启点击反馈 |
| image | ImageProvider? | - | 主图 |
| imageCircle | double? | 50 | 主图圆角,默认50(圆形) |
| imageSize | double? | - | 主图尺寸 |
| imageWidget | Widget? | - | 主图组件 |
| key | | - | |
| leftIcon | IconData? | - | 左侧图标,出现在单元格标题的左侧 |
| leftIconWidget | Widget? | - | 左侧图标组件 |
| note | String? | - | 和标题同行的说明文字 |
| noteMaxLine | int | 1 | 说明文字组件 最大行数 |
| noteMaxWidth | double? | - | 说明文字组件 最大宽度,超过部分显示省略号,防止文字溢出 |
| noteWidget | Widget? | - | 说明文字组件 |
| onClick | TCellClick? | - | 点击事件 |
| onLongPress | TCellClick? | - | 长按事件 |
| required | bool? | false | 是否显示表单必填星号 |
| rightIcon | IconData? | - | 最右侧图标 |
| rightIconWidget | Widget? | - | 最右侧图标组件 |
| showBottomBorder | bool? | false | 是否显示下边框(建议TCellGroup组件下false,避免与bordered重叠) |
| style | TCellStyle? | - | 自定义样式 |
| title | String? | - | 标题 |
| titleWidget | Widget? | - | 标题组件 |
44 changes: 22 additions & 22 deletions tdesign-component/example/assets/api/checkbox_api.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,4 @@
## API
### TCheckboxGroup
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| checkedIds | List<String>? | - | 勾选的CheckBox id列表 |
| child | | - | |
| contentDirection | TContentDirection? | - | 文字相对icon的方位 |
| controller | TCheckboxGroupController? | - | 可以通过控制器操作勾选状态 |
| customContentBuilder | ContentBuilder? | - | CheckBox完全自定义内容 |
| customIconBuilder | IconBuilder? | - | 自定义选择icon的样式 |
| key | | - | |
| maxChecked | int? | - | 最多可以勾选多少 |
| onChangeGroup | OnGroupChange? | - | 状态变化监听器 |
| onOverloadChecked | VoidCallback? | - | 超过最大可勾选的个数 |
| spacing | double? | - | CheckBoxicon和文字的距离 |
| style | TCheckboxStyle? | - | CheckBox复选框样式:圆形或方形 |
| titleMaxLine | int? | - | CheckBox标题的行数 |

```
```

### TCheckbox
#### 默认构造方法

Expand Down Expand Up @@ -53,3 +31,25 @@
| titleColor | Color? | - | 标题文字颜色 |
| titleFont | Font? | - | 标题字体大小 |
| titleMaxLine | int? | - | 标题的行数 |

```
```

### TCheckboxGroup
#### 默认构造方法

| 参数 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| checkedIds | List<String>? | - | 勾选的CheckBox id列表 |
| child | | - | |
| contentDirection | TContentDirection? | - | 文字相对icon的方位 |
| controller | TCheckboxGroupController? | - | 可以通过控制器操作勾选状态 |
| customContentBuilder | ContentBuilder? | - | CheckBox完全自定义内容 |
| customIconBuilder | IconBuilder? | - | 自定义选择icon的样式 |
| key | | - | |
| maxChecked | int? | - | 最多可以勾选多少 |
| onChangeGroup | OnGroupChange? | - | 状态变化监听器 |
| onOverloadChecked | VoidCallback? | - | 超过最大可勾选的个数 |
| spacing | double? | - | CheckBoxicon和文字的距离 |
| style | TCheckboxStyle? | - | CheckBox复选框样式:圆形或方形 |
| titleMaxLine | int? | - | CheckBox标题的行数 |
Loading
Loading