harmony 鸿蒙日历选择器弹窗 (CalendarPickerDialog)

  • 2025-06-12
  • 浏览 (4)

日历选择器弹窗 (CalendarPickerDialog)

点击日期弹出日历选择器弹窗,可选择弹窗内任意日期。

说明:

该组件从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

本模块功能依赖UI的执行上下文,不可在UI上下文不明确的地方使用,参见UIContext说明。

该组件不支持在Wearable设备上使用。

CalendarPickerDialog

show

static show(options?: CalendarDialogOptions)

定义日历选择器弹窗并弹出。

原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
options CalendarDialogOptions 配置日历选择器弹窗参数。

CalendarDialogOptions对象说明

继承自CalendarOptions

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 必填 说明
onAccept Callback<Date> 点击弹窗中的“确定”按钮时触发该回调。
返回选中的日期值。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
onCancel VoidCallback 点击弹窗中的“取消”按钮时触发该回调。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
onChange Callback<Date> 选择弹窗中日期使当前选中项改变时触发该回调。
返回选中的日期值。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
backgroundColor11+ ResourceColor 弹窗背板颜色。
默认值:Color.Transparent
说明:
当设置了backgroundColor为非透明色时,backgroundBlurStyle需要设置为BlurStyle.NONE,否则颜色显示将不符合预期效果。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
backgroundBlurStyle11+ BlurStyle 弹窗背板模糊材质。
默认值:BlurStyle.COMPONENT_ULTRA_THICK
说明:
设置为BlurStyle.NONE即可关闭背景虚化。当设置了backgroundBlurStyle为非NONE值时,则不要设置backgroundColor,否则颜色显示将不符合预期效果。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
backgroundBlurStyleOptions19+ BackgroundBlurStyleOptions 背景模糊效果。
原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。
backgroundEffect19+ BackgroundEffectOptions 背景效果参数。
原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。
acceptButtonStyle12+ PickerDialogButtonStyle 设置确认按钮显示样式、样式和重要程度、角色、背景色、圆角、文本颜色、字号、字体粗细、字体样式、字体列表、按钮是否默认响应Enter键。
说明:
acceptButtonStyle与cancelButtonStyle中最多只能有一个primary字段配置为true,二者primary字段均配置为true时均不生效。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
cancelButtonStyle12+ PickerDialogButtonStyle 设置取消按钮显示样式、样式和重要程度、角色、背景色、圆角、文本颜色、字号、字体粗细、字体样式、字体列表、按钮是否默认响应Enter键。
说明:
acceptButtonStyle与cancelButtonStyle中最多只能有一个primary字段配置为true,二者primary字段均配置为true时均不生效。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
onDidAppear12+ VoidCallback 弹窗弹出时的事件回调。
说明:
1.正常时序依次为:onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。
2.在onDidAppear内设置改变弹窗显示效果的回调事件,二次弹出生效。
3.快速点击弹出,消失弹窗时,存在onWillDisappear在onDidAppear前生效。
4. 当弹窗入场动效未完成时关闭弹窗,该回调不会触发。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
onDidDisappear12+ VoidCallback 弹窗消失时的事件回调。
说明:
1.正常时序依次为:onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
onWillAppear12+ VoidCallback 弹窗显示动效前的事件回调。
说明:
1.正常时序依次为:onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。
2.在onWillAppear内设置改变弹窗显示效果的回调事件,二次弹出生效。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
onWillDisappear12+ VoidCallback 弹窗退出动效前的事件回调。
说明:
1.正常时序依次为:onWillAppear>>onDidAppear>>(onAccept/onCancel/onChange)>>onWillDisappear>>onDidDisappear。
2.快速点击弹出,消失弹窗时,存在onWillDisappear在onDidAppear前生效。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
shadow12+ ShadowOptions&nbsp;|&nbsp;ShadowStyle 设置弹窗背板的阴影。
当设备为2in1时,默认场景下,获焦时阴影值为ShadowStyle.OUTER_FLOATING_MD,失焦时为ShadowStyle.OUTER_FLOATING_SM。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
enableHoverMode14+ boolean 是否响应悬停态。
默认值:false。false表示不响应悬停,true表示响应悬停。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
hoverModeArea14+ HoverModeAreaType 悬停态下弹窗默认展示区域。
默认值:HoverModeAreaType.BOTTOM_SCREEN。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
markToday19+ boolean 设置日历选择器在系统当前日期时,是否保持高亮显示。
默认值:false。true表示日历选择器在系统当前日期时,保持高亮显示。false表示日历选择器在系统当前日期时,不保持高亮显示。
原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

