@ionic/docs 8.8.16-dev.11784841344.1aa1a41c → 8.8.16-dev.11784914346.10d0804c

package/core.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2026-07-23T21:18:13",
+  "timestamp": "2026-07-24T17:34:52",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.43.5",
@@ -14122,7 +14122,13 @@
           "attr": "collapse",
           "reflectToAttr": false,
           "docs": "Describes the scroll effect that will be applied to the footer.\nOnly applies when the theme is `\"ios\"`.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use `scrollEffect` instead."
+            }
+          ],
+          "deprecation": "Use `scrollEffect` instead.",
           "values": [
             {
               "value": "fade",
@@ -14158,6 +14164,44 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "scrollEffect",
+          "type": "\"fade\" | \"hide\" | undefined",
+          "complexType": {
+            "original": "FooterScrollEffect",
+            "resolved": "\"fade\" | \"hide\" | undefined",
+            "references": {
+              "FooterScrollEffect": {
+                "location": "import",
+                "path": "./footer-interface",
+                "id": "src/components/footer/footer-interface.ts::FooterScrollEffect",
+                "referenceLocation": "FooterScrollEffect"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "scroll-effect",
+          "reflectToAttr": true,
+          "docs": "Describes the scroll effect that will be applied to the footer.\n`\"hide\"` slides the footer out of view when scrolling down and back in\nwhen scrolling up.\n`\"fade\"` fades the toolbar background on scroll.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "fade",
+              "type": "string"
+            },
+            {
+              "value": "hide",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "theme",
           "type": "\"ios\" | \"md\" | \"ionic\"",
@@ -14747,7 +14791,13 @@
           "attr": "collapse",
           "reflectToAttr": false,
           "docs": "Describes the scroll effect that will be applied to the header.\nOnly applies when the theme is `\"ios\"`.\n\nTypically used for [Collapsible Large Titles](https://ionicframework.com/docs/api/title#collapsible-large-titles)",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use `scrollEffect` instead."
+            }
+          ],
+          "deprecation": "Use `scrollEffect` instead.",
           "values": [
             {
               "value": "condense",
@@ -14816,6 +14866,48 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "scrollEffect",
+          "type": "\"condense\" | \"fade\" | \"hide\" | undefined",
+          "complexType": {
+            "original": "HeaderScrollEffect",
+            "resolved": "\"condense\" | \"fade\" | \"hide\" | undefined",
+            "references": {
+              "HeaderScrollEffect": {
+                "location": "import",
+                "path": "./header-interface",
+                "id": "src/components/header/header-interface.ts::HeaderScrollEffect",
+                "referenceLocation": "HeaderScrollEffect"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "scroll-effect",
+          "reflectToAttr": true,
+          "docs": "Describes the scroll effect that will be applied to the header.\n`\"hide\"` slides the header out of view when scrolling down and back in\nwhen scrolling up.\n`\"condense\"` collapses the large title into the main toolbar on scroll.\n`\"fade\"` fades the toolbar background on scroll.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "condense",
+              "type": "string"
+            },
+            {
+              "value": "fade",
+              "type": "string"
+            },
+            {
+              "value": "hide",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "theme",
           "type": "\"ios\" | \"md\" | \"ionic\"",
@@ -40931,35 +41023,6 @@
           "getter": false,
           "setter": false
         },
-        {
-          "name": "hideOnScroll",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "hide-on-scroll",
-          "reflectToAttr": false,
-          "docs": "If `true`, the tab bar will be hidden when the user scrolls down\nand shown when the user scrolls up.\nOnly applies when the theme is `\"ionic\"` and `expand` is `\"compact\"`.",
-          "docsTags": [
-            {
-              "name": "default",
-              "text": "false"
-            }
-          ],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": false,
-          "required": false,
-          "getter": false,
-          "setter": false
-        },
         {
           "name": "mode",
           "type": "\"ios\" | \"md\"",
@@ -40981,6 +41044,40 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "scrollEffect",
+          "type": "\"hide\" | undefined",
+          "complexType": {
+            "original": "TabBarScrollEffect",
+            "resolved": "\"hide\" | undefined",
+            "references": {
+              "TabBarScrollEffect": {
+                "location": "import",
+                "path": "./tab-bar-interface",
+                "id": "src/components/tab-bar/tab-bar-interface.ts::TabBarScrollEffect",
+                "referenceLocation": "TabBarScrollEffect"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "scroll-effect",
+          "reflectToAttr": true,
+          "docs": "Describes the scroll effect that will be applied to the tab bar.\n`\"hide\"` slides the tab bar out of view when scrolling down and back in\nwhen scrolling up.\n\nNote: `\"hide\"` is ignored when the tab bar is nested inside an\n`ion-footer` to avoid leaving an empty footer visible on screen.\nSet `scroll-effect=\"hide\"` on the footer instead so the entire\nfooter hides together.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "hide",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false,
+          "getter": false,
+          "setter": false
+        },
         {
           "name": "selectedTab",
           "type": "string | undefined",
@@ -46846,6 +46943,11 @@
       "docstring": "",
       "path": "src/components/picker/picker-interfaces.ts"
     },
+    "src/components/footer/footer-interface.ts::FooterScrollEffect": {
+      "declaration": "export type FooterScrollEffect = 'hide' | 'fade';",
+      "docstring": "",
+      "path": "src/components/footer/footer-interface.ts"
+    },
     "src/components/gallery/gallery-interface.ts::GalleryColumns": {
       "declaration": "export type GalleryColumns = GalleryBreakpoints | string | number;",
       "docstring": "",
@@ -46856,6 +46958,11 @@
       "docstring": "",
       "path": "src/components/gallery/gallery-interface.ts"
     },
+    "src/components/header/header-interface.ts::HeaderScrollEffect": {
+      "declaration": "export type HeaderScrollEffect = 'hide' | 'condense' | 'fade';",
+      "docstring": "",
+      "path": "src/components/header/header-interface.ts"
+    },
     "src/components/spinner/spinner-configs.ts::SpinnerTypes": {
       "declaration": "\"lines\" | \"bubbles\" | \"circles\" | \"circular\" | \"crescent\" | \"dots\" | \"lines-small\" | \"lines-sharp\" | \"lines-sharp-small\"",
       "docstring": "",
@@ -47151,6 +47258,11 @@
       "docstring": "",
       "path": "src/components/select-popover/select-popover-interface.ts"
     },
+    "src/components/tab-bar/tab-bar-interface.ts::TabBarScrollEffect": {
+      "declaration": "\"hide\"",
+      "docstring": "",
+      "path": "src/components/tab-bar/tab-bar-interface.ts"
+    },
     "src/components/tab-bar/tab-bar-interface.ts::TabBarChangedEventDetail": {
       "declaration": "export interface TabBarChangedEventDetail {\n  tab?: string;\n}",
       "docstring": "",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ionic/docs",
-  "version": "8.8.16-dev.11784841344.1aa1a41c",
+  "version": "8.8.16-dev.11784914346.10d0804c",
   "description": "Pre-packaged API documentation for the Ionic docs.",
   "main": "core.json",
   "types": "core.d.ts",