跳到主要内容
版本:v8

ion-datetime

shadow

日期时间组件提供一个日历界面和时间滚轮,使用户可以轻松选择日期和时间。日期时间组件类似于原生 datetime-local 类型的 input 元素,但 Ionic Framework 的 Datetime 组件可以轻松地以首选格式显示日期和时间,并管理日期时间值。

概述

从历史上看,在 JavaScript 或 HTML 输入中处理日期时间值一直是一项挑战。具体来说,JavaScript 的 Date 对象在正确解析日期时间字符串或格式化日期时间值方面非常困难。更糟糕的是,不同浏览器和 JavaScript 版本对各种日期时间字符串的解析方式不同,尤其是在不同语言环境下。

幸运的是,Ionic Framework 的日期时间输入组件经过精心设计,使开发人员可以避免常见的陷阱,轻松操作日期时间值,并为用户提供简单易用的日期时间选择器,以获得良好的用户体验。

ISO 8601 日期时间格式: YYYY-MM-DDTHH:mmZ

Ionic Framework 使用 ISO 8601 日期时间格式 作为其值。该值是一个简单的字符串,而不是使用 JavaScript 的 Date 对象。使用 ISO 日期时间格式可以方便地在 JSON 对象和数据库中进行序列化和解析。

以下是一些可用于 ion-datetime 的 ISO 8601 格式示例:

描述格式日期时间值示例
YearYYYY1994
Year and MonthYYYY-MM1994-12
Complete DateYYYY-MM-DD1994-12-15
Date and TimeYYYY-MM-DDTHH:mm1994-12-15T13:47
UTC TimezoneYYYY-MM-DDTHH:mm:ssZ1994-12-15T13:47:20Z
Timezone OffsetYYYY-MM-DDTHH:mm:ssTZD1994-12-15T13:47:20+05:00
Hour and MinuteHH:mm13:47

注意年份始终为四位数字,毫秒(如果添加)始终为三位数字,所有其他字段始终为两位数字。因此,表示一月的数字始终带有前导零,例如 01。此外,小时始终采用 24 小时制,因此 00 表示 12 小时制中的 12am13 表示 1pm23 表示 11pm

备注

虽然可以使用 ISO 8601 日期时间格式指定秒、毫秒和时区,但 ion-datetime 不提供秒、毫秒和时区选择的界面。提供的任何秒、毫秒或时区值都将被忽略。

基本用法

与 Datetime Button 配合使用

如果需要在模态框或弹出框等覆盖层中展示日期时间,我们建议使用 ion-datetime-button。当空间受限时,应使用 ion-datetime-button。该组件显示当前日期和时间值的按钮。点击按钮时,日期或时间选择器会在覆盖层中打开。

异步设置值

如果在其 value 已被创建后通过编程方式更新,日期时间组件会自动跳转到新的日期。但是,建议避免在用户与日期时间组件交互时以这种方式更新 value,因为这可能会让正在尝试选择日期的用户感到困惑。例如,如果日期时间组件的 value 是通过异步过程加载的,建议在值更新完成之前使用 CSS 隐藏该日期时间组件。

日期约束

最大值和最小值日期

要自定义最小和最大日期时间值,可以提供 minmax 组件属性,这些属性可能更适合应用的使用场景。遵循上表中列出的 ISO 8601 格式,每个组件可以限制用户可以选择哪些日期。

以下示例将日期选择限制为仅 2022 年 3 月到 2022 年 5 月。

选择特定值

minmax 属性允许将日期选择限制在特定范围内,而 monthValuesdayValuesyearValueshourValuesminuteValues 属性允许选择用户可以选择的特定日期和时间。

以下示例允许以 15 分钟为增量选择分钟,也允许以 5 天为增量选择日期。

高级日期约束

使用 isDateEnabled 属性,开发人员可以自定义 ion-datetime,使用 ISO 8601 日期字符串禁用特定日期、日期范围、周末或任何自定义规则。 isDateEnabled 属性接受一个返回布尔值的函数,指示日期是否启用。该函数为每个渲染的日历日调用,包括上个月、当前月和下个月。自定义实现应针对性能进行优化,以避免卡顿。

