1# 日历选择器弹窗 (CalendarPickerDialog)
2
3点击日期弹出日历选择器弹窗,可选择弹窗内任意日期。
4
5> **说明:**
6>
7> 该组件从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9> 本模块功能依赖UI的执行上下文,不可在UI上下文不明确的地方使用,参见[UIContext](../js-apis-arkui-UIContext.md#uicontext)说明。
10
11## CalendarPickerDialog
12
13### show
14
15static show(options?: CalendarDialogOptions)
16
17定义日历选择器弹窗并弹出。
18
19**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
20
21**系统能力:** SystemCapability.ArkUI.ArkUI.Full
22
23**参数:**
24
25| 参数名  | 类型                                                    | 必填 | 说明                       |
26| ------- | ------------------------------------------------------- | ---- | -------------------------- |
27| options | [CalendarDialogOptions](#calendardialogoptions对象说明) | 否   | 配置日历选择器弹窗的参数。 |
28
29## CalendarDialogOptions对象说明
30
31继承自[CalendarOptions](ts-basic-components-calendarpicker.md#calendaroptions对象说明)。
32
33**系统能力:** SystemCapability.ArkUI.ArkUI.Full
34
35| 名称       | 类型                                            | 必填 | 说明                                                        |
36| ---------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
37| onAccept   | [Callback](ts-types.md#callback12)\<Date> | 否   | 点击弹窗中的“确定”按钮时触发该回调。<br/>返回选中的日期值。<br />**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 |
38| onCancel   | [VoidCallback](ts-types.md#voidcallback12) | 否   | 点击弹窗中的“取消”按钮时触发该回调。<br />**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。                         |
39| onChange   | [Callback](ts-types.md#callback12)\<Date> | 否   | 选择弹窗中日期使当前选中项改变时触发该回调。<br/>返回选中的日期值。<br />**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 |
40| backgroundColor<sup>11+</sup> | [ResourceColor](ts-types.md#resourcecolor)  | 否 | 弹窗背板颜色。<br/>默认值:Color.Transparent<br/>**说明:** <br/>当设置了backgroundColor为非透明色时,backgroundBlurStyle需要设置为BlurStyle.NONE,否则颜色显示将不符合预期效果。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
41| 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开始,该接口支持在原子化服务中使用。 |
42| acceptButtonStyle<sup>12+</sup> | [PickerDialogButtonStyle](ts-methods-datepicker-dialog.md#pickerdialogbuttonstyle12类型说明) | 否 | 设置确认按钮显示样式、样式和重要程度、角色、背景色、圆角、文本颜色、字号、字体粗细、字体样式、字体列表、按钮是否默认响应Enter键。<br />**说明:**<br />acceptButtonStyle与cancelButtonStyle中最多只能有一个primary字段配置为true,二者primary字段均配置为true时均不生效。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
43| cancelButtonStyle<sup>12+</sup> | [PickerDialogButtonStyle](ts-methods-datepicker-dialog.md#pickerdialogbuttonstyle12类型说明) | 否 | 设置取消按钮显示样式、样式和重要程度、角色、背景色、圆角、文本颜色、字号、字体粗细、字体样式、字体列表、按钮是否默认响应Enter键。<br />**说明:**<br />acceptButtonStyle与cancelButtonStyle中最多只能有一个primary字段配置为true,二者primary字段均配置为true时均不生效。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
44| 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开始,该接口支持在原子化服务中使用。 |
45| onDidDisappear<sup>12+</sup> | [VoidCallback](ts-types.md#voidcallback12) | 否 | 弹窗消失时的事件回调。<br />**说明:**<br />1.正常时序依次为:onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
46| 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开始,该接口支持在原子化服务中使用。|
47| 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开始,该接口支持在原子化服务中使用。|
48| shadow<sup>12+</sup>              | [ShadowOptions](ts-universal-attributes-image-effect.md#shadowoptions对象说明)&nbsp;\|&nbsp;[ShadowStyle](ts-universal-attributes-image-effect.md#shadowstyle10枚举说明) | 否   | 设置弹窗背板的阴影。<br /> 当设备为2in1时,默认场景下获焦阴影值为ShadowStyle.OUTER_FLOATING_MD,失焦为ShadowStyle.OUTER_FLOATING_SM                 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
49| enableHoverMode<sup>14+</sup>     | boolean | 否   | 是否响应悬停态。<br />默认值:false,默认不响应。<br/>**原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。|
50| hoverModeArea<sup>14+</sup>       | [HoverModeAreaType](ts-appendix-enums.md#hovermodeareatype14) | 否   | 悬停态下弹窗默认展示区域。<br />默认值:HoverModeAreaType.BOTTOM_SCREEN。<br/>**原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。|
51
52## 示例
53
54### 示例1(弹出日历选择弹窗)
55
56该示例通过点击按钮弹出日历选择弹窗。
57
58```ts
59// xxx.ets
60@Entry
61@Component
62struct CalendarPickerDialogExample {
63  private selectedDate: Date = new Date('2024-04-23')
64
65  build() {
66    Column() {
67      Button("Show CalendarPicker Dialog")
68        .margin(20)
69        .onClick(() => {
70          console.info("CalendarDialog.show")
71          CalendarPickerDialog.show({
72            selected: this.selectedDate,
73            onAccept: (value) => {
74              console.info("calendar onAccept:" + JSON.stringify(value))
75            },
76            onCancel: () => {
77              console.info("calendar onCancel")
78            },
79            onChange: (value) => {
80              console.info("calendar onChange:" + JSON.stringify(value))
81            },
82            onDidAppear: () => {
83              console.info("calendar onDidAppear")
84            },
85            onDidDisappear: () => {
86              console.info("calendar onDidDisappear")
87            },
88            onWillAppear: () => {
89              console.info("calendar onWillAppear")
90            },
91            onWillDisappear: () => {
92              console.info("calendar onWillDisappear")
93            }
94          })
95        })
96    }.width('100%')
97  }
98}
99```
100
101![CalendarPickerDialog](figures/CalendarPickerDialog.gif)
102
103### 示例2(自定义按钮样式)
104
105该示例通过配置 acceptButtonStyle、cancelButtonStyle实现自定义按钮样式。
106
107```ts
108// xxx.ets
109@Entry
110@Component
111struct CalendarPickerDialogExample {
112  private selectedDate: Date = new Date()
113  build() {
114    Column() {
115      Button("Show CalendarPicker Dialog")
116        .margin(20)
117        .onClick(() => {
118          console.info("CalendarDialog.show")
119          CalendarPickerDialog.show({
120            selected: this.selectedDate,
121            acceptButtonStyle: { type: ButtonType.Normal, style: ButtonStyleMode.NORMAL, role: ButtonRole.NORMAL, fontColor: Color.Red,
122              fontSize: '26fp', fontWeight: FontWeight.Bolder, fontStyle: FontStyle.Normal, fontFamily: 'sans-serif', backgroundColor:'#80834511',
123              borderRadius: 20 },
124            cancelButtonStyle: { type: ButtonType.Normal, style: ButtonStyleMode.NORMAL, role: ButtonRole.NORMAL, fontColor: Color.Blue,
125              fontSize: '16fp', fontWeight: FontWeight.Normal, fontStyle: FontStyle.Italic, fontFamily: 'sans-serif', backgroundColor:'#50182431',
126              borderRadius: 10 },
127            onAccept: (value) => {
128              console.info("calendar onAccept:" + JSON.stringify(value))
129            },
130            onCancel: () => {
131              console.info("calendar onCancel")
132            },
133            onChange: (value) => {
134              console.info("calendar onChange:" + JSON.stringify(value))
135            },
136            onDidAppear: () => {
137              console.info("calendar onDidAppear")
138            },
139            onDidDisappear: () => {
140              console.info("calendar onDidDisappear")
141            },
142            onWillAppear: () => {
143              console.info("calendar onWillAppear")
144            },
145            onWillDisappear: () => {
146              console.info("calendar onWillDisappear")
147            }
148          })
149        })
150    }.width('100%')
151  }
152}
153```
154
155![CalendarPickerDialog](figures/CalendarPickerDialog_CustomButton.png)
156
157### 示例3(悬停态弹窗)
158
159该示例展示了在折叠屏悬停态下设置dialog布局区域的效果。
160
161```ts
162@Entry
163@Component
164struct CalendarPickerDialogExample {
165  private selectedDate: Date = new Date('2024-04-23');
166
167  build() {
168    Column() {
169      Button("Show CalendarPicker Dialog")
170        .margin(20)
171        .onClick(() => {
172          console.info("CalendarDialog.show")
173          CalendarPickerDialog.show({
174            selected: this.selectedDate,
175            onAccept: (value) => {
176              console.info("calendar onAccept:" + JSON.stringify(value))
177            },
178            onCancel: () => {
179              console.info("calendar onCancel")
180            },
181            onChange: (value) => {
182              console.info("calendar onChange:" + JSON.stringify(value))
183            },
184            onDidAppear: () => {
185              console.info("calendar onDidAppear")
186            },
187            onDidDisappear: () => {
188              console.info("calendar onDidDisappear")
189            },
190            onWillAppear: () => {
191              console.info("calendar onWillAppear")
192            },
193            onWillDisappear: () => {
194              console.info("calendar onWillDisappear")
195            },
196            enableHoverMode: true,
197            hoverModeArea: HoverModeAreaType.TOP_SCREEN,
198          })
199        })
200    }.width('100%')
201  }
202}
203```
204
205![CalendarPickerDialog](figures/CalendarPickerDialog_HoverMode.gif)