@ionic/docs 8.3.5-nightly.20241101 → 8.4.0

package/core.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2024-11-01T06:09:33",
+  "timestamp": "2024-11-04T21:25:01",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
@@ -4831,7 +4831,8 @@
       ],
       "dependents": [
         "ion-datetime",
-        "ion-input-password-toggle"
+        "ion-input-password-toggle",
+        "ion-select-modal"
       ],
       "dependencies": [
         "ion-ripple-effect"
@@ -4845,6 +4846,9 @@
         ],
         "ion-input-password-toggle": [
           "ion-button"
+        ],
+        "ion-select-modal": [
+          "ion-button"
         ]
       }
     },
@@ -4886,12 +4890,16 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "ion-datetime"
+        "ion-datetime",
+        "ion-select-modal"
       ],
       "dependencies": [],
       "dependencyGraph": {
         "ion-datetime": [
           "ion-buttons"
+        ],
+        "ion-select-modal": [
+          "ion-buttons"
         ]
       }
     },
@@ -6240,10 +6248,14 @@
         }
       ],
       "dependents": [
+        "ion-select-modal",
         "ion-select-popover"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-checkbox"
+        ],
         "ion-select-popover": [
           "ion-checkbox"
         ]
@@ -7681,9 +7693,15 @@
           "docs": "The scrollable container of the content."
         }
       ],
-      "dependents": [],
+      "dependents": [
+        "ion-select-modal"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-content"
+        ]
+      }
     },
     {
       "filePath": "src/components/datetime/datetime.tsx",
@@ -10423,9 +10441,15 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [],
+      "dependents": [
+        "ion-select-modal"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-header"
+        ]
+      }
     },
     {
       "filePath": "src/components/img/img.tsx",
@@ -13436,6 +13460,7 @@
         }
       ],
       "dependents": [
+        "ion-select-modal",
         "ion-select-popover"
       ],
       "dependencies": [
@@ -13447,6 +13472,9 @@
           "ion-icon",
           "ion-ripple-effect"
         ],
+        "ion-select-modal": [
+          "ion-item"
+        ],
         "ion-select-popover": [
           "ion-item"
         ]
@@ -14659,10 +14687,14 @@
       "slots": [],
       "parts": [],
       "dependents": [
+        "ion-select-modal",
         "ion-select-popover"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-list"
+        ],
         "ion-select-popover": [
           "ion-list"
         ]
@@ -15925,12 +15957,17 @@
             "docs": ""
           },
           "complexType": {
-            "signature": "(animated?: boolean) => Promise<boolean>",
+            "signature": "(animated?: boolean, role?: string) => Promise<boolean>",
             "parameters": [
               {
                 "name": "animated",
                 "type": "boolean",
                 "docs": ""
+              },
+              {
+                "name": "role",
+                "type": "string | undefined",
+                "docs": ""
               }
             ],
             "references": {
@@ -15941,12 +15978,17 @@
             },
             "return": "Promise<boolean>"
           },
-          "signature": "close(animated?: boolean) => Promise<boolean>",
+          "signature": "close(animated?: boolean, role?: string) => Promise<boolean>",
           "parameters": [
             {
               "name": "animated",
               "type": "boolean",
               "docs": ""
+            },
+            {
+              "name": "role",
+              "type": "string | undefined",
+              "docs": ""
             }
           ],
           "docs": "Closes the menu. If the menu is already closed or it can't be closed,\nit returns `false`.",
@@ -16037,7 +16079,7 @@
             "docs": ""
           },
           "complexType": {
-            "signature": "(shouldOpen: boolean, animated?: boolean) => Promise<boolean>",
+            "signature": "(shouldOpen: boolean, animated?: boolean, role?: string) => Promise<boolean>",
             "parameters": [
               {
                 "name": "shouldOpen",
@@ -16048,6 +16090,11 @@
                 "name": "animated",
                 "type": "boolean",
                 "docs": ""
+              },
+              {
+                "name": "role",
+                "type": "string | undefined",
+                "docs": ""
               }
             ],
             "references": {
@@ -16058,7 +16105,7 @@
             },
             "return": "Promise<boolean>"
           },