以下示例展示了如何禁用所有周末日期。对于更高级的日期操作,我们建议使用 date-fns 等日期工具库。

本地化

Ionic Framework 利用 Intl.DatetimeFormat Web API,该 API 允许我们根据用户设备上设置的语言和区域自动本地化月份和日期名称。

自定义区域设置

如果需要特定的区域设置,可以使用 locale 属性进行设置。区域设置控制显示的语言以及日期和时间格式。

以下示例展示了如何将区域设置为西班牙语(西班牙)。

备注

时间标签不会自动本地化。更多信息请参阅时间标签

小时制

ion-datetime 默认将使用由 locale 属性指定的小时制。例如,如果 locale 设置为 en-US,则 ion-datetime 将使用 12 小时制。

有 4 种主要的小时制类型:

小时制类型描述
'h12'使用 1–12 的小时系统;对应模式中的 'h'。12 小时制,午夜从 12:00 am 开始。
'h23'使用 0–23 的小时系统;对应模式中的 'H'。24 小时制,午夜从 0:00 开始。
'h11'使用 0–11 的小时系统;对应模式中的 'K'。12 小时制,午夜从 0:00 am 开始。
'h24'使用 1–24 的小时系统;对应模式中的 'k'。24 小时制,午夜从 24:00 开始。

在某些场景下,您可能需要更精确地控制使用哪种小时制。这时 hourCycle 属性就可以发挥作用了。

在以下示例中,我们可以使用 hourCycle 属性强制 ion-datetime 使用 12 小时制,即使区域设置为默认使用 24 小时制的 en-GB

每周的第一天

对于 ion-datetime,默认每周的第一天是星期日。截至 2022 年,还没有浏览器 API 可以让 Ionic 根据设备的区域设置自动确定每周的第一天,不过这方面的工作正在进行中(请参阅:TC39 GitHub)。

时间标签

时间标签不会自动本地化。幸运的是,Ionic 可以通过 time-label 插槽轻松提供自定义本地化。

区域设置扩展标签

ion-datetime 还支持作为 Intl.Locale API 一部分的区域设置扩展标签。这些标签允许您在区域设置字符串本身中对区域设置信息进行编码。如果开发人员在其应用中使用 Intl.Locale API,则可能更倾向于使用扩展标签方法。

例如,如果您想在使用 en-GB 区域设置时使用 12 小时制,可以提供扩展标签,而不是同时使用 localehourCycle 属性:

备注

在您的应用中使用 Intl.Locale 之前,请务必查看浏览器兼容性图表

显示模式

默认情况下,ion-datetime 允许用户同时选择日期和时间。此外,用户还可以选择具体的月份、年份、小时和分钟。

某些用例可能只需要选择日期或仅选择时间。presentation 属性允许您指定显示哪些选择器及其显示顺序。例如,设置为 date-time 将使日历选择器出现在时间选择器之前。设置为 time-date 将使日历选择器出现在时间选择器之后。

月份和年份选择

通过将 month-yearmonthyear 传递给 presentation 属性,可以进行月份和年份选择。

此示例显示了一个使用 month-year 配置的日期时间组件。

时间选择

通过将 date-timetime-datetime 传递给 presentation 属性,可以进行时间选择。

此示例显示了一个使用 time 配置的日期时间组件。

日期选择

通过将 date-timetime-datedate 传递给 presentation 属性,可以进行日期选择。

此示例显示了一个使用 date 配置的日期时间组件。

滚轮样式选择器

默认情况下,Ionic 在使用 presentation 时偏好显示网格样式布局。但是,也可以使用 preferWheel 属性显示滚轮样式。当 preferWheeltrue 时,Ionic 将尽可能偏好显示滚轮样式布局。

某些 presentation 选项同时具有网格和滚轮样式,开发人员可以使用 preferWheel 属性进行选择。其他 presentation 值只有滚轮样式,永远不会显示网格样式。下表显示了哪些 presentation 值具有网格或滚轮样式。

