@ionic/core 8.5.4-dev.11743804857.1f3f3ee1 → 8.5.4-dev.11743809140.11f51ef0

package/dist/collection/components/datetime/datetime.js

@@ -45,6 +45,123 @@ export class Datetime {
     constructor() {
         this.inputId = `ion-dt-${datetimeIds++}`;
         this.prevPresentation = null;
+        this.showMonthAndYear = false;
+        this.activeParts = [];
+        this.workingParts = {
+            month: 5,
+            day: 28,
+            year: 2021,
+            hour: 13,
+            minute: 52,
+            ampm: 'pm',
+        };
+        this.isTimePopoverOpen = false;
+        /**
+         * 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](/docs/theming/basics).
+         */
+        this.color = 'primary';
+        /**
+         * The name of the control, which is submitted with the form data.
+         */
+        this.name = this.inputId;
+        /**
+         * If `true`, the user cannot interact with the datetime.
+         */
+        this.disabled = false;
+        /**
+         * If `true`, the datetime appears normal but the selected date cannot be changed.
+         */
+        this.readonly = false;
+        /**
+         * 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.
+         */
+        this.presentation = 'date-time';
+        /**
+         * The text to display on the picker's cancel button.
+         */
+        this.cancelText = 'Cancel';
+        /**
+         * The text to display on the picker's "Done" button.
+         */
+        this.doneText = 'Done';
+        /**
+         * The text to display on the picker's "Clear" button.
+         */
+        this.clearText = 'Clear';
+        /**
+         * 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.
+         */
+        this.locale = 'default';
+        /**
+         * The first day of the week to use for `ion-datetime`. The
+         * default value is `0` and represents Sunday.
+         */
+        this.firstDayOfWeek = 0;
+        /**
+         * If `true`, multiple dates can be selected at once. Only
+         * applies to `presentation="date"` and `preferWheel="false"`.
+         */
+        this.multiple = false;
+        /**
+         * If `true`, a header will be shown above the calendar
+         * picker. This will include both the slotted title, and
+         * the selected date.
+         */
+        this.showDefaultTitle = false;
+        /**
+         * 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.
+         */
+        this.showDefaultButtons = false;
+        /**
+         * 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.
+         */
+        this.showClearButton = false;
+        /**
+         * 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.
+         */
+        this.showDefaultTimeLabel = true;
+        /**
+         * 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.
+         */
+        this.size = 'fixed';
+        /**
+         * 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"`.
+         */
+        this.preferWheel = false;
         this.warnIfIncorrectValueUsage = () => {
             const { multiple, value } = this;
             if (!multiple && Array.isArray(value)) {
@@ -637,48 +754,6 @@ export class Datetime {
         this.toggleMonthAndYearView = () => {
             this.showMonthAndYear = !this.showMonthAndYear;
         };
-        this.showMonthAndYear = false;
-        this.activeParts = [];
-        this.workingParts = {
-            month: 5,
-            day: 28,
-            year: 2021,
-            hour: 13,
-            minute: 52,
-            ampm: 'pm',
-        };
-        this.isTimePopoverOpen = false;
-        this.forceRenderDate = undefined;
-        this.color = 'primary';
-        this.name = this.inputId;
-        this.disabled = false;
-        this.formatOptions = undefined;
-        this.readonly = false;
-        this.isDateEnabled = undefined;
-        this.min = undefined;
-        this.max = undefined;
-        this.presentation = 'date-time';
-        this.cancelText = 'Cancel';
-        this.doneText = 'Done';
-        this.clearText = 'Clear';
-        this.yearValues = undefined;
-        this.monthValues = undefined;
-        this.dayValues = undefined;
-        this.hourValues = undefined;
-        this.minuteValues = undefined;
-        this.locale = 'default';
-        this.firstDayOfWeek = 0;
-        this.titleSelectedDatesFormatter = undefined;
-        this.multiple = false;
-        this.highlightedDates = undefined;
-        this.value = undefined;
-        this.showDefaultTitle = false;
-        this.showDefaultButtons = false;
-        this.showClearButton = false;
-        this.showDefaultTimeLabel = true;
-        this.hourCycle = undefined;
-        this.size = 'fixed';
-        this.preferWheel = false;
     }
     formatOptionsChanged() {
         const { el, formatOptions, presentation } = this;
@@ -1587,6 +1662,7 @@ export class Datetime {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -1605,12 +1681,14 @@ export class Datetime {
                     "tags": [],
                     "text": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
                 },
-                "attribute": "color",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'primary'"
             },
             "name": {
                 "type": "string",
+                "attribute": "name",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1623,12 +1701,14 @@ export class Datetime {
                     "tags": [],
                     "text": "The name of the control, which is submitted with the form data."
                 },
-                "attribute": "name",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "this.inputId"
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1641,12 +1721,14 @@ export class Datetime {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the datetime."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "formatOptions": {
                 "type": "unknown",
+                "attribute": "format-options",
                 "mutable": false,
                 "complexType": {
                     "original": "FormatOptions",
@@ -1664,10 +1746,13 @@ export class Datetime {
                 "docs": {
                     "tags": [],
                     "text": "Formatting options for dates and times.\nShould include a 'date' and/or 'time' object, each of which is of type [Intl.DateTimeFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#options)."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "readonly": {
                 "type": "boolean",
+                "attribute": "readonly",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1680,12 +1765,14 @@ export class Datetime {
                     "tags": [],
                     "text": "If `true`, the datetime appears normal but the selected date cannot be changed."
                 },
-                "attribute": "readonly",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "isDateEnabled": {
                 "type": "unknown",
+                "attribute": "is-date-enabled",
                 "mutable": false,
                 "complexType": {
                     "original": "(dateIsoString: string) => boolean",
@@ -1697,10 +1784,13 @@ export class Datetime {
                 "docs": {
                     "tags": [],
                     "text": "Returns if an individual date (calendar day) is enabled or disabled.\n\nIf `true`, the day will be enabled/interactive.\nIf `false`, the day will be disabled/non-interactive.\n\nThe function accepts an ISO 8601 date string of a given day.\nBy default, all days are enabled. Developers can use this function\nto write custom logic to disable certain days.\n\nThe function is called for each rendered calendar day, for the previous, current and next month.\nCustom implementations should be optimized for performance to avoid jank."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "min": {
                 "type": "string",
+                "attribute": "min",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -1713,11 +1803,13 @@ export class Datetime {
                     "tags": [],
                     "text": "The minimum datetime allowed. Value must be a date string\nfollowing the\n[ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),\nsuch as `1996-12-19`. The format does not have to be specific to an exact\ndatetime. For example, the minimum could just be the year, such as `1994`.\nDefaults to the beginning of the year, 100 years ago from today."
                 },
-                "attribute": "min",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "max": {
                 "type": "string",
+                "attribute": "max",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -1730,11 +1822,13 @@ export class Datetime {
                     "tags": [],
                     "text": "The maximum datetime allowed. Value must be a date string\nfollowing the\n[ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),\n`1996-12-19`. The format does not have to be specific to an exact\ndatetime. For example, the maximum could just be the year, such as `1994`.\nDefaults to the end of this year."
                 },
-                "attribute": "max",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "presentation": {
                 "type": "string",
+                "attribute": "presentation",
                 "mutable": false,
                 "complexType": {
                     "original": "DatetimePresentation",
@@ -1753,12 +1847,14 @@ export class Datetime {
                     "tags": [],
                     "text": "Which values you want to select. `\"date\"` will show\na calendar picker to select the month, day, and year. `\"time\"`\nwill show a time picker to select the hour, minute, and (optionally)\nAM/PM. `\"date-time\"` will show the date picker first and time picker second.\n`\"time-date\"` will show the time picker first and date picker second."
                 },
-                "attribute": "presentation",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'date-time'"
             },
             "cancelText": {
                 "type": "string",
+                "attribute": "cancel-text",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1771,12 +1867,14 @@ export class Datetime {
                     "tags": [],
                     "text": "The text to display on the picker's cancel button."
                 },
-                "attribute": "cancel-text",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'Cancel'"
             },
             "doneText": {
                 "type": "string",
+                "attribute": "done-text",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1789,12 +1887,14 @@ export class Datetime {
                     "tags": [],
                     "text": "The text to display on the picker's \"Done\" button."
                 },
-                "attribute": "done-text",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'Done'"
             },
             "clearText": {
                 "type": "string",
+                "attribute": "clear-text",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1807,12 +1907,14 @@ export class Datetime {
                     "tags": [],
                     "text": "The text to display on the picker's \"Clear\" button."
                 },
-                "attribute": "clear-text",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'Clear'"
             },
             "yearValues": {
                 "type": "any",
+                "attribute": "year-values",
                 "mutable": false,
                 "complexType": {
                     "original": "number[] | number | string",
@@ -1825,11 +1927,13 @@ export class Datetime {
                     "tags": [],
                     "text": "Values used to create the list of selectable years. By default\nthe year values range between the `min` and `max` datetime inputs. However, to\ncontrol exactly which years to display, the `yearValues` input can take a number, an array\nof numbers, or string of comma separated numbers. For example, to show upcoming and\nrecent leap years, then this input's value would be `yearValues=\"2008,2012,2016,2020,2024\"`."
                 },
-                "attribute": "year-values",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "monthValues": {
                 "type": "any",
+                "attribute": "month-values",
                 "mutable": false,
                 "complexType": {
                     "original": "number[] | number | string",
@@ -1842,11 +1946,13 @@ export class Datetime {
                     "tags": [],
                     "text": "Values used to create the list of selectable months. By default\nthe month values range from `1` to `12`. However, to control exactly which months to\ndisplay, the `monthValues` input can take a number, an array of numbers, or a string of\ncomma separated numbers. For example, if only summer months should be shown, then this\ninput value would be `monthValues=\"6,7,8\"`. Note that month numbers do *not* have a\nzero-based index, meaning January's value is `1`, and December's is `12`."
                 },
-                "attribute": "month-values",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "dayValues": {
                 "type": "any",
+                "attribute": "day-values",
                 "mutable": false,
                 "complexType": {
                     "original": "number[] | number | string",
@@ -1859,11 +1965,13 @@ export class Datetime {
                     "tags": [],
                     "text": "Values used to create the list of selectable days. By default\nevery day is shown for the given month. However, to control exactly which days of\nthe month to display, the `dayValues` input can take a number, an array of numbers, or\na string of comma separated numbers. Note that even if the array days have an invalid\nnumber for the selected month, like `31` in February, it will correctly not show\ndays which are not valid for the selected month."
                 },
-                "attribute": "day-values",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "hourValues": {
                 "type": "any",
+                "attribute": "hour-values",
                 "mutable": false,
                 "complexType": {
                     "original": "number[] | number | string",
@@ -1876,11 +1984,13 @@ export class Datetime {
                     "tags": [],
                     "text": "Values used to create the list of selectable hours. By default\nthe hour values range from `0` to `23` for 24-hour, or `1` to `12` for 12-hour. However,\nto control exactly which hours to display, the `hourValues` input can take a number, an\narray of numbers, or a string of comma separated numbers."
                 },
-                "attribute": "hour-values",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "minuteValues": {
                 "type": "any",
+                "attribute": "minute-values",
                 "mutable": false,
                 "complexType": {
                     "original": "number[] | number | string",
@@ -1893,11 +2003,13 @@ export class Datetime {
                     "tags": [],
                     "text": "Values used to create the list of selectable minutes. By default\nthe minutes range from `0` to `59`. However, to control exactly which minutes to display,\nthe `minuteValues` input can take a number, an array of numbers, or a string of comma\nseparated numbers. For example, if the minute selections should only be every 15 minutes,\nthen this input value would be `minuteValues=\"0,15,30,45\"`."
                 },
-                "attribute": "minute-values",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "locale": {
                 "type": "string",
+                "attribute": "locale",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -1910,12 +2022,14 @@ export class Datetime {
                     "tags": [],
                     "text": "The locale to use for `ion-datetime`. This\nimpacts month and day name formatting.\nThe `\"default\"` value refers to the default\nlocale set by your device."
                 },
-                "attribute": "locale",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'default'"
             },
             "firstDayOfWeek": {
                 "type": "number",
+                "attribute": "first-day-of-week",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -1928,12 +2042,14 @@ export class Datetime {
                     "tags": [],
                     "text": "The first day of the week to use for `ion-datetime`. The\ndefault value is `0` and represents Sunday."
                 },
-                "attribute": "first-day-of-week",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "0"
             },
             "titleSelectedDatesFormatter": {
                 "type": "unknown",
+                "attribute": "title-selected-dates-formatter",
                 "mutable": false,
                 "complexType": {
                     "original": "TitleSelectedDatesFormatter",
@@ -1951,10 +2067,13 @@ export class Datetime {
                 "docs": {
                     "tags": [],
                     "text": "A callback used to format the header text that shows how many\ndates are selected. Only used if there are 0 or more than 1\nselected (i.e. unused for exactly 1). By default, the header\ntext is set to \"numberOfDates days\".\n\nSee https://ionicframework.com/docs/troubleshooting/runtime#accessing-this\nif you need to access `this` from within the callback."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "multiple": {
                 "type": "boolean",
+                "attribute": "multiple",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1967,12 +2086,14 @@ export class Datetime {
                     "tags": [],
                     "text": "If `true`, multiple dates can be selected at once. Only\napplies to `presentation=\"date\"` and `preferWheel=\"false\"`."
                 },
-                "attribute": "multiple",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "highlightedDates": {
                 "type": "unknown",
+                "attribute": "highlighted-dates",
                 "mutable": false,
                 "complexType": {
                     "original": "DatetimeHighlight[] | DatetimeHighlightCallback",
@@ -1995,10 +2116,13 @@ export class Datetime {
                 "docs": {
                     "tags": [],
                     "text": "Used to apply custom text and background colors to specific dates.\n\nCan be either an array of objects containing ISO strings and colors,\nor a callback that receives an ISO string and returns the colors.\n\nOnly applies to the `date`, `date-time`, and `time-date` presentations,\nwith `preferWheel=\"false\"`."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "value": {
                 "type": "string",
+                "attribute": "value",
                 "mutable": true,
                 "complexType": {
                     "original": "string | string[] | null",
@@ -2011,11 +2135,13 @@ export class Datetime {
                     "tags": [],
                     "text": "The value of the datetime as a valid ISO 8601 datetime string.\nThis should be an array of strings only when `multiple=\"true\"`."
                 },
-                "attribute": "value",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "showDefaultTitle": {
                 "type": "boolean",
+                "attribute": "show-default-title",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -2028,12 +2154,14 @@ export class Datetime {
                     "tags": [],
                     "text": "If `true`, a header will be shown above the calendar\npicker. This will include both the slotted title, and\nthe selected date."
                 },
-                "attribute": "show-default-title",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "showDefaultButtons": {
                 "type": "boolean",
+                "attribute": "show-default-buttons",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -2046,12 +2174,14 @@ export class Datetime {
                     "tags": [],
                     "text": "If `true`, the default \"Cancel\" and \"OK\" buttons\nwill be rendered at the bottom of the `ion-datetime`\ncomponent. Developers can also use the `button` slot\nif they want to customize these buttons. If custom\nbuttons are set in the `button` slot then the\ndefault buttons will not be rendered."
                 },
-                "attribute": "show-default-buttons",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "showClearButton": {
                 "type": "boolean",
+                "attribute": "show-clear-button",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -2064,12 +2194,14 @@ export class Datetime {
                     "tags": [],
                     "text": "If `true`, a \"Clear\" button will be rendered alongside\nthe default \"Cancel\" and \"OK\" buttons at the bottom of the `ion-datetime`\ncomponent. Developers can also use the `button` slot\nif they want to customize these buttons. If custom\nbuttons are set in the `button` slot then the\ndefault buttons will not be rendered."
                 },
-                "attribute": "show-clear-button",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "showDefaultTimeLabel": {
                 "type": "boolean",
+                "attribute": "show-default-time-label",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -2082,12 +2214,14 @@ export class Datetime {
                     "tags": [],
                     "text": "If `true`, the default \"Time\" label will be rendered\nfor the time selector of the `ion-datetime` component.\nDevelopers can also use the `time-label` slot\nif they want to customize this label. If a custom\nlabel is set in the `time-label` slot then the\ndefault label will not be rendered."
                 },
-                "attribute": "show-default-time-label",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "hourCycle": {
                 "type": "string",
+                "attribute": "hour-cycle",
                 "mutable": false,
                 "complexType": {
                     "original": "DatetimeHourCycle",
@@ -2106,11 +2240,13 @@ export class Datetime {
                     "tags": [],
                     "text": "The hour cycle of the `ion-datetime`. If no value is set, this is\nspecified by the current locale."
                 },
-                "attribute": "hour-cycle",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "size": {
                 "type": "string",
+                "attribute": "size",
                 "mutable": false,
                 "complexType": {
                     "original": "'cover' | 'fixed'",
@@ -2123,12 +2259,14 @@ export class Datetime {
                     "tags": [],
                     "text": "If `cover`, the `ion-datetime` will expand to cover the full width of its container.\nIf `fixed`, the `ion-datetime` will have a fixed width."
                 },
-                "attribute": "size",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'fixed'"
             },
             "preferWheel": {
                 "type": "boolean",
+                "attribute": "prefer-wheel",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -2141,7 +2279,8 @@ export class Datetime {
                     "tags": [],
                     "text": "If `true`, a wheel picker will be rendered instead of a calendar grid\nwhere possible. If `false`, a calendar grid will be rendered instead of\na wheel picker where possible.\n\nA wheel picker can be rendered instead of a grid when `presentation` is\none of the following values: `\"date\"`, `\"date-time\"`, or `\"time-date\"`.\n\nA wheel picker will always be rendered regardless of\nthe `preferWheel` value when `presentation` is one of the following values:\n`\"time\"`, `\"month\"`, `\"month-year\"`, or `\"year\"`."
                 },
-                "attribute": "prefer-wheel",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             }