|
1 | 1 | ## API |
2 | | -### TDCalendarPopup |
| 2 | +### TDCalendar |
3 | 3 | #### 默认构造方法 |
4 | 4 |
|
5 | 5 | | 参数 | 类型 | 默认值 | 说明 | |
6 | 6 | | --- | --- | --- | --- | |
7 | | -| context | BuildContext | context | 上下文 | |
8 | | -| top | double? | - | 距离顶部的距离 | |
9 | | -| autoClose | bool? | true | 自动关闭;在点击关闭按钮、确认按钮、遮罩层时自动关闭 | |
10 | | -| confirmBtn | Widget? | - | 自定义确认按钮 | |
11 | | -| visible | bool? | - | 默认是否显示日历 | |
12 | | -| onClose | VoidCallback? | - | 关闭时触发 | |
13 | | -| onConfirm | void Function(List<int> value)? | - | 点击确认按钮时触发 | |
14 | | -| builder | CalendarBuilder? | - | 控件构建器,优先级高于[child] | |
15 | | -| child | TDCalendar? | - | 日历控件 | |
| 7 | +| key | | - | | |
| 8 | +| firstDayOfWeek | int? | 0 | 第一天从星期几开始,默认 0 = 周日 | |
| 9 | +| format | CalendarFormat? | - | 用于格式化日期的函数,可定义日期前后的显示内容和日期样式 | |
| 10 | +| maxDate | int? | - | 最大可选的日期(fromMillisecondsSinceEpoch),不传则默认半年后 | |
| 11 | +| minDate | int? | - | 最小可选的日期(fromMillisecondsSinceEpoch),不传则默认今天 | |
| 12 | +| title | String? | - | 标题 | |
| 13 | +| titleWidget | Widget? | - | 标题组件 | |
| 14 | +| type | CalendarType? | CalendarType.single | 日历的选择类型,single = 单选;multiple = 多选; range = 区间选择 | |
| 15 | +| value | List<int>? | - | 当前选择的日期(fromMillisecondsSinceEpoch),不传则默认今天,当 type = single 时数组长度为1 | |
| 16 | +| displayFormat | String? | 'year month' | 年月显示格式,`year`表示年,`month`表示月,如`year month`表示年在前、月在后、中间隔一个空格 | |
| 17 | +| cellHeight | double? | 60 | 日期高度 | |
| 18 | +| height | double? | - | 高度 | |
| 19 | +| width | double? | - | 宽度 | |
| 20 | +| style | TDCalendarStyle? | - | 自定义样式 | |
| 21 | +| onChange | void Function(List<int> value)? | - | 选中值变化时触发 | |
| 22 | +| onCellClick | void Function(int value, DateSelectType type, TDate tdate)? | - | 点击日期时触发 | |
| 23 | +| onCellLongPress | void Function(int value, DateSelectType type, TDate tdate)? | - | 长安日期时触发 | |
| 24 | +| onHeaderClick | void Function(int index, String week)? | - | 点击周时触发 | |
| 25 | +| useTimePicker | bool? | false | 是否显示时间选择器 | |
| 26 | +| timePickerModel | List<DatePickerModel>? | - | 自定义时间选择器 | |
| 27 | +| monthTitleHeight | double? | 22 | 月标题高度 | |
| 28 | +| monthTitleBuilder | Widget Function(BuildContext context, DateTime monthDate)? | - | 月标题构建器 | |
| 29 | +| pickerHeight | double? | 178 | 时间选择器List的视窗高度 | |
| 30 | +| pickerItemCount | int? | 3 | 选择器List视窗中item个数,pickerHeight / pickerItemCount即item高度 | |
| 31 | +| isTimeUnit | bool? | true | 是否显示时间单位 | |
| 32 | +| animateTo | bool? | false | 动画滚动到指定位置 | |
| 33 | +| cellWidget | Widget? Function(BuildContext context, TDate tdate, DateSelectType selectType)? | - | 自定义日期单元格组件 | |
16 | 34 |
|
17 | 35 | ``` |
18 | 36 | ``` |
|
43 | 61 |
|
44 | 62 | ``` |
45 | 63 | ``` |
46 | | - ### TDCalendar |
| 64 | + ### TDCalendarPopup |
47 | 65 | #### 默认构造方法 |
48 | 66 |
|
49 | 67 | | 参数 | 类型 | 默认值 | 说明 | |
50 | 68 | | --- | --- | --- | --- | |
51 | | -| key | | - | | |
52 | | -| firstDayOfWeek | int? | 0 | 第一天从星期几开始,默认 0 = 周日 | |
53 | | -| format | CalendarFormat? | - | 用于格式化日期的函数,可定义日期前后的显示内容和日期样式 | |
54 | | -| maxDate | int? | - | 最大可选的日期(fromMillisecondsSinceEpoch),不传则默认半年后 | |
55 | | -| minDate | int? | - | 最小可选的日期(fromMillisecondsSinceEpoch),不传则默认今天 | |
56 | | -| title | String? | - | 标题 | |
57 | | -| titleWidget | Widget? | - | 标题组件 | |
58 | | -| type | CalendarType? | CalendarType.single | 日历的选择类型,single = 单选;multiple = 多选; range = 区间选择 | |
59 | | -| value | List<int>? | - | 当前选择的日期(fromMillisecondsSinceEpoch),不传则默认今天,当 type = single 时数组长度为1 | |
60 | | -| displayFormat | String? | 'year month' | 年月显示格式,`year`表示年,`month`表示月,如`year month`表示年在前、月在后、中间隔一个空格 | |
61 | | -| cellHeight | double? | 60 | 日期高度 | |
62 | | -| height | double? | - | 高度 | |
63 | | -| width | double? | - | 宽度 | |
64 | | -| style | TDCalendarStyle? | - | 自定义样式 | |
65 | | -| onChange | void Function(List<int> value)? | - | 选中值变化时触发 | |
66 | | -| onCellClick | void Function(int value, DateSelectType type, TDate tdate)? | - | 点击日期时触发 | |
67 | | -| onCellLongPress | void Function(int value, DateSelectType type, TDate tdate)? | - | 长安日期时触发 | |
68 | | -| onHeaderClick | void Function(int index, String week)? | - | 点击周时触发 | |
69 | | -| useTimePicker | bool? | false | 是否显示时间选择器 | |
70 | | -| timePickerModel | List<DatePickerModel>? | - | 自定义时间选择器 | |
71 | | -| monthTitleHeight | double? | 22 | 月标题高度 | |
72 | | -| monthTitleBuilder | Widget Function(BuildContext context, DateTime monthDate)? | - | 月标题构建器 | |
73 | | -| pickerHeight | double? | 178 | 时间选择器List的视窗高度 | |
74 | | -| pickerItemCount | int? | 3 | 选择器List视窗中item个数,pickerHeight / pickerItemCount即item高度 | |
75 | | -| isTimeUnit | bool? | true | 是否显示时间单位 | |
76 | | -| animateTo | bool? | false | 动画滚动到指定位置 | |
77 | | -| cellWidget | Widget? Function(BuildContext context, TDate tdate, DateSelectType selectType)? | - | 自定义日期单元格组件 | |
| 69 | +| context | BuildContext | context | 上下文 | |
| 70 | +| top | double? | - | 距离顶部的距离 | |
| 71 | +| autoClose | bool? | true | 自动关闭;在点击关闭按钮、确认按钮、遮罩层时自动关闭 | |
| 72 | +| confirmBtn | Widget? | - | 自定义确认按钮 | |
| 73 | +| visible | bool? | - | 默认是否显示日历 | |
| 74 | +| onClose | VoidCallback? | - | 关闭时触发 | |
| 75 | +| onConfirm | void Function(List<int> value)? | - | 点击确认按钮时触发 | |
| 76 | +| builder | CalendarBuilder? | - | 控件构建器,优先级高于[child] | |
| 77 | +| child | TDCalendar? | - | 日历控件 | |
0 commit comments