presentation有网格样式?有滚轮样式?
dateYesYes
date-timeYesYes
monthNoYes
month-yearNoYes
timeNoYes
time-dateYesYes
yearNoYes

下面的示例展示了使用 presentation="date-time" 的滚轮选择器。

显示相邻日期

如果将 showAdjacentDays 属性设置为 true,则会显示前一个月和下个月的日期,以填补月份开始或结束时的空白。当用户点击启用的相邻日期时,日历会平滑地动画切换到该月的视图。

启用 showAdjacentDays 后,日历视图始终显示 6 行,因此会根据需要显示上个月或下个月的日期来填充网格。例如,即使某个月从一周的第一天开始并在第五行内结束,下个月的日期也会出现在末尾以完成第六行。

备注

此属性仅在使用 presentation="date"preferWheel="false" 时受支持。

多日期选择

如果将 multiple 属性设置为 true,则可以从日历选择器中选择多个日期。点击已选中的日期将取消选择。

备注

此属性仅在使用 presentation="date"preferWheel="false" 时受支持。

标题

默认情况下,ion-datetime 不显示任何与组件相关的标题或头部。开发人员可以使用 showDefaultTitle 属性来显示默认的标题/头部配置。他们还可以使用 title 插槽自定义头部中渲染的内容。

显示默认标题

自定义标题

格式选项

您可以通过提供 formatOptions 来自定义 Datetime 组件头部文本中的日期格式和时间按钮中的时间格式。formatOptions 属性中的 datetime 应分别为 Intl.DateTimeFormatOptions 对象。如果未提供 formatOptions,将使用日期和时间的默认格式。

Datetime 不会操作或设置时区。如果提供了 timeZonetimeZoneName,它们将被忽略,时区将设置为 UTC。这确保了显示的值与所选值匹配,而不是转换为用户当前的时区。

请注意您提供的选项,因为它们可能与所选的显示模式不匹配。例如,为 month 显示模式提供 minute: 'numeric' 可能会导致意外行为,显示预期可能只有时间的月份。

按钮

默认情况下,每当选择新日期时,ionChange 会携带新的日期时间值发出。要在发出 ionChange 之前需要用户确认,您可以设置 showDefaultButtons 属性为 true,或使用 buttons 插槽传入自定义的确认按钮。传入自定义按钮时,确认按钮必须调用 ion-datetimeconfirm 方法,才能发出 ionChange

显示确认按钮

默认的"完成"和"取消"按钮已预先配置好,分别调用 confirmcancel 方法。

自定义按钮文本

对于简单的用例,开发人员可以通过 doneTextcancelText 属性为确认和取消值提供自定义按钮文本。我们建议在只需要更改按钮文本而不需要任何自定义行为时使用此方法。

自定义按钮元素

开发人员可以提供自己的按钮以实现高级自定义行为。

ion-datetime 具有 confirmcancelreset 方法,开发人员可以在点击自定义按钮时调用。reset 方法还允许开发人员提供一个日期来将日期时间重置为。

高亮特定日期

使用 highlightedDates 属性,开发人员可以使用自定义文本或背景颜色来样式化特定日期。此属性可以定义为日期及其颜色的数组,或一个接收 ISO 字符串并返回要使用的颜色的回调函数。

指定颜色时,可以使用任何有效的 CSS 颜色格式,包括十六进制代码、rgba颜色变量等。

为了保持一致的用户体验,选中日期的样式将始终覆盖自定义高亮。

备注

此属性仅在 preferWheel="false" 且使用 "date""date-time""time-date"presentation 时受支持。

使用数组

当高亮应用于固定日期(如到期日期)时,数组更合适。

使用回调

当高亮日期是重复性的(如生日或定期会议)时,回调更合适。

样式

全局主题

Ionic 强大的主题系统可用于轻松更改整个应用以匹配特定主题。在此示例中,我们使用颜色创建器阶梯颜色生成器创建了一个玫瑰色调色板,可用于 ion-datetime

这种方法的好处是每个组件(不仅仅是 ion-datetime)都可以自动利用此主题。

