@ionic/docs 7.6.7-dev.11706625796.1b3c1ab2 → 7.6.7-dev.11706824245.18d35376

package/core.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2024-01-30T14:45:14",
+  "timestamp": "2024-02-01T21:52:46",
   "compiler": {
     "name": "@stencil/core",
-    "version": "4.12.0",
+    "version": "4.10.0",
     "typescriptVersion": "5.3.3"
   },
   "components": [
@@ -2580,7 +2580,7 @@
         "ion-loading",
         "ion-menu",
         "ion-modal",
-        "ion-picker",
+        "ion-picker-legacy",
         "ion-popover"
       ],
       "dependencies": [],
@@ -2600,7 +2600,7 @@
         "ion-modal": [
           "ion-backdrop"
         ],
-        "ion-picker": [
+        "ion-picker-legacy": [
           "ion-backdrop"
         ],
         "ion-popover": [
@@ -7913,6 +7913,11 @@
           "name": "--wheel-highlight-background",
           "annotation": "prop",
           "docs": "The background of the highlight under the selected item when using a wheel style layout, or in the month/year picker for grid style layouts."
+        },
+        {
+          "name": "--wheel-highlight-border-radius",
+          "annotation": "prop",
+          "docs": "The 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."
         }
       ],
       "slots": [
@@ -7971,32 +7976,27 @@
       "dependencies": [
         "ion-buttons",
         "ion-button",
-        "ion-picker-internal",
-        "ion-picker-column-internal",
-        "ion-item",
-        "ion-label",
+        "ion-picker",
+        "ion-picker-column",
+        "ion-picker-column-option",
         "ion-icon",
+        "ion-ripple-effect",
         "ion-popover"
       ],
       "dependencyGraph": {
         "ion-datetime": [
           "ion-buttons",
           "ion-button",
-          "ion-picker-internal",
-          "ion-picker-column-internal",
-          "ion-item",
-          "ion-label",
+          "ion-picker",
+          "ion-picker-column",
+          "ion-picker-column-option",
           "ion-icon",
+          "ion-ripple-effect",
           "ion-popover"
         ],
         "ion-button": [
           "ion-ripple-effect"
         ],
-        "ion-item": [
-          "ion-icon",
-          "ion-ripple-effect",
-          "ion-note"
-        ],
         "ion-popover": [
           "ion-backdrop"
         ]
@@ -12027,7 +12027,6 @@
         }
       ],
       "dependents": [
-        "ion-datetime",
         "ion-select-popover"
       ],
       "dependencies": [
@@ -12041,9 +12040,6 @@
           "ion-ripple-effect",
           "ion-note"
         ],
-        "ion-datetime": [
-          "ion-item"
-        ],
         "ion-select-popover": [
           "ion-item"
         ]
@@ -13036,14 +13032,10 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "ion-datetime",
         "ion-select-popover"
       ],
       "dependencies": [],
       "dependencyGraph": {
-        "ion-datetime": [
-          "ion-label"
-        ],
         "ion-select-popover": [
           "ion-label"
         ]
@@ -16238,6 +16230,28 @@
             }
           ]
         },