说明:

在应用窗口缩小过程中,弹窗的宽度会被不断压缩,当缩小到一定程度时会导致其内容无法完整显示,保证CalendarPickerDialog内容能够完整显示的最小窗口宽度为386vp。

示例

示例1(设置弹窗背板)

该示例通过backgroundColor、backgroundBlurStyle、shadow设置日历选择器弹窗背板。

// xxx.ets
@Entry
@Component
struct CalendarPickerDialogExample {
  private selectedDate: Date = new Date('2024-04-23');

  build() {
    Column() {
      Button("Show CalendarPicker Dialog")
        .margin(20)
        .onClick(() => {
          console.info("CalendarDialog.show");
          CalendarPickerDialog.show({
            selected: this.selectedDate,
            backgroundColor: Color.Gray,
            backgroundBlurStyle: BlurStyle.NONE,
            shadow: ShadowStyle.OUTER_FLOATING_SM,
            onAccept: (value) => {
              this.selectedDate = value;
              console.info("calendar onAccept:" + JSON.stringify(value));
            },
            onCancel: () => {
              console.info("calendar onCancel");
            },
            onChange: (value) => {
              console.info("calendar onChange:" + JSON.stringify(value));
            },
            onDidAppear: () => {
              console.info("calendar onDidAppear");
            },
            onDidDisappear: () => {
              console.info("calendar onDidDisappear");
            },
            onWillAppear: () => {
              console.info("calendar onWillAppear");
            },
            onWillDisappear: () => {
              console.info("calendar onWillDisappear");
            }
          });
        })
    }.width('100%')
  }
}

CalendarPickerDialog

示例2(自定义按钮样式)

该示例通过配置 acceptButtonStyle、cancelButtonStyle实现自定义日历选择器弹窗按钮样式。

// xxx.ets
@Entry
@Component
struct CalendarPickerDialogExample {
  private selectedDate: Date = new Date();

  build() {
    Column() {
      Button("Show CalendarPicker Dialog")
        .margin(20)
        .onClick(() => {
          console.info("CalendarDialog.show");
          CalendarPickerDialog.show({
            selected: this.selectedDate,
            acceptButtonStyle: {
              type: ButtonType.Normal,
              style: ButtonStyleMode.NORMAL,
              role: ButtonRole.NORMAL,
              fontColor: 'rgb(81, 81, 216)',
              fontSize: '26fp',
              fontWeight: FontWeight.Bolder,
              fontStyle: FontStyle.Normal,
              fontFamily: 'sans-serif',
              backgroundColor: '#A6ACAF',
              borderRadius: 20
            },
            cancelButtonStyle: {
              type: ButtonType.Normal,
              style: ButtonStyleMode.NORMAL,
              role: ButtonRole.NORMAL,
              fontColor: Color.Blue,
              fontSize: '16fp',
              fontWeight: FontWeight.Normal,
              fontStyle: FontStyle.Italic,
              fontFamily: 'sans-serif',
              backgroundColor: '#50182431',
              borderRadius: 10
            },
            onAccept: (value) => {
              this.selectedDate = value;
              console.info("calendar onAccept:" + JSON.stringify(value));
            }
          });
        })
    }.width('100%')
  }
}

CalendarPickerDialog

示例3(悬停态弹窗)

该示例展示了在折叠屏悬停态下设置dialog布局区域的效果。

@Entry
@Component
struct CalendarPickerDialogExample {
  private selectedDate: Date = new Date('2024-04-23');