Datetime 头部

Datetime 头部管理 title 插槽的内容和所选日期。

备注

如果 preferWheel 设置为 true,则不会渲染所选日期。

日历头部

日历头部在使用网格样式布局时管理日期导航控件(月份/年份选择器和上/下按钮)以及星期几。

头部可以使用 CSS 阴影部分进行样式化。

日历天

网格样式 ion-datetime 中的日历天可以使用 CSS 阴影部分进行样式化。

备注

下面的示例选择了 2 天前的日期,除非该日期在上个月,则选择未来 2 天的日期。这是为了演示目的,以展示如何对所有日期、当前日期和选中日期应用自定义样式。

滚轮选择器

ion-datetime 中使用的滚轮可以通过阴影部分和 CSS 变量的组合进行样式化。这适用于滚轮样式日期时间中的列以及网格样式日期时间中的月份/年份选择器。

时区

Ionic 的 ion-datetime 遵循 datetime-local 的行为,不操作或设置日期时间控件内的时区。换句话说,时间值 "07:00" 不会根据不同的时区进行调整。

我们建议使用诸如 date-fns-tz 之类的库来将日期时间值转换为所需的时区。

以下是将 ISO-8601 字符串格式化为在用户设备时区中显示的示例:

import { format, utcToZonedTime } from 'date-fns-tz';

// 获取用户设备上设置的时区
const userTimeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;

// 从 UTC 日期字符串创建日期对象
const date = new Date('2014-10-25T10:46:20Z');

// 使用 date-fns-tz 从 UTC 转换为指定时区
const zonedTime = utcToZonedTime(date, userTimeZone);

// 从指定时区时间创建格式化字符串
format(zonedTime, 'yyyy-MM-dd HH:mm:ssXXX', { timeZone: userTimeZone });

解析日期值

ionChange 事件将在事件负载中发出 ISO-8601 字符串格式的日期值。开发人员负责根据其应用需求进行格式化。我们建议使用 date-fns 来格式化日期值。

以下是将 ISO-8601 字符串格式化为显示月、日和年的示例:

import { format, parseISO } from 'date-fns';

/**
* 这是从 `ionChange` 事件的
* 事件负载中提供的值。
*
* 该值是一个 ISO-8601 日期字符串。
*/
const dateFromIonDatetime = '2021-06-04T14:23:00-04:00';
const formattedString = format(parseISO(dateFromIonDatetime), 'MMM d, yyyy');

console.log(formattedString); // Jun 4, 2021

请参阅 https://date-fns.org/docs/format 获取所有有效格式令牌的列表。

高级日期时间验证和操作

日期时间选择器提供了选择精确格式的简便性,并使用标准化的 ISO 8601 日期时间格式将日期时间值持久化为字符串。但是,重要的是要注意 ion-datetime 并不试图解决验证和操作日期时间值的所有情况。如果需要从特定格式解析日期时间值,或进行操作(例如给日期加 5 天、减去 30 分钟等),甚至将数据格式化为特定区域设置,我们强烈建议使用 date-fns 在 JavaScript 中处理日期。

辅助功能

键盘交互

ion-datetime 在组件内支持完整的键盘导航,可在可聚焦元素之间移动。下表详细说明了每个键的功能:

描述
Tab将焦点移动到下一个可聚焦元素。
Shift + Tab将焦点移动到上一个可聚焦元素。
SpaceEnter点击可聚焦元素。

日期网格

描述
ArrowUp将焦点移动到前一周的同一天。
ArrowDown将焦点移动到下一周的同一天。
ArrowRight将焦点移动到下一天。
ArrowLeft将焦点移动到前一天。
Home将焦点移动到当前周的第一天。
End将焦点移动到当前周的最后一天。
PageUp将日期网格更改为上个月。
PageDown将日期网格更改为下个月。
Shift + PageUp将日期网格更改为上一年。
Shift + PageDown将日期网格更改为下一年。

时间、月份和年份滚轮

Datetime 中的滚轮选择器内部使用 Picker。有关滚轮选择器的辅助功能特性的更多信息,请参阅 Picker 无障碍