+        {
+          "name": "getLength",
+          "returns": {
+            "type": "Promise<number>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<number>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<number>"
+          },
+          "signature": "getLength() => Promise<number>",
+          "parameters": [],
+          "docs": "Returns the number of views in the stack.",
+          "docsTags": []
+        },
         {
           "name": "getPrevious",
           "returns": {
@@ -17423,7 +17437,7 @@
     },
     {
       "filePath": "src/components/picker/picker.tsx",
-      "encapsulation": "scoped",
+      "encapsulation": "shadow",
       "tag": "ion-picker",
       "docs": "",
       "docsTags": [
@@ -17433,6 +17447,442 @@
         }
       ],
       "usage": {},
+      "props": [
+        {
+          "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
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [
+        {
+          "event": "touchstart",
+          "capture": false,
+          "passive": true
+        }
+      ],
+      "styles": [
+        {
+          "name": "--fade-background-rgb",
+          "annotation": "prop",
+          "docs": "Background of the gradient covering non-selected items in rgb format"
+        },
+        {
+          "name": "--highlight-background",
+          "annotation": "prop",
+          "docs": "Background of the picker highlight for the selected item"
+        },
+        {
+          "name": "--highlight-border-radius",
+          "annotation": "prop",
+          "docs": "Border radius of the picker highlight for the selected item"
+        }
+      ],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "ion-datetime"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "ion-datetime": [
+          "ion-picker"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/picker-column/picker-column.tsx",
+      "encapsulation": "shadow",
+      "tag": "ion-picker-column",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "virtualProp",
+          "text": "{\"ios\" | \"md\"} mode - The mode determines which platform styles to use."
+        },
+        {
+          "name": "slot",
+          "text": "prefix - Content to show on the left side of the picker options."
+        },
+        {
+          "name": "slot",
+          "text": "suffix - Content to show on the right side of the picker options."
+        }
+      ],
+      "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": [],
+          "default": "'primary'",
+          "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": "disabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": false,
+          "docs": "If `true`, the user cannot interact with the picker.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "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": "value",
+          "type": "number | string | undefined",
+          "complexType": {
+            "original": "string | number",
+            "resolved": "number | string | undefined",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "value",
+          "reflectToAttr": false,
+          "docs": "The selected option in the picker.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets focus on the scrollable container within the picker column.\nUse this method instead of the global `pickerColumn.focus()`.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "ionChange",
+          "detail": "PickerColumnChangeEventDetail",
+          "bubbles": true,
+          "complexType": {
+            "original": "PickerColumnChangeEventDetail",
+            "resolved": "PickerColumnChangeEventDetail",
+            "references": {
+              "PickerColumnChangeEventDetail": {
+                "location": "import",
+                "path": "./picker-column-interfaces",
+                "id": "src/components/picker-column/picker-column-interfaces.ts::PickerColumnChangeEventDetail"
+              }
+            }
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the value has changed.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "prefix",
+          "docs": "Content to show on the left side of the picker options."
+        },
+        {
+          "name": "suffix",
+          "docs": "Content to show on the right side of the picker options."
+        }
+      ],
+      "parts": [],
+      "dependents": [
+        "ion-datetime"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "ion-datetime": [
+          "ion-picker-column"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/picker-column-option/picker-column-option.tsx",
+      "encapsulation": "shadow",
+      "tag": "ion-picker-column-option",
+      "docs": "",
+      "docsTags": [],
+      "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": [],
+          "default": "'primary'",
+          "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": "disabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": false,
+          "docs": "If `true`, the user cannot interact with the picker column option.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "value",
+          "type": "any",
+          "complexType": {
+            "original": "any | null",
+            "resolved": "any",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "value",
+          "reflectToAttr": false,
+          "docs": "The text value of the option.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "any"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "ion-datetime"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "ion-datetime": [
+          "ion-picker-column-option"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/picker-legacy/picker.tsx",
+      "encapsulation": "scoped",
+      "tag": "ion-picker-legacy",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "virtualProp",
+          "text": "{\"ios\" | \"md\"} mode - The mode determines which platform styles to use."
+        }
+      ],
+      "usage": {},
       "props": [
         {
           "name": "animated",
@@ -17488,7 +17938,7 @@
               "PickerButton": {
                 "location": "import",
                 "path": "./picker-interface",
-                "id": "src/components/picker/picker-interface.ts::PickerButton"
+                "id": "src/components/picker-legacy/picker-interface.ts::PickerButton"
               }
             }
           },
@@ -17515,7 +17965,7 @@
               "PickerColumn": {
                 "location": "import",
                 "path": "./picker-interface",
-                "id": "src/components/picker/picker-interface.ts::PickerColumn"
+                "id": "src/components/picker-legacy/picker-interface.ts::PickerColumn"
               }
             }
           },
@@ -17851,7 +18301,7 @@
               "PickerColumn": {
                 "location": "import",
                 "path": "./picker-interface",
-                "id": "src/components/picker/picker-interface.ts::PickerColumn"
+                "id": "src/components/picker-legacy/picker-interface.ts::PickerColumn"
               }
             },
             "return": "Promise<PickerColumn | undefined>"