-          "signature": "setOpen(shouldOpen: boolean, animated?: boolean) => Promise<boolean>",
+          "signature": "setOpen(shouldOpen: boolean, animated?: boolean, role?: string) => Promise<boolean>",
           "parameters": [
             {
               "name": "shouldOpen",
@@ -16069,6 +16116,11 @@
               "name": "animated",
               "type": "boolean",
               "docs": ""
+            },
+            {
+              "name": "role",
+              "type": "string | undefined",
+              "docs": ""
             }
           ],
           "docs": "Opens or closes the button.\nIf the operation can't be completed successfully, it returns `false`.",
@@ -16112,12 +16164,18 @@
       "events": [
         {
           "event": "ionDidClose",
-          "detail": "void",
+          "detail": "MenuCloseEventDetail",
           "bubbles": true,
           "complexType": {
-            "original": "void",
-            "resolved": "void",
-            "references": {}
+            "original": "MenuCloseEventDetail",
+            "resolved": "MenuCloseEventDetail",
+            "references": {
+              "MenuCloseEventDetail": {
+                "location": "import",
+                "path": "./menu-interface",
+                "id": "src/components/menu/menu-interface.ts::MenuCloseEventDetail"
+              }
+            }
           },
           "cancelable": true,
           "composed": true,
@@ -16140,12 +16198,18 @@
         },
         {
           "event": "ionWillClose",
-          "detail": "void",
+          "detail": "MenuCloseEventDetail",
           "bubbles": true,
           "complexType": {
-            "original": "void",
-            "resolved": "void",
-            "references": {}
+            "original": "MenuCloseEventDetail",
+            "resolved": "MenuCloseEventDetail",
+            "references": {
+              "MenuCloseEventDetail": {
+                "location": "import",
+                "path": "./menu-interface",
+                "id": "src/components/menu/menu-interface.ts::MenuCloseEventDetail"
+              }
+            }
           },
           "cancelable": true,
           "composed": true,
@@ -17808,13 +17872,18 @@
           "docs": "The handle that is displayed at the top of the sheet modal when `handle=\"true\"`."
         }
       ],
-      "dependents": [],
+      "dependents": [
+        "ion-select"
+      ],
       "dependencies": [
         "ion-backdrop"
       ],
       "dependencyGraph": {
         "ion-modal": [
           "ion-backdrop"
+        ],
+        "ion-select": [
+          "ion-modal"
         ]
       }
     },
@@ -22392,10 +22461,14 @@
         }
       ],
       "dependents": [
+        "ion-select-modal",
         "ion-select-popover"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-radio"
+        ],
         "ion-select-popover": [
           "ion-radio"
         ]
@@ -22546,10 +22619,14 @@
       "slots": [],
       "parts": [],
       "dependents": [
+        "ion-select-modal",
         "ion-select-popover"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-radio-group"
+        ],
         "ion-select-popover": [
           "ion-radio-group"
         ]