接口

DatetimeChangeEventDetail

interface DatetimeChangeEventDetail {
value?: string | null;
}

DatetimeCustomEvent

虽然不是必需的,但此接口可用于替代 CustomEvent 接口,为此组件发出的 Ionic 事件提供更强的类型支持。

interface DatetimeCustomEvent extends CustomEvent {
detail: DatetimeChangeEventDetail;
target: HTMLIonDatetimeElement;
}

属性

cancelText

说明The text to display on the picker's cancel button.
属性cancel-text
类型string
默认值'Cancel'

clearText

说明The text to display on the picker's "Clear" button.
属性clear-text
类型string
默认值'Clear'

color

说明The color to use from your application's color palette. Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark". For more information on colors, see theming.
属性color
类型"danger" | "dark" | "light" | "medium" | "primary" | "secondary" | "success" | "tertiary" | "warning" | string | undefined
默认值'primary'

dayValues

说明Values used to create the list of selectable days. By default every day is shown for the given month. However, to control exactly which days of the month to display, the dayValues input can take a number, an array of numbers, or a string of comma separated numbers. Note that even if the array days have an invalid number for the selected month, like 31 in February, it will correctly not show days which are not valid for the selected month.
属性day-values
类型number | number[] | string | undefined
默认值undefined

disabled

说明If true, the user cannot interact with the datetime.
属性disabled
类型boolean
默认值false

doneText

说明The text to display on the picker's "Done" button.
属性done-text
类型string
默认值'Done'

firstDayOfWeek

说明The first day of the week to use for ion-datetime. The default value is 0 and represents Sunday.
属性first-day-of-week
类型number
默认值0

formatOptions

说明Formatting options for dates and times. Should include a 'date' and/or 'time' object, each of which is of type Intl.DateTimeFormatOptions.
属性undefined
类型undefined | { date: DateTimeFormatOptions; time?: DateTimeFormatOptions | undefined; } | { date?: DateTimeFormatOptions | undefined; time: DateTimeFormatOptions; }
默认值undefined

highlightedDates

说明Used to apply custom text and background colors to specific dates.

Can be either an array of objects containing ISO strings and colors, or a callback that receives an ISO string and returns the colors.

Only applies to the date, date-time, and time-date presentations, with preferWheel="false".
属性undefined
类型((dateIsoString: string) => DatetimeHighlightStyle | undefined) | DatetimeHighlight[] | undefined
默认值undefined

hourCycle

说明The hour cycle of the ion-datetime. If no value is set, this is specified by the current locale.
属性hour-cycle
类型"h11" | "h12" | "h23" | "h24" | undefined
默认值undefined

hourValues

说明Values used to create the list of selectable hours. By default the hour values range from 0 to 23 for 24-hour, or 1 to 12 for 12-hour. However, to control exactly which hours to display, the hourValues input can take a number, an array of numbers, or a string of comma separated numbers.
属性hour-values
类型number | number[] | string | undefined
默认值undefined

isDateEnabled

说明Returns if an individual date (calendar day) is enabled or disabled.

If true, the day will be enabled/interactive. If false, the day will be disabled/non-interactive.

The function accepts an ISO 8601 date string of a given day. By default, all days are enabled. Developers can use this function to write custom logic to disable certain days.

The function is called for each rendered calendar day, for the previous, current and next month. Custom implementations should be optimized for performance to avoid jank.
属性undefined
类型((dateIsoString: string) => boolean) | undefined
默认值undefined

locale

说明The locale to use for ion-datetime. This impacts month and day name formatting. The "default" value refers to the default locale set by your device.
属性locale
类型string
默认值'default'

max

说明The maximum datetime allowed. Value must be a date string following the ISO 8601 datetime format standard, 1996-12-19. The format does not have to be specific to an exact datetime. For example, the maximum could just be the year, such as 1994. Defaults to the end of this year.
属性max
类型string | undefined
默认值undefined

min

