@ionic/docs 8.0.0-dev.11709632212.139b6f63 → 8.0.0-dev.11711035263.183d2423

package/core.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2024-03-05T09:51:59",
+  "timestamp": "2024-03-21T15:36:35",
   "compiler": {
     "name": "@stencil/core",
-    "version": "4.12.2",
+    "version": "4.12.6",
     "typescriptVersion": "5.3.3"
   },
   "components": [
@@ -4098,7 +4098,8 @@
         }
       ],
       "dependents": [
-        "ion-datetime"
+        "ion-datetime",
+        "ion-input-password-toggle"
       ],
       "dependencies": [
         "ion-ripple-effect"
@@ -4109,6 +4110,9 @@
         ],
         "ion-datetime": [
           "ion-button"
+        ],
+        "ion-input-password-toggle": [
+          "ion-button"
         ]
       }
     },
@@ -7067,6 +7071,44 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "formatOptions",
+          "type": "undefined | { date: DateTimeFormatOptions; time?: DateTimeFormatOptions | undefined; } | { date?: DateTimeFormatOptions | undefined; time: DateTimeFormatOptions; }",
+          "complexType": {
+            "original": "FormatOptions",
+            "resolved": "undefined | { date: DateTimeFormatOptions; time?: DateTimeFormatOptions | undefined; } | { date?: DateTimeFormatOptions | undefined; time: DateTimeFormatOptions; }",
+            "references": {
+              "FormatOptions": {
+                "location": "import",
+                "path": "./datetime-interface",
+                "id": "src/components/datetime/datetime-interface.ts::FormatOptions"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "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).",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "undefined"
+            },
+            {
+              "type": "{ date: DateTimeFormatOptions; time?: DateTimeFormatOptions"
+            },
+            {
+              "type": "undefined; }"
+            },
+            {
+              "type": "{ date?: DateTimeFormatOptions"
+            },
+            {
+              "type": "undefined; time: DateTimeFormatOptions; }"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "highlightedDates",
           "type": "((dateIsoString: string) => DatetimeHighlightStyle | undefined) | DatetimeHighlight[] | undefined",
@@ -10200,7 +10242,7 @@
           },
           "mutable": false,
           "attr": "disabled",
-          "reflectToAttr": false,
+          "reflectToAttr": true,
           "docs": "If `true`, the user cannot interact with the input.",
           "docsTags": [],
           "default": "false",
@@ -10681,7 +10723,7 @@
           },
           "mutable": false,
           "attr": "readonly",
-          "reflectToAttr": false,
+          "reflectToAttr": true,
           "docs": "If `true`, the user cannot modify the value.",
           "docsTags": [],
           "default": "false",
@@ -11068,6 +11110,11 @@
           "annotation": "prop",
           "docs": "The color of the highlight on the input when valid"
         },
