1# 日历选择器弹窗 (CalendarPickerDialog) 2<!--Kit: ArkUI--> 3<!--Subsystem: ArkUI--> 4<!--Owner: @luoying_ace_admin--> 5<!--Designer: @weixin_52725220--> 6<!--Tester: @xiong0104--> 7<!--Adviser: @HelloCrease--> 8 9点击日期弹出日历选择器弹窗，可在弹窗内选择日期。 10 11> **说明：** 12> 13> - 该组件从API version 10开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 14> 15> - 本模块功能依赖UI的执行上下文，不可在[UI上下文不明确](../../../ui/arkts-global-interface.md#ui上下文不明确)的地方使用，参见[UIContext](../arkts-apis-uicontext-uicontext.md)说明。 16> 17> - 本模块不支持深浅色模式热更新，如果需要进行深浅色模式切换，请重新打开弹窗。 18 19## CalendarPickerDialog 20 21### show 22 23static show(options?: CalendarDialogOptions): void 24 25定义日历选择器弹窗。 26 27**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 28 29**系统能力：** SystemCapability.ArkUI.ArkUI.Full 30 31**设备行为差异：** 该接口在Wearable设备上使用时，应用程序运行异常，异常信息中提示接口未定义，在其他设备中可正常调用。 32 33**参数：** 34 35| 参数名 | 类型 | 必填 | 说明 | 36| ------- | ------------------------------------------------------- | ---- | -------------------------- | 37| options | [CalendarDialogOptions](#calendardialogoptions对象说明) | 否 | 配置日历选择器弹窗参数。 | 38 39## CalendarDialogOptions对象说明 40 41日历选择器弹窗选项。 42 43继承自[CalendarOptions](ts-basic-components-calendarpicker.md#calendaroptions对象说明)。 44 45**系统能力：** SystemCapability.ArkUI.ArkUI.Full 46 47| 名称 | 类型 | 只读 | 可选 | 说明 | 48| ---------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | ------------------------------------------------------------ | 49| onAccept | [Callback](ts-types.md#callback12)\<Date> | 否 | 是 | 点击弹窗中的“确定”按钮时触发该回调。<br/>回调函数的参数表示选中的日期值。<br />**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 50| onCancel | [VoidCallback](ts-types.md#voidcallback12) | 否 | 是 | 点击弹窗中的“取消”按钮时触发该回调。<br />**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 51| onChange | [Callback](ts-types.md#callback12)\<Date> | 否 | 是 | 选择弹窗中日期使当前选中项改变时触发该回调。<br/>回调函数的参数表示选中的日期值。<br />**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 52| backgroundColor<sup>11+</sup> | [ResourceColor](ts-types.md#resourcecolor) | 否 | 是 | 弹窗背板颜色。<br/>默认值：Color.Transparent<br/>**说明：** <br/>当设置了backgroundColor为非透明色时，backgroundBlurStyle需要设置为BlurStyle.NONE，否则显示的颜色将不符合预期效果。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 53| backgroundBlurStyle<sup>11+</sup> | [BlurStyle](ts-universal-attributes-background.md#blurstyle9) | 否 | 是 | 弹窗背板模糊材质。<br/>默认值：BlurStyle.COMPONENT_ULTRA_THICK<br/>**说明：** <br/>设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时，则不要设置backgroundColor，否则显示的颜色将不符合预期效果。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 54| backgroundBlurStyleOptions<sup>19+</sup> | [BackgroundBlurStyleOptions](ts-universal-attributes-background.md#backgroundblurstyleoptions10对象说明) | 否 | 是 | 背景模糊效果。<br />**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 | 55| backgroundEffect<sup>19+</sup> | [BackgroundEffectOptions](ts-universal-attributes-background.md#backgroundeffectoptions11) | 否 | 是 | 背景效果参数。<br />**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 | 56| acceptButtonStyle<sup>12+</sup> | [PickerDialogButtonStyle](ts-picker-common.md#pickerdialogbuttonstyle12对象说明) | 否 | 是 | 设置确认按钮显示样式、样式和重要程度、角色、背景色、圆角、文本颜色、字号、字体粗细、字体样式、字体列表、按钮是否默认响应Enter键。<br />**说明：**<br />acceptButtonStyle与cancelButtonStyle中最多只能有一个primary字段配置为true，二者primary字段均配置为true时均不生效。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 57| cancelButtonStyle<sup>12+</sup> | [PickerDialogButtonStyle](ts-picker-common.md#pickerdialogbuttonstyle12对象说明) | 否 | 是 | 设置取消按钮显示样式、样式和重要程度、角色、背景色、圆角、文本颜色、字号、字体粗细、字体样式、字体列表、按钮是否默认响应Enter键。<br />**说明：**<br />acceptButtonStyle与cancelButtonStyle中最多只能有一个primary字段配置为true，二者primary字段均配置为true时均不生效。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 58| onDidAppear<sup>12+</sup> | [VoidCallback](ts-types.md#voidcallback12) | 否 | 是 | 弹窗弹出时的事件回调。<br />**说明：**<br />1.正常时序依次为：onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。<br />2.在onDidAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。<br />3.快速点击弹出，消失弹窗时，存在onWillDisappear在onDidAppear前生效。<br />4. 当弹窗入场动效未完成时关闭弹窗，该回调不会触发。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 59| onDidDisappear<sup>12+</sup> | [VoidCallback](ts-types.md#voidcallback12) | 否 | 是 | 弹窗消失时的事件回调。<br />**说明：**<br />1.正常时序依次为：onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 60| onWillAppear<sup>12+</sup> | [VoidCallback](ts-types.md#voidcallback12) | 否 | 是 | 弹窗显示动效前的事件回调。<br />**说明：**<br />1.正常时序依次为：onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。<br />2.在onWillAppear内设置改变弹窗显示效果的回调事件，二次弹出生效。 <br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 61| onWillDisappear<sup>12+</sup> | [VoidCallback](ts-types.md#voidcallback12) | 否 | 是 | 弹窗退出动效前的事件回调。<br />**说明：**<br />1.正常时序依次为：onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。<br />2.快速点击弹出，消失弹窗时，存在onWillDisappear在onDidAppear前生效。 <br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 62| shadow<sup>12+</sup> | [ShadowOptions](ts-universal-attributes-image-effect.md#shadowoptions对象说明) \| [ShadowStyle](ts-universal-attributes-image-effect.md#shadowstyle10枚举说明) | 否 | 是 | 设置弹窗背板的阴影。<br /> 当设备为2in1时，默认场景下，获焦时阴影值为ShadowStyle.OUTER_FLOATING_MD，失焦时为ShadowStyle.OUTER_FLOATING_SM。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 63| enableHoverMode<sup>14+</sup> | boolean | 否 | 是 | 是否响应悬停态。<br />- true：响应悬停态。<br/>- false：不响应悬停态。<br/>默认值：false<br/>**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。| 64| hoverModeArea<sup>14+</sup> | [HoverModeAreaType](ts-universal-attributes-sheet-transition.md#hovermodeareatype14) | 否 | 是 | 悬停态下弹窗默认展示区域。<br />默认值：HoverModeAreaType.BOTTOM_SCREEN。<br/>**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。| 65| markToday<sup>19+</sup> | boolean | 否 | 是 | 设置日历选择器弹窗中系统当前日期是否保持高亮显示。<br/>- true：系统当前日期在日历选择器弹窗内保持高亮显示。<br/>- false：系统当前日期在日历选择器弹窗内不保持高亮显示。<br/>默认值：false<br/>**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 | 66 67> **说明：** 68> 69> 在应用窗口缩小过程中，弹窗的宽度会被不断压缩，当缩小到一定程度时会导致其内容无法完整显示，保证CalendarPickerDialog内容能够完整显示的最小窗口宽度为386vp。 70 71## 示例 72 73### 示例1（设置弹窗背板） 74 75该示例通过[CalendarDialogOptions](#calendardialogoptions对象说明)的backgroundColor、backgroundBlurStyle、shadow设置日历选择器弹窗背板。 76 77```ts 78// xxx.ets 79@Entry 80@Component 81struct CalendarPickerDialogExample { 82 private selectedDate: Date = new Date('2024-04-23'); 83 84 build() { 85 Column() { 86 Button("Show CalendarPicker Dialog") 87 .margin(20) 88 .onClick(() => { 89 console.info("CalendarDialog.show"); 90 CalendarPickerDialog.show({ 91 selected: this.selectedDate, 92 backgroundColor: Color.Gray, 93 backgroundBlurStyle: BlurStyle.NONE, 94 shadow: ShadowStyle.OUTER_FLOATING_SM, 95 onAccept: (value) => { 96 this.selectedDate = value; 97 console.info("calendar onAccept:" + JSON.stringify(value)); 98 }, 99 onCancel: () => { 100 console.info("calendar onCancel"); 101 }, 102 onChange: (value) => { 103 console.info("calendar onChange:" + JSON.stringify(value)); 104 }, 105 onDidAppear: () => { 106 console.info("calendar onDidAppear"); 107 }, 108 onDidDisappear: () => { 109 console.info("calendar onDidDisappear"); 110 }, 111 onWillAppear: () => { 112 console.info("calendar onWillAppear"); 113 }, 114 onWillDisappear: () => { 115 console.info("calendar onWillDisappear"); 116 } 117 }); 118 }) 119 }.width('100%') 120 } 121} 122``` 123 124 125 126### 示例2（自定义按钮样式） 127 128该示例通过配置[CalendarDialogOptions](#calendardialogoptions对象说明)的acceptButtonStyle、cancelButtonStyle实现自定义日历选择器弹窗按钮样式。 129 130```ts 131// xxx.ets 132@Entry 133@Component 134struct CalendarPickerDialogExample { 135 private selectedDate: Date = new Date(); 136 137 build() { 138 Column() { 139 Button("Show CalendarPicker Dialog") 140 .margin(20) 141 .onClick(() => { 142 console.info("CalendarDialog.show"); 143 CalendarPickerDialog.show({ 144 selected: this.selectedDate, 145 acceptButtonStyle: { 146 type: ButtonType.Normal, 147 style: ButtonStyleMode.NORMAL, 148 role: ButtonRole.NORMAL, 149 fontColor: 'rgb(81, 81, 216)', 150 fontSize: '26fp', 151 fontWeight: FontWeight.Bolder, 152 fontStyle: FontStyle.Normal, 153 fontFamily: 'sans-serif', 154 backgroundColor: '#A6ACAF', 155 borderRadius: 20 156 }, 157 cancelButtonStyle: { 158 type: ButtonType.Normal, 159 style: ButtonStyleMode.NORMAL, 160 role: ButtonRole.NORMAL, 161 fontColor: Color.Blue, 162 fontSize: '16fp', 163 fontWeight: FontWeight.Normal, 164 fontStyle: FontStyle.Italic, 165 fontFamily: 'sans-serif', 166 backgroundColor: '#50182431', 167 borderRadius: 10 168 }, 169 onAccept: (value) => { 170 this.selectedDate = value; 171 console.info("calendar onAccept:" + JSON.stringify(value)); 172 } 173 }); 174 }) 175 }.width('100%') 176 } 177} 178``` 179 180 181 182### 示例3（悬停态弹窗） 183 184该示例展示了在折叠屏悬停态下设置dialog布局区域的效果。 185 186```ts 187@Entry 188@Component 189struct CalendarPickerDialogExample { 190 private selectedDate: Date = new Date('2024-04-23'); 191 192 build() { 193 Column() { 194 Button("Show CalendarPicker Dialog") 195 .margin(20) 196 .onClick(() => { 197 console.info("CalendarDialog.show"); 198 CalendarPickerDialog.show({ 199 selected: this.selectedDate, 200 onAccept: (value) => { 201 console.info("calendar onAccept:" + JSON.stringify(value)); 202 }, 203 onCancel: () => { 204 console.info("calendar onCancel"); 205 }, 206 onChange: (value) => { 207 console.info("calendar onChange:" + JSON.stringify(value)); 208 }, 209 onDidAppear: () => { 210 console.info("calendar onDidAppear"); 211 }, 212 onDidDisappear: () => { 213 console.info("calendar onDidDisappear"); 214 }, 215 onWillAppear: () => { 216 console.info("calendar onWillAppear"); 217 }, 218 onWillDisappear: () => { 219 console.info("calendar onWillDisappear"); 220 }, 221 enableHoverMode: true, 222 hoverModeArea: HoverModeAreaType.TOP_SCREEN, 223 }); 224 }) 225 }.width('100%') 226 } 227} 228``` 229 230 231 232### 示例4（设置日期选中态底板样式） 233 234该示例通过[CalendarOptions](ts-basic-components-calendarpicker.md#calendaroptions对象说明)的hintRadius设置日期选中态底板样式。 235 236```ts 237// xxx.ets 238@Entry 239@Component 240struct CalendarPickerDialogExample { 241 private selectedDate: Date = new Date('2024-04-23'); 242 243 build() { 244 Column() { 245 Button("Show CalendarPicker Dialog") 246 .margin(20) 247 .onClick(() => { 248 console.info("CalendarDialog.show"); 249 CalendarPickerDialog.show({ 250 selected: this.selectedDate, 251 hintRadius: 1, 252 onAccept: (value) => { 253 this.selectedDate = value; 254 console.info("calendar onAccept:" + JSON.stringify(value)); 255 } 256 }); 257 }) 258 }.width('100%') 259 } 260} 261``` 262 263 264 265### 示例5（设置开始日期和结束日期） 266 267该示例通过[CalendarOptions](ts-basic-components-calendarpicker.md#calendaroptions对象说明)的start和end设置日历选择器弹窗的开始日期和结束日期。 268 269```ts 270// xxx.ets 271@Entry 272@Component 273struct CalendarPickerDialogExample { 274 private selectedDate: Date = new Date('2025-01-01'); 275 private startDate: Date = new Date('2024-01-10'); 276 private endDate: Date = new Date('2025-1-10'); 277 278 build() { 279 Column() { 280 Text('月历日期选择器').fontSize(30) 281 Button("Show CalendarPicker Dialog") 282 .margin(20) 283 .onClick(() => { 284 console.info("CalendarDialog.show"); 285 CalendarPickerDialog.show({ 286 start: this.startDate, 287 end: this.endDate, 288 selected: this.selectedDate, 289 }); 290 }) 291 }.width('100%').margin({ top: 350 }) 292 } 293} 294``` 295 296 297 298### 示例6（设置系统当前日期在日历选择器弹窗内保持高亮显示，并设置禁用日期区间） 299 300该示例通过配置[CalendarDialogOptions](#calendardialogoptions对象说明)的markToday，使系统当前日期在日历选择器弹窗内保持高亮显示，并通过配置[CalendarOptions](ts-basic-components-calendarpicker.md#calendaroptions对象说明)的disabledDateRange设置禁用的日期区间。 301 302```ts 303// xxx.ets 304@Entry 305@Component 306struct CalendarPickerExample { 307 private disabledDateRange: DateRange[] = [ 308 { start: new Date('2025-01-01'), end: new Date('2025-01-02') }, 309 { start: new Date('2025-01-09'), end: new Date('2025-01-10') }, 310 { start: new Date('2025-01-15'), end: new Date('2025-01-16') }, 311 { start: new Date('2025-01-19'), end: new Date('2025-01-19') }, 312 { start: new Date('2025-01-22'), end: new Date('2025-01-25') } 313 ]; 314 315 build() { 316 Column() { 317 Button("Show CalendarPicker Dialog") 318 .margin(20) 319 .onClick(() => { 320 console.info("CalendarDialog.show"); 321 CalendarPickerDialog.show({ markToday: true, disabledDateRange: this.disabledDateRange }); 322 }) 323 }.width('100%').margin({ top: 350 }) 324 } 325} 326``` 327 328 329 330### 示例7（自定义背景模糊效果参数） 331 332从API version 19开始，该示例通过配置[backgroundBlurStyleOptions](#calendardialogoptions对象说明)，实现自定义背景模糊效果。 333 334```ts 335@Entry 336@Component 337struct CalendarPickerDialogExample { 338 private selectedDate: Date = new Date('2025-08-05'); 339 340 build() { 341 Stack({ alignContent: Alignment.Top }) { 342 Image($r('app.media.bg')) 343 Column() { 344 Button("Show CalendarPicker Dialog") 345 .margin(20) 346 .onClick(() => { 347 CalendarPickerDialog.show({ 348 selected: this.selectedDate, 349 hintRadius: 1, 350 backgroundColor: undefined, 351 backgroundBlurStyle: BlurStyle.Thin, 352 backgroundBlurStyleOptions: { 353 colorMode: ThemeColorMode.LIGHT, 354 adaptiveColor: AdaptiveColor.AVERAGE, 355 scale: 1, 356 blurOptions: { grayscale: [20, 20] }, 357 }, 358 }); 359 }) 360 }.width('100%') 361 } 362 } 363} 364``` 365 366 367 368### 示例8（自定义背景效果参数） 369 370从API version 19开始，该示例通过配置[backgroundEffect](#calendardialogoptions对象说明)，实现自定义背景效果。 371 372```ts 373@Entry 374@Component 375struct CalendarPickerDialogExample { 376 private selectedDate: Date = new Date('2025-08-05'); 377 378 build() { 379 Stack({ alignContent: Alignment.Top }) { 380 Image($r('app.media.bg')) 381 Column() { 382 Button("Show CalendarPicker Dialog") 383 .margin(20) 384 .onClick(() => { 385 CalendarPickerDialog.show({ 386 selected: this.selectedDate, 387 hintRadius: 1, 388 backgroundColor: undefined, 389 backgroundBlurStyle: BlurStyle.Thin, 390 backgroundEffect: { 391 radius: 60, 392 saturation: 0, 393 brightness: 1, 394 color: Color.White, 395 blurOptions: { grayscale: [20, 20] } 396 }, 397 }); 398 }) 399 }.width('100%') 400 } 401 } 402} 403``` 404 405