说明The minimum datetime allowed. Value must be a date string following the ISO 8601 datetime format standard, such as 1996-12-19. The format does not have to be specific to an exact datetime. For example, the minimum could just be the year, such as 1994. Defaults to the beginning of the year, 100 years ago from today.

这是一个虚拟属性,在初始化时设置一次,之后更改其值不会更新组件。
属性min
类型string | undefined
默认值undefined

minuteValues

说明Values used to create the list of selectable minutes. By default the minutes range from 0 to 59. However, to control exactly which minutes to display, the minuteValues input can take a number, an array of numbers, or a string of comma separated numbers. For example, if the minute selections should only be every 15 minutes, then this input value would be minuteValues="0,15,30,45".
属性minute-values
类型number | number[] | string | undefined
默认值undefined

mode

说明The mode determines which platform styles to use.

这是一个虚拟属性,在初始化时设置一次,之后更改其值不会更新组件。
属性mode
类型"ios" | "md"
默认值undefined

monthValues

说明Values used to create the list of selectable months. By default the month values range from 1 to 12. However, to control exactly which months to display, the monthValues input can take a number, an array of numbers, or a string of comma separated numbers. For example, if only summer months should be shown, then this input value would be monthValues="6,7,8". Note that month numbers do not have a zero-based index, meaning January's value is 1, and December's is 12.
属性month-values
类型number | number[] | string | undefined
默认值undefined

multiple

说明If true, multiple dates can be selected at once. Only applies to presentation="date" and preferWheel="false".
属性multiple
类型boolean
默认值false

name

说明The name of the control, which is submitted with the form data.
属性name
类型string
默认值this.inputId

preferWheel

说明If true, a wheel picker will be rendered instead of a calendar grid where possible. If false, a calendar grid will be rendered instead of a wheel picker where possible.

A wheel picker can be rendered instead of a grid when presentation is one of the following values: "date", "date-time", or "time-date".

A wheel picker will always be rendered regardless of the preferWheel value when presentation is one of the following values: "time", "month", "month-year", or "year".
属性prefer-wheel
类型boolean
默认值false

presentation

说明Which values you want to select. "date" will show a calendar picker to select the month, day, and year. "time" will show a time picker to select the hour, minute, and (optionally) AM/PM. "date-time" will show the date picker first and time picker second. "time-date" will show the time picker first and date picker second.
属性presentation
类型"date" | "date-time" | "month" | "month-year" | "time" | "time-date" | "year"
默认值'date-time'

readonly

说明If true, the datetime appears normal but the selected date cannot be changed.
属性readonly
类型boolean
默认值false

showAdjacentDays

说明If true, the datetime calendar displays a six-week (42-day) layout, including days from the previous and next months to fill the grid. These adjacent days are selectable unless disabled.
属性show-adjacent-days
类型boolean
默认值false

showClearButton

说明If true, a "Clear" button will be rendered alongside the default "Cancel" and "OK" buttons at the bottom of the ion-datetime component. Developers can also use the button slot if they want to customize these buttons. If custom buttons are set in the button slot then the default buttons will not be rendered.
属性show-clear-button
类型boolean
默认值false

showDefaultButtons

说明If true, the default "Cancel" and "OK" buttons will be rendered at the bottom of the ion-datetime component. Developers can also use the button slot if they want to customize these buttons. If custom buttons are set in the button slot then the default buttons will not be rendered.
属性show-default-buttons
类型boolean
默认值false

showDefaultTimeLabel

说明If true, the default "Time" label will be rendered for the time selector of the ion-datetime component. Developers can also use the time-label slot if they want to customize this label. If a custom label is set in the time-label slot then the default label will not be rendered.
属性show-default-time-label
类型boolean
默认值true

showDefaultTitle

说明If true, a header will be shown above the calendar picker. This will include both the slotted title, and the selected date.
属性show-default-title
类型boolean
默认值false

size

说明If cover, the ion-datetime will expand to cover the full width of its container. If fixed, the ion-datetime will have a fixed width.
属性size
类型"cover" | "fixed"
默认值'fixed'

titleSelectedDatesFormatter