@@ -18168,12 +18618,12 @@
       "dependents": [],
       "dependencies": [
         "ion-backdrop",
-        "ion-picker-column"
+        "ion-picker-legacy-column"
       ],
       "dependencyGraph": {
-        "ion-picker": [
+        "ion-picker-legacy": [
           "ion-backdrop",
-          "ion-picker-column"
+          "ion-picker-legacy-column"
         ]
       }
     },
@@ -21495,6 +21945,7 @@
         "ion-button",
         "ion-card",
         "ion-chip",
+        "ion-datetime",
         "ion-datetime-button",
         "ion-fab-button",
         "ion-item",
@@ -21524,6 +21975,9 @@
         "ion-chip": [
           "ion-ripple-effect"
         ],
+        "ion-datetime": [
+          "ion-ripple-effect"
+        ],
         "ion-datetime-button": [
           "ion-ripple-effect"
         ],
@@ -29325,7 +29779,7 @@
       "path": "src/interface.d.ts"
     },
     "src/components/action-sheet/action-sheet-interface.ts::ActionSheetButton": {
-      "declaration": "export interface ActionSheetButton<T = any> {\n  text?: string;\n  role?: LiteralUnion<'cancel' | 'destructive' | 'selected', string>;\n  icon?: string;\n  cssClass?: string | string[];\n  id?: string;\n  htmlAttributes?: { [key: string]: any };\n  handler?: () => boolean | void | Promise<boolean | void>;\n  data?: T;\n}",
+      "declaration": "export interface ActionSheetButton<T = any> {\n  text?: string;\n  role?: 'cancel' | 'destructive' | 'selected' | string;\n  icon?: string;\n  cssClass?: string | string[];\n  id?: string;\n  htmlAttributes?: { [key: string]: any };\n  handler?: () => boolean | void | Promise<boolean | void>;\n  data?: T;\n}",
       "docstring": "",
       "path": "src/components/action-sheet/action-sheet-interface.ts"
     },
@@ -29340,7 +29794,7 @@
       "path": "src/utils/sanitization/index.ts"
     },
     "src/components/alert/alert-interface.ts::AlertButton": {
-      "declaration": "export interface AlertButton {\n  text: string;\n  role?: LiteralUnion<'cancel' | 'destructive', string>;\n  cssClass?: string | string[];\n  id?: string;\n  htmlAttributes?: { [key: string]: any };\n  // TODO(FW-2832): type\n  handler?: (value: any) => AlertButtonOverlayHandler | Promise<AlertButtonOverlayHandler>;\n}",
+      "declaration": "export interface AlertButton {\n  text: string;\n  role?: 'cancel' | 'destructive' | string;\n  cssClass?: string | string[];\n  id?: string;\n  htmlAttributes?: { [key: string]: any };\n  // TODO(FW-2832): type\n  handler?: (value: any) => AlertButtonOverlayHandler | Promise<AlertButtonOverlayHandler>;\n}",
       "docstring": "",
       "path": "src/components/alert/alert-interface.ts"
     },
@@ -29404,15 +29858,20 @@
       "docstring": "",
       "path": "src/components/datetime/datetime-interface.ts"
     },