@@ -26403,6 +26480,12 @@
         }
       ],
       "listeners": [
+        {
+          "event": "ionSegmentViewScroll",
+          "target": "body",
+          "capture": false,
+          "passive": false
+        },
         {
           "event": "keydown",
           "capture": false,
@@ -26454,6 +26537,30 @@
       ],
       "usage": {},
       "props": [
+        {
+          "name": "contentId",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "content-id",
+          "reflectToAttr": true,
+          "docs": "The `id` of the segment content.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "disabled",
           "type": "boolean",
@@ -26978,6 +27085,102 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/segment-content/segment-content.tsx",
+      "encapsulation": "shadow",
+      "tag": "ion-segment-content",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/segment-view/segment-view.tsx",
+      "encapsulation": "shadow",
+      "tag": "ion-segment-view",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "disabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "disabled",
+          "reflectToAttr": false,
+          "docs": "If `true`, the segment view cannot be interacted with.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "ionSegmentViewScroll",
+          "detail": "SegmentViewScrollEvent",
+          "bubbles": true,
+          "complexType": {
+            "original": "SegmentViewScrollEvent",
+            "resolved": "SegmentViewScrollEvent",
+            "references": {
+              "SegmentViewScrollEvent": {
+                "location": "import",
+                "path": "./segment-view-interface",
+                "id": "src/components/segment-view/segment-view-interface.ts::SegmentViewScrollEvent"
+              }
+            }
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the segment view is scrolled.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "scroll",
+          "capture": false,
+          "passive": true
+        },
+        {
+          "event": "touchstart",
+          "capture": false,
+          "passive": true
+        },
+        {
+          "event": "touchend",
+          "capture": false,
+          "passive": true
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "src/components/select/select.tsx",
       "encapsulation": "shadow",
@@ -27224,10 +27427,10 @@
         },
         {
           "name": "interface",
-          "type": "\"action-sheet\" | \"alert\" | \"popover\"",
+          "type": "\"action-sheet\" | \"alert\" | \"modal\" | \"popover\"",
           "complexType": {
             "original": "SelectInterface",
-            "resolved": "\"action-sheet\" | \"alert\" | \"popover\"",
+            "resolved": "\"action-sheet\" | \"alert\" | \"modal\" | \"popover\"",
             "references": {
               "SelectInterface": {
                 "location": "import",
@@ -27239,7 +27442,7 @@
           "mutable": false,
           "attr": "interface",
           "reflectToAttr": false,
-          "docs": "The interface the select should use: `action-sheet`, `popover` or `alert`.",
+          "docs": "The interface the select should use: `action-sheet`, `popover`, `alert`, or `modal`.",
           "docsTags": [],
           "default": "'alert'",
           "values": [
@@ -27251,6 +27454,10 @@
               "value": "alert",
               "type": "string"
             },
+            {
+              "value": "modal",
+              "type": "string"
+            },
             {
               "value": "popover",
               "type": "string"
@@ -27270,7 +27477,7 @@
           "mutable": false,
           "attr": "interface-options",
           "reflectToAttr": false,
-          "docs": "Any additional options that the `alert`, `action-sheet` or `popover` interface\ncan take. See the [ion-alert docs](./alert), the\n[ion-action-sheet docs](./action-sheet) and the\n[ion-popover docs](./popover) for the\ncreate options for each interface.\n\nNote: `interfaceOptions` will not override `inputs` or `buttons` with the `alert` interface.",
+          "docs": "Any additional options that the `alert`, `action-sheet` or `popover` interface\ncan take. See the [ion-alert docs](./alert), the\n[ion-action-sheet docs](./action-sheet), the\n[ion-popover docs](./popover), and the [ion-modal docs](./modal) for the\ncreate options for each interface.\n\nNote: `interfaceOptions` will not override `inputs` or `buttons` with the `alert` interface.",
           "docsTags": [],
           "default": "{}",
           "values": [
@@ -27617,6 +27824,14 @@
               "HTMLElement": {
                 "location": "global",
                 "id": "global::HTMLElement"
+              },
+              "HTMLIonRadioElement": {
+                "location": "global",
+                "id": "global::HTMLIonRadioElement"
+              },
+              "HTMLIonCheckboxElement": {
+                "location": "global",
+                "id": "global::HTMLIonCheckboxElement"
               }
             },
             "return": "Promise<any>"
@@ -27953,6 +28168,8 @@
         "ion-popover",
         "ion-action-sheet",
         "ion-alert",
+        "ion-select-modal",
+        "ion-modal",
         "ion-icon"
       ],
       "dependencyGraph": {
@@ -27961,6 +28178,8 @@
           "ion-popover",
           "ion-action-sheet",
           "ion-alert",
+          "ion-select-modal",
+          "ion-modal",
           "ion-icon"
         ],
         "ion-select-popover": [
@@ -27987,6 +28206,157 @@
         "ion-alert": [
           "ion-ripple-effect",
           "ion-backdrop"
+        ],
+        "ion-select-modal": [
+          "ion-radio-group",
+          "ion-item",
+          "ion-radio",
+          "ion-checkbox",
+          "ion-header",
+          "ion-toolbar",
+          "ion-title",
+          "ion-buttons",
+          "ion-button",
+          "ion-content",
+          "ion-list"
+        ],
+        "ion-button": [
+          "ion-ripple-effect"
+        ],
+        "ion-modal": [
+          "ion-backdrop"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/select-modal/select-modal.tsx",
+      "encapsulation": "scoped",
+      "tag": "ion-select-modal",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "header",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "header",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "multiple",
+          "type": "boolean | undefined",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "multiple",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "options",
+          "type": "SelectModalOption[]",
+          "complexType": {
+            "original": "SelectModalOption[]",
+            "resolved": "SelectModalOption[]",
+            "references": {
+              "SelectModalOption": {
+                "location": "import",
+                "path": "./select-modal-interface",
+                "id": "src/components/select-modal/select-modal-interface.ts::SelectModalOption"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "[]",
+          "values": [
+            {
+              "type": "SelectModalOption[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "ion-select"
+      ],
+      "dependencies": [
+        "ion-radio-group",
+        "ion-item",
+        "ion-radio",
+        "ion-checkbox",
+        "ion-header",
+        "ion-toolbar",
+        "ion-title",
+        "ion-buttons",
+        "ion-button",
+        "ion-content",
+        "ion-list"
+      ],
+      "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-radio-group",
+          "ion-item",
+          "ion-radio",
+          "ion-checkbox",
+          "ion-header",
+          "ion-toolbar",
+          "ion-title",
+          "ion-buttons",
+          "ion-button",
+          "ion-content",
+          "ion-list"
+        ],
+        "ion-item": [
+          "ion-icon",
+          "ion-ripple-effect"
+        ],
+        "ion-button": [
+          "ion-ripple-effect"
+        ],
+        "ion-select": [
+          "ion-select-modal"
         ]
       }
     },
@@ -30829,9 +31199,15 @@
       ],
       "slots": [],
       "parts": [],
-      "dependents": [],
+      "dependents": [
+        "ion-select-modal"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-title"
+        ]
+      }
     },
     {
       "filePath": "src/components/toast/toast.tsx",
@@ -32827,9 +33203,15 @@
         }
       ],
       "parts": [],
-      "dependents": [],
+      "dependents": [
+        "ion-select-modal"
+      ],
       "dependencies": [],
-      "dependencyGraph": {}
+      "dependencyGraph": {
+        "ion-select-modal": [
+          "ion-toolbar"
+        ]
+      }
     }
   ],
   "typeLibrary": {
@@ -33003,6 +33385,11 @@
       "docstring": "",
       "path": "src/components/menu/menu-interface.ts"
     },
+    "src/components/menu/menu-interface.ts::MenuCloseEventDetail": {
+      "declaration": "export interface MenuCloseEventDetail {\n  role?: string;\n}",
+      "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": "",
@@ -33183,13 +33570,18 @@
       "docstring": "",
       "path": "src/components/segment-button/segment-button-interface.ts"
     },
+    "src/components/segment-view/segment-view-interface.ts::SegmentViewScrollEvent": {
+      "declaration": "export interface SegmentViewScrollEvent {\n  scrollRatio: number;\n  isManualScroll: boolean;\n}",
+      "docstring": "",
+      "path": "src/components/segment-view/segment-view-interface.ts"
+    },
     "src/components/select/select-interface.ts::SelectCompareFn": {
       "declaration": "(currentValue: any, compareValue: any) => boolean",
       "docstring": "",
       "path": "src/components/select/select-interface.ts"
     },
     "src/components/select/select-interface.ts::SelectInterface": {
-      "declaration": "export type SelectInterface = 'action-sheet' | 'popover' | 'alert';",
+      "declaration": "export type SelectInterface = 'action-sheet' | 'popover' | 'alert' | 'modal';",
       "docstring": "",
       "path": "src/components/select/select-interface.ts"
     },
@@ -33198,6 +33590,11 @@
       "docstring": "",
       "path": "src/components/select/select-interface.ts"
     },
+    "src/components/select-modal/select-modal-interface.ts::SelectModalOption": {
+      "declaration": "export interface SelectModalOption {\n  text: string;\n  value: string;\n  disabled: boolean;\n  checked: boolean;\n  cssClass?: string | string[];\n  handler?: (value: any) => boolean | void | { [key: string]: any };\n}",
+      "docstring": "",
+      "path": "src/components/select-modal/select-modal-interface.ts"
+    },
     "src/components/select-popover/select-popover-interface.ts::SelectPopoverOption": {
       "declaration": "export interface SelectPopoverOption {\n  text: string;\n  value: string;\n  disabled: boolean;\n  checked: boolean;\n  cssClass?: string | string[];\n  handler?: (value: any) => boolean | void | { [key: string]: any };\n}",
       "docstring": "",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ionic/docs",
-  "version": "8.3.5-nightly.20241101",
+  "version": "8.4.0",
   "description": "Pre-packaged API documentation for the Ionic docs.",
   "main": "core.json",
   "types": "core.d.ts",