  build() {
    Column() {
      Button("Show CalendarPicker Dialog")
        .margin(20)
        .onClick(() => {
          console.info("CalendarDialog.show");
          CalendarPickerDialog.show({
            selected: this.selectedDate,
            onAccept: (value) => {
              console.info("calendar onAccept:" + JSON.stringify(value));
            },
            onCancel: () => {
              console.info("calendar onCancel");
            },
            onChange: (value) => {
              console.info("calendar onChange:" + JSON.stringify(value));
            },
            onDidAppear: () => {
              console.info("calendar onDidAppear");
            },
            onDidDisappear: () => {
              console.info("calendar onDidDisappear");
            },
            onWillAppear: () => {
              console.info("calendar onWillAppear");
            },
            onWillDisappear: () => {
              console.info("calendar onWillDisappear");
            },
            enableHoverMode: true,
            hoverModeArea: HoverModeAreaType.TOP_SCREEN,
          });
        })
    }.width('100%')
  }
}

CalendarPickerDialog

示例4(设置日期选中态底板样式)

该示例通过hintRadius设置日期选中态底板样式。

// xxx.ets
@Entry
@Component
struct CalendarPickerDialogExample {
  private selectedDate: Date = new Date('2024-04-23');

  build() {
    Column() {
      Button("Show CalendarPicker Dialog")
        .margin(20)
        .onClick(() => {
          console.info("CalendarDialog.show");
          CalendarPickerDialog.show({
            selected: this.selectedDate,
            hintRadius: 1,
            onAccept: (value) => {
              this.selectedDate = value;
              console.info("calendar onAccept:" + JSON.stringify(value));
            }
          });
        })
    }.width('100%')
  }
}

CalendarPickerDialog

示例5(设置开始日期和结束日期)

该示例通过start和end设置日历选择器弹窗的开始日期和结束日期。

// xxx.ets
@Entry
@Component
struct CalendarPickerDialogExample {
  private selectedDate: Date = new Date('2025-01-01');
  private startDate: Date = new Date('2024-01-10');
  private endDate: Date = new Date('2025-1-10');

  build() {
    Column() {
      Text('月历日期选择器').fontSize(30)
      Button("Show CalendarPicker Dialog")
        .margin(20)
        .onClick(() => {
          console.info("CalendarDialog.show");
          CalendarPickerDialog.show({
            start: this.startDate,
            end: this.endDate,
            selected: this.selectedDate,
          });
        })
    }.width('100%').margin({ top: 350 })
  }
}  

CalendarPickerDialog

示例6(设置日历选择器弹窗在系统当前日期时,保持高亮显示和禁用日期区间)

该示例通过markToday设置日历选择器弹窗在系统当前日期时,开启保持高亮显示,同时,通过disabledDateRange设置日历选择器弹窗的禁用日期区间。

// xxx.ets
@Entry
@Component
struct CalendarPickerExample {
  private disabledDateRange: DateRange[] = [
    { start: new Date('2025-01-01'), end: new Date('2025-01-02') },
    { start: new Date('2025-01-09'), end: new Date('2025-01-10') },
    { start: new Date('2025-01-15'), end: new Date('2025-01-16') },
    { start: new Date('2025-01-19'), end: new Date('2025-01-19') },
    { start: new Date('2025-01-22'), end: new Date('2025-01-25') }
  ];

  build() {
    Column() {
      Button("Show CalendarPicker Dialog")
        .margin(20)
        .onClick(() => {
          console.info("CalendarDialog.show");
          CalendarPickerDialog.show({ markToday: true, disabledDateRange: this.disabledDateRange });
        })
    }.width('100%').margin({ top: 350 })
  }
}

CalendarPickerDialog

你可能感兴趣的鸿蒙文章

harmony 鸿蒙图像AI分析错误码

harmony 鸿蒙ArcButton

harmony 鸿蒙ArcSlider

harmony 鸿蒙Chip

harmony 鸿蒙ChipGroup

harmony 鸿蒙ComposeListItem

harmony 鸿蒙ComposeTitleBar

harmony 鸿蒙advanced.Counter

harmony 鸿蒙弹出框 (Dialog)

harmony 鸿蒙DialogV2

0  赞