说明A callback used to format the header text that shows how many dates are selected. Only used if there are 0 or more than 1 selected (i.e. unused for exactly 1). By default, the header text is set to "numberOfDates days".

See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access this from within the callback.
属性undefined
类型((selectedDates: string[]) => string) | undefined
默认值undefined

value

说明The value of the datetime as a valid ISO 8601 datetime string. This should be an array of strings only when multiple="true".
属性value
类型null | string | string[] | undefined
默认值undefined

yearValues

说明Values used to create the list of selectable years. By default the year values range between the min and max datetime inputs. However, to control exactly which years to display, the yearValues input can take a number, an array of numbers, or string of comma separated numbers. For example, to show upcoming and recent leap years, then this input's value would be yearValues="2008,2012,2016,2020,2024".
属性year-values
类型number | number[] | string | undefined
默认值undefined

事件

Name说明冒泡
ionBlurEmitted when the datetime loses focus.true
ionCancelEmitted when the datetime selection was cancelled.true
ionChangeEmitted when the value (selected date) has changed.

This event will not emit when programmatically setting the value property.
true
ionFocusEmitted when the datetime has focus.true

方法

cancel

说明Emits the ionCancel event and optionally closes the popover or modal that the datetime was presented in.
签名cancel(closeOverlay?: boolean) => Promise<void>
参数closeOverlay: If true, closes the parent overlay. Defaults to false.

confirm

说明Confirms the selected datetime value, updates the value property, and optionally closes the popover or modal that the datetime was presented in.
签名confirm(closeOverlay?: boolean) => Promise<void>
参数closeOverlay: If true, closes the parent overlay. Defaults to false.

reset

说明Resets the internal state of the datetime but does not update the value. Passing a valid ISO-8601 string will reset the state of the component to the provided date. If no value is provided, the internal state will be reset to the clamped value of the min, max and today.
签名reset(startDate?: string) => Promise<void>
参数startDate: A valid ISO-8601 string to reset the datetime state to.

CSS Shadow Parts

Name说明
calendar-dayThe individual buttons that display a day inside of the datetime calendar.
calendar-day activeThe currently selected calendar day.
calendar-day disabledThe calendar day that is disabled.
calendar-day todayThe calendar day that contains the current day.
calendar-days-of-weekThe container for the day-of-the-week header (both weekdays and weekends) when using a grid style layout.
calendar-headerThe calendar header manages the date navigation controls (month/year picker and previous/next buttons) and the days of the week when using a grid style layout.
datetime-headerThe datetime header contains the content for the title slot and the selected date.
datetime-selected-dateThe element that contains the selected date.
datetime-titleThe element that contains the title slot content.
month-year-buttonThe button that opens the month/year picker when using a grid style layout.
navigation-buttonThe buttons used to navigate to the next or previous month when using a grid style layout.
next-buttonThe button used to navigate to the next month when using a grid style layout.
previous-buttonThe button used to navigate to the previous month when using a grid style layout.
time-buttonThe button that opens the time picker when using a grid style layout with presentation="date-time" or "time-date".
time-button activeThe time picker button when the picker is open.
wheelThe wheel container when using a wheel style layout, or in the month/year picker when using a grid style layout.
wheel-itemThe individual items when using a wheel style layout, or in the month/year picker when using a grid style layout.
wheel-item activeThe currently selected wheel-item.

CSS 自定义属性

Name说明
--backgroundThe primary background of the datetime component.
--background-rgbThe primary background of the datetime component in RGB format.
--title-colorThe text color of the title.
--wheel-fade-background-rgbThe color of the gradient covering non-selected items when using a wheel style layout, or in the month/year picker for grid style layouts. Must be in RGB format, e.g. 255, 255, 255.
--wheel-highlight-backgroundThe background of the highlight under the selected item when using a wheel style layout, or in the month/year picker for grid style layouts.
--wheel-highlight-border-radiusThe border radius of the highlight under the selected item when using a wheel style layout, or in the month/year picker for grid style layouts.

插槽

Name说明
buttonsThe buttons in the datetime.
time-labelThe label for the time selector in the datetime.
titleThe title of the datetime.