-    "src/components/picker-column-internal/picker-column-internal-interfaces.ts::PickerColumnItem": {
-      "declaration": "export interface PickerColumnItem {\n  text: string;\n  value: string | number;\n  disabled?: boolean;\n}",
+    "src/components/picker-column/picker-column-interfaces.ts::PickerColumnChangeEventDetail": {
+      "declaration": "export interface PickerColumnChangeEventDetail {\n  value: PickerColumnValue;\n}",
+      "docstring": "",
+      "path": "src/components/picker-column/picker-column-interfaces.ts"
+    },
+    "src/components/picker-column/picker-column-interfaces.ts::PickerColumnValue": {
+      "declaration": "export type PickerColumnValue = string | number | undefined;",
       "docstring": "",
-      "path": "src/components/picker-column-internal/picker-column-internal-interfaces.ts"
+      "path": "src/components/picker-column/picker-column-interfaces.ts"
     },
-    "src/components/picker-internal/picker-internal-interfaces.ts::PickerInternalChangeEventDetail": {
-      "declaration": "export interface PickerInternalChangeEventDetail {\n  useInputMode: boolean;\n  inputModeColumn?: HTMLIonPickerColumnInternalElement;\n}",
+    "src/components/picker/picker-interfaces.ts::PickerChangeEventDetail": {
+      "declaration": "export interface PickerChangeEventDetail {\n  useInputMode: boolean;\n  inputModeColumn?: HTMLIonPickerColumnElement;\n}",
       "docstring": "",
-      "path": "src/components/picker-internal/picker-internal-interfaces.ts"
+      "path": "src/components/picker/picker-interfaces.ts"
     },
     "src/components/spinner/spinner-configs.ts::SpinnerTypes": {
       "declaration": "\"bubbles\" | \"circles\" | \"circular\" | \"crescent\" | \"dots\" | \"lines\" | \"lines-small\" | \"lines-sharp\" | \"lines-sharp-small\"",
@@ -29519,15 +29978,15 @@
       "docstring": "",
       "path": "src/components/router/utils/interface.ts"
     },
-    "src/components/picker/picker-interface.ts::PickerButton": {
+    "src/components/picker-legacy/picker-interface.ts::PickerButton": {
       "declaration": "export interface PickerButton {\n  text?: string;\n  role?: string;\n  cssClass?: string | string[];\n  handler?: (value: any) => boolean | void;\n}",
       "docstring": "",
-      "path": "src/components/picker/picker-interface.ts"
+      "path": "src/components/picker-legacy/picker-interface.ts"
     },
-    "src/components/picker/picker-interface.ts::PickerColumn": {
+    "src/components/picker-legacy/picker-interface.ts::PickerColumn": {
       "declaration": "export interface PickerColumn {\n  name: string;\n  align?: string;\n  /**\n   * Changing this value allows the initial value of a picker column to be set.\n   */\n  selectedIndex?: number;\n  prevSelected?: number;\n  prefix?: string;\n  suffix?: string;\n  options: PickerColumnOption[];\n  cssClass?: string | string[];\n  columnWidth?: string;\n  prefixWidth?: string;\n  suffixWidth?: string;\n  optionsWidth?: string;\n}",
       "docstring": "",
-      "path": "src/components/picker/picker-interface.ts"
+      "path": "src/components/picker-legacy/picker-interface.ts"
     },
     "src/components/popover/popover-interface.ts::TriggerAction": {
       "declaration": "export type TriggerAction = 'click' | 'hover' | 'context-menu';",
@@ -29690,7 +30149,7 @@
       "path": "src/components/toast/toast-interface.ts"
     },
     "src/components/toast/toast-interface.ts::ToastButton": {
-      "declaration": "export interface ToastButton {\n  text?: string;\n  icon?: string;\n  side?: 'start' | 'end';\n  role?: LiteralUnion<'cancel', string>;\n  /**\n   * @deprecated Use the toast button's CSS Shadow Parts instead.\n   */\n  cssClass?: string | string[];\n  htmlAttributes?: { [key: string]: any };\n  handler?: () => boolean | void | Promise<boolean | void>;\n}",
+      "declaration": "export interface ToastButton {\n  text?: string;\n  icon?: string;\n  side?: 'start' | 'end';\n  role?: 'cancel' | string;\n\n  /**\n   * @deprecated Use the toast button's CSS Shadow Parts instead.\n   */\n  cssClass?: string | string[];\n  htmlAttributes?: { [key: string]: any };\n  handler?: () => boolean | void | Promise<boolean | void>;\n}",
       "docstring": "",
       "path": "src/components/toast/toast-interface.ts"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ionic/docs",
-  "version": "7.6.7-dev.11706625796.1b3c1ab2",
+  "version": "7.6.7-dev.11706824245.18d35376",
   "description": "Pre-packaged API documentation for the Ionic docs.",
   "main": "core.json",
   "types": "core.d.ts",