+        {
+          "name": "--highlight-height",
+          "annotation": "prop",
+          "docs": "The height of the highlight on the input. Only applies to md mode."
+        },
         {
           "name": "--padding-bottom",
           "annotation": "prop",
@@ -11134,6 +11181,181 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/input-password-toggle/input-password-toggle.tsx",
+      "encapsulation": "shadow",
+      "tag": "ion-input-password-toggle",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "virtualProp",
+          "text": "{\"ios\" | \"md\"} mode - The mode determines which platform styles to use."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "color",
+          "type": "\"danger\" | \"dark\" | \"light\" | \"medium\" | \"primary\" | \"secondary\" | \"success\" | \"tertiary\" | \"warning\" | string & Record<never, never> | undefined",
+          "complexType": {
+            "original": "Color",
+            "resolved": "\"danger\" | \"dark\" | \"light\" | \"medium\" | \"primary\" | \"secondary\" | \"success\" | \"tertiary\" | \"warning\" | string & Record<never, never> | undefined",
+            "references": {
+              "Color": {
+                "location": "import",
+                "path": "../../interface",
+                "id": "src/interface.d.ts::Color"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "color",
+          "reflectToAttr": true,
+          "docs": "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).",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "danger",
+              "type": "string"
+            },
+            {
+              "value": "dark",
+              "type": "string"
+            },
+            {
+              "value": "light",
+              "type": "string"
+            },
+            {
+              "value": "medium",
+              "type": "string"
+            },
+            {
+              "value": "primary",
+              "type": "string"
+            },
+            {
+              "value": "secondary",
+              "type": "string"
+            },
+            {
+              "value": "success",
+              "type": "string"
+            },
+            {
+              "value": "tertiary",
+              "type": "string"
+            },
+            {
+              "value": "warning",
+              "type": "string"
+            },
+            {
+              "type": "string & Record<never, never>"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "hideIcon",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "hide-icon",
+          "reflectToAttr": false,
+          "docs": "The icon that can be used to represent hiding a password. If not set, the \"eyeOff\" Ionicon will be used.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "mode",
+          "type": "\"ios\" | \"md\"",
+          "mutable": false,
+          "attr": "mode",
+          "reflectToAttr": false,
+          "docs": "The mode determines which platform styles to use.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "ios",
+              "type": "string"
+            },
+            {
+              "value": "md",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "showIcon",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "show-icon",
+          "reflectToAttr": false,
+          "docs": "The icon that can be used to represent showing a password. If not set, the \"eye\" Ionicon will be used.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [
+        {
+          "name": "button",
+          "docs": ""
+        }
+      ],
+      "dependents": [],
+      "dependencies": [
+        "ion-button",
+        "ion-icon"
+      ],
+      "dependencyGraph": {
+        "ion-input-password-toggle": [
+          "ion-button",
+          "ion-icon"
+        ],
+        "ion-button": [
+          "ion-ripple-effect"
+        ]
+      }
+    },
     {
       "filePath": "src/components/item/item.tsx",
       "encapsulation": "shadow",
@@ -11156,14 +11378,6 @@
           "name": "slot",
           "text": "end - Content is placed to the right of the item text in LTR, and to the left in RTL."
         },
-        {
-          "name": "slot",
-          "text": "helper - Content is placed under the item and displayed when no error is detected. **DEPRECATED** Use the \"helperText\" property on ion-input or ion-textarea instead."
-        },
-        {
-          "name": "slot",
-          "text": "error - Content is placed under the item and displayed when an error is detected. **DEPRECATED** Use the \"errorText\" property on ion-input or ion-textarea instead."
-        },
         {
           "name": "part",
           "text": "native - The native HTML button, anchor or div element that wraps all child elements."
@@ -11263,69 +11477,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "counter",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "counter",
-          "reflectToAttr": false,
-          "docs": "If `true`, a character counter will display the ratio of characters used and the total character limit. Only applies when the `maxlength` property is set on the inner `ion-input` or `ion-textarea`.",
-          "docsTags": [
-            {
-              "name": "deprecated",
-              "text": "Use the `counter` property on `ion-input` or `ion-textarea` instead."
-            }
-          ],
-          "default": "false",
-          "deprecation": "Use the `counter` property on `ion-input` or `ion-textarea` instead.",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "counterFormatter",
-          "type": "((inputLength: number, maxLength: number) => string) | undefined",
-          "complexType": {
-            "original": "CounterFormatter",
-            "resolved": "((inputLength: number, maxLength: number) => string) | undefined",
-            "references": {
-              "CounterFormatter": {
-                "location": "import",
-                "path": "./item-interface",
-                "id": "src/components/item/item-interface.ts::CounterFormatter"
-              }
-            }
-          },
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "A callback used to format the counter text.\nBy default the counter text is set to \"itemLength / maxLength\".",
-          "docsTags": [
-            {
-              "name": "deprecated",
-              "text": "Use the `counterFormatter` property on `ion-input` or `ion-textarea` instead."
-            }
-          ],
-          "deprecation": "Use the `counterFormatter` property on `ion-input` or `ion-textarea` instead.",
-          "values": [
-            {
-              "type": "((inputLength: number, maxLength: number) => string)"
-            },
-            {
-              "type": "undefined"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "detail",
           "type": "boolean | undefined",
@@ -11418,41 +11569,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "fill",
-          "type": "\"outline\" | \"solid\" | undefined",
-          "complexType": {
-            "original": "'outline' | 'solid'",
-            "resolved": "\"outline\" | \"solid\" | undefined",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "fill",
-          "reflectToAttr": false,
-          "docs": "The fill for the item. If `\"solid\"` the item will have a background. If\n`\"outline\"` the item will be transparent with a border. Only available in `md` mode.",
-          "docsTags": [
-            {
-              "name": "deprecated",
-              "text": "Use the `fill` property on `ion-input` or `ion-textarea` instead."
-            }
-          ],
-          "deprecation": "Use the `fill` property on `ion-input` or `ion-textarea` instead.",
-          "values": [
-            {
-              "value": "outline",
-              "type": "string"
-            },
-            {
-              "value": "solid",
-              "type": "string"
-            },
-            {
-              "type": "undefined"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "href",
           "type": "string | undefined",
@@ -11621,31 +11737,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "shape",
-          "type": "\"round\" | undefined",
-          "complexType": {
-            "original": "'round'",
-            "resolved": "\"round\" | undefined",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "shape",
-          "reflectToAttr": false,
-          "docs": "The shape of the item. If \"round\" it will have increased\nborder radius.",
-          "docsTags": [],
-          "values": [
-            {
-              "value": "round",
-              "type": "string"
-            },
-            {
-              "type": "undefined"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "target",
           "type": "string | undefined",
@@ -11705,11 +11796,6 @@
       "methods": [],
       "events": [],
       "listeners": [
-        {
-          "event": "ionInput",
-          "capture": false,
-          "passive": false
-        },
         {
           "event": "ionColor",
           "capture": false,
@@ -11812,26 +11898,6 @@
           "annotation": "prop",
           "docs": "Opacity of the item detail icon"
         },
-        {
-          "name": "--highlight-color-focused",
-          "annotation": "prop",
-          "docs": "The color of the highlight on the item when focused. Only applies to inputs and textareas using the legacy form syntax. DEPRECATED: Highlights can be styled on `ion-input` or `ion-textarea` when using the modern form syntax."
-        },
-        {
-          "name": "--highlight-color-invalid",
-          "annotation": "prop",
-          "docs": "The color of the highlight on the item when invalid. Only applies to inputs and textareas using the legacy form syntax. DEPRECATED: Highlights can be styled on `ion-input` or `ion-textarea` when using the modern form syntax."
-        },
-        {
-          "name": "--highlight-color-valid",
-          "annotation": "prop",
-          "docs": "The color of the highlight on the item when valid. Only applies to inputs and textareas using the legacy form syntax. DEPRECATED: Highlights can be styled on `ion-input` or `ion-textarea` when using the modern form syntax."
-        },
-        {
-          "name": "--highlight-height",
-          "annotation": "prop",
-          "docs": "The height of the highlight on the item. Only applies to inputs and textareas using the legacy form syntax. DEPRECATED: Highlights can be styled on `ion-input` or `ion-textarea` when using the modern form syntax."
-        },
         {
           "name": "--inner-border-width",
           "annotation": "prop",
@@ -11907,14 +11973,6 @@
           "name": "end",
           "docs": "Content is placed to the right of the item text in LTR, and to the left in RTL."
         },
-        {
-          "name": "error",
-          "docs": "Content is placed under the item and displayed when an error is detected. **DEPRECATED** Use the \"errorText\" property on ion-input or ion-textarea instead."
-        },
-        {
-          "name": "helper",
-          "docs": "Content is placed under the item and displayed when no error is detected. **DEPRECATED** Use the \"helperText\" property on ion-input or ion-textarea instead."
-        },
         {
           "name": "start",
           "docs": "Content is placed to the left of the item text in LTR, and to the right in RTL."
@@ -11935,14 +11993,12 @@
       ],
       "dependencies": [
         "ion-icon",
-        "ion-ripple-effect",
-        "ion-note"
+        "ion-ripple-effect"
       ],
       "dependencyGraph": {
         "ion-item": [
           "ion-icon",
-          "ion-ripple-effect",
-          "ion-note"
+          "ion-ripple-effect"
         ],
         "ion-select-popover": [
           "ion-item"
@@ -14180,11 +14236,17 @@
         },
         {
           "name": "type",
-          "type": "string | undefined",
+          "type": "\"overlay\" | \"push\" | \"reveal\" | undefined",
           "complexType": {
-            "original": "string",
-            "resolved": "string | undefined",
-            "references": {}
+            "original": "MenuType",
+            "resolved": "\"overlay\" | \"push\" | \"reveal\" | undefined",
+            "references": {
+              "MenuType": {
+                "location": "import",
+                "path": "./menu-interface",
+                "id": "src/components/menu/menu-interface.ts::MenuType"
+              }
+            }
           },
           "mutable": true,
           "attr": "type",
@@ -14193,6 +14255,15 @@
           "docsTags": [],
           "values": [
             {
+              "value": "overlay",
+              "type": "string"
+            },
+            {
+              "value": "push",
+              "type": "string"
+            },
+            {
+              "value": "reveal",
               "type": "string"
             },
             {
@@ -17324,15 +17395,9 @@
       ],
       "slots": [],
       "parts": [],
-      "dependents": [
-        "ion-item"
-      ],
+      "dependents": [],
       "dependencies": [],
-      "dependencyGraph": {
-        "ion-item": [
-          "ion-note"
-        ]
-      }
+      "dependencyGraph": {}
     },
     {
       "filePath": "src/components/picker/picker.tsx",
@@ -22698,6 +22763,27 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "autocapitalize",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "autocapitalize",
+          "reflectToAttr": false,
+          "docs": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.\nAvailable options: `\"off\"`, `\"none\"`, `\"on\"`, `\"sentences\"`, `\"words\"`, `\"characters\"`.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
         {
           "name": "autocomplete",
           "type": "\"name\" | \"email\" | \"tel\" | \"url\" | \"on\" | \"off\" | \"honorific-prefix\" | \"given-name\" | \"additional-name\" | \"family-name\" | \"honorific-suffix\" | \"nickname\" | \"username\" | \"new-password\" | \"current-password\" | \"one-time-code\" | \"organization-title\" | \"organization\" | \"street-address\" | \"address-line1\" | \"address-line2\" | \"address-line3\" | \"address-level4\" | \"address-level3\" | \"address-level2\" | \"address-level1\" | \"country\" | \"country-name\" | \"postal-code\" | \"cc-name\" | \"cc-given-name\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-number\" | \"cc-exp\" | \"cc-exp-month\" | \"cc-exp-year\" | \"cc-csc\" | \"cc-type\" | \"transaction-currency\" | \"transaction-amount\" | \"language\" | \"bday\" | \"bday-day\" | \"bday-month\" | \"bday-year\" | \"sex\" | \"tel-country-code\" | \"tel-national\" | \"tel-area-code\" | \"tel-local\" | \"tel-extension\" | \"impp\" | \"photo\"",
@@ -23248,6 +23334,54 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "maxlength",
+          "type": "number | undefined",
+          "complexType": {
+            "original": "number",
+            "resolved": "number | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "maxlength",
+          "reflectToAttr": false,
+          "docs": "This attribute specifies the maximum number of characters that the user can enter.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "minlength",
+          "type": "number | undefined",
+          "complexType": {
+            "original": "number",
+            "resolved": "number | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "minlength",
+          "reflectToAttr": false,
+          "docs": "This attribute specifies the minimum number of characters that the user can enter.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "mode",
           "type": "\"ios\" | \"md\"",
@@ -25111,6 +25245,11 @@
           "annotation": "prop",
           "docs": "The color of the highlight on the select when valid"
         },
+        {
+          "name": "--highlight-height",
+          "annotation": "prop",
+          "docs": "The height of the highlight on the select. Only applies to md mode."
+        },
         {
           "name": "--padding-bottom",
           "annotation": "prop",
@@ -25210,8 +25349,7 @@
         ],
         "ion-item": [
           "ion-icon",
-          "ion-ripple-effect",
-          "ion-note"
+          "ion-ripple-effect"
         ],
         "ion-popover": [
           "ion-backdrop"
@@ -27597,6 +27735,11 @@
           "annotation": "prop",
           "docs": "The color of the highlight on the textarea when valid"
         },
+        {
+          "name": "--highlight-height",
+          "annotation": "prop",
+          "docs": "The height of the highlight on the textarea. Only applies to md mode."
+        },
         {
           "name": "--padding-bottom",
           "annotation": "prop",
@@ -28873,7 +29016,7 @@
           "mutable": false,
           "attr": "alignment",
           "reflectToAttr": false,
-          "docs": "How to control the alignment of the toggle and label on the cross axis.\n``\"start\"`: The label and control will appear on the left of the cross axis in LTR, and on the right side in RTL.\n`\"center\"`: The label and control will appear at the center of the cross axis in both LTR and RTL.",
+          "docs": "How to control the alignment of the toggle and label on the cross axis.\n`\"start\"`: The label and control will appear on the left of the cross axis in LTR, and on the right side in RTL.\n`\"center\"`: The label and control will appear at the center of the cross axis in both LTR and RTL.",
           "docsTags": [],
           "default": "'center'",
           "values": [
@@ -29542,11 +29685,6 @@
       "docstring": "",
       "path": "src/components/router/utils/interface.ts"
     },
-    "src/components/item/item-interface.ts::CounterFormatter": {
-      "declaration": "(inputLength: number, maxLength: number) => string",
-      "docstring": "",
-      "path": "src/components/item/item-interface.ts"
-    },
     "src/interface.d.ts::FrameworkDelegate": {
       "declaration": "export interface FrameworkDelegate {\n  attachViewToDom(container: any, component: any, propsOrDataObj?: any, cssClasses?: string[]): Promise<HTMLElement>;\n  removeViewFromDom(container: any, component: any): Promise<void>;\n}",
       "docstring": "",
@@ -29597,6 +29735,11 @@
       "docstring": "",
       "path": "src/components/content/content-interface.ts"
     },
+    "src/components/datetime/datetime-interface.ts::FormatOptions": {
+      "declaration": "export type FormatOptions =\n  | {\n      date: Intl.DateTimeFormatOptions;\n      time?: Intl.DateTimeFormatOptions;\n    }\n  | {\n      date?: Intl.DateTimeFormatOptions;\n      time: Intl.DateTimeFormatOptions;\n    };",
+      "docstring": "",
+      "path": "src/components/datetime/datetime-interface.ts"
+    },
     "src/components/datetime/datetime-interface.ts::DatetimePresentation": {
       "declaration": "export type DatetimePresentation = 'date-time' | 'time-date' | 'date' | 'time' | 'month' | 'year' | 'month-year';",
       "docstring": "",
@@ -29687,6 +29830,11 @@
       "docstring": "",
       "path": "src/components/menu/menu-interface.ts"
     },
+    "src/components/menu/menu-interface.ts::MenuType": {
+      "declaration": "export type MenuType = 'overlay' | 'reveal' | 'push';",
+      "docstring": "",
+      "path": "src/components/menu/menu-interface.ts"
+    },
     "src/components/menu/menu-interface.ts::MenuChangeEventDetail": {
       "declaration": "export interface MenuChangeEventDetail {\n  disabled: boolean;\n  open: boolean;\n}",
       "docstring": "",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ionic/docs",
-  "version": "8.0.0-dev.11709632212.139b6f63",
+  "version": "8.0.0-dev.11711035263.183d2423",
   "description": "Pre-packaged API documentation for the Ionic docs.",
   "main": "core.json",
   "types": "core.d.ts",