@ionic/docs 7.5.8 → 7.6.1-dev.11701921257.1d512d3c

package/core.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-12-06T15:00:22",
+  "timestamp": "2023-12-07T03:56:13",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.8.1",
@@ -4952,6 +4952,10 @@
           "name": "part",
           "text": "container - The container for the checkbox mark."
         },
+        {
+          "name": "part",
+          "text": "label - The label text describing the checkbox."
+        },
         {
           "name": "part",
           "text": "mark - The checkmark used to indicate the checked state."
@@ -5394,6 +5398,10 @@
           "name": "container",
           "docs": "The container for the checkbox mark."
         },
+        {
+          "name": "label",
+          "docs": "The label text describing the checkbox."
+        },
         {
           "name": "mark",
           "docs": "The checkmark used to indicate the checked state."
@@ -9657,6 +9665,14 @@
         {
           "name": "slot",
           "text": "label - The label text to associate with the input. Use the `labelPlacement` property to control where the label is placed relative to the input. Use this if you need to render a label with custom HTML. (EXPERIMENTAL)"
+        },
+        {
+          "name": "slot",
+          "text": "start - Content to display at the leading edge of the input. (EXPERIMENTAL)"
+        },
+        {
+          "name": "slot",
+          "text": "end - Content to display at the trailing edge of the input. (EXPERIMENTAL)"
         }
       ],
       "usage": {},
@@ -11151,9 +11167,17 @@
         }
       ],
       "slots": [
+        {
+          "name": "end",
+          "docs": "Content to display at the trailing edge of the input. (EXPERIMENTAL)"
+        },
         {
           "name": "label",
           "docs": "The label text to associate with the input. Use the `labelPlacement` property to control where the label is placed relative to the input. Use this if you need to render a label with custom HTML. (EXPERIMENTAL)"
+        },
+        {
+          "name": "start",
+          "docs": "Content to display at the leading edge of the input. (EXPERIMENTAL)"
         }
       ],
       "parts": [],
@@ -19324,6 +19348,10 @@
           "name": "part",
           "text": "container - The container for the radio mark."
         },
+        {
+          "name": "part",
+          "text": "label - The label text describing the radio."
+        },
         {
           "name": "part",
           "text": "mark - The checkmark or dot used to indicate the checked state."
@@ -19666,6 +19694,10 @@
           "name": "container",
           "docs": "The container for the radio mark."
         },
+        {
+          "name": "label",
+          "docs": "The label text describing the radio."
+        },
         {
           "name": "mark",
           "docs": "The checkmark or dot used to indicate the checked state."
@@ -19711,6 +19743,42 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "compareWith",
+          "type": "((currentValue: any, compareValue: any) => boolean) | null | string | undefined",
+          "complexType": {
+            "original": "string | RadioGroupCompareFn | null",
+            "resolved": "((currentValue: any, compareValue: any) => boolean) | null | string | undefined",
+            "references": {
+              "RadioGroupCompareFn": {
+                "location": "import",
+                "path": "./radio-group-interface",
+                "id": "src/components/radio-group/radio-group-interface.ts::RadioGroupCompareFn"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "compare-with",
+          "reflectToAttr": false,
+          "docs": "This property allows developers to specify a custom function or property\nname for comparing objects when determining the selected option in the\nion-radio-group. When not specified, the default behavior will use strict\nequality (===) for comparison.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "((currentValue: any, compareValue: any) => boolean)"
+            },
+            {
+              "type": "null"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "name",
           "type": "string",
@@ -19844,6 +19912,10 @@
         {
           "name": "part",
           "text": "bar-active - The active part of the bar."
+        },
+        {
+          "name": "part",
+          "text": "label - The label text describing the range."
         }
       ],
       "usage": {},
@@ -20522,6 +20594,10 @@
           "name": "knob",
           "docs": "The handle that is used to drag the range."
         },
+        {
+          "name": "label",
+          "docs": "The label text describing the range."
+        },
         {
           "name": "pin",
           "docs": "The counter that appears above a knob."
@@ -23781,6 +23857,14 @@
           "name": "slot",
           "text": "label - The label text to associate with the select. Use the `labelPlacement` property to control where the label is placed relative to the select. Use this if you need to render a label with custom HTML."
         },
+        {
+          "name": "slot",
+          "text": "start - Content to display at the leading edge of the select."
+        },
+        {
+          "name": "slot",
+          "text": "end - Content to display at the trailing edge of the select."
+        },
         {
           "name": "part",
           "text": "placeholder - The text displayed in the select when there is no value."
@@ -23909,7 +23993,7 @@
           "mutable": false,
           "attr": "compare-with",
           "reflectToAttr": false,
-          "docs": "A property name or function used to compare object values",
+          "docs": "This property allows developers to specify a custom function or property\nname for comparing objects when determining the selected option in the\nion-select. When not specified, the default behavior will use strict\nequality (===) for comparison.",
           "docsTags": [],
           "values": [
             {
@@ -24596,9 +24680,17 @@
         }
       ],
       "slots": [
+        {
+          "name": "end",
+          "docs": "Content to display at the trailing edge of the select."
+        },
         {
           "name": "label",
           "docs": "The label text to associate with the select. Use the `labelPlacement` property to control where the label is placed relative to the select. Use this if you need to render a label with custom HTML."
+        },
+        {
+          "name": "start",
+          "docs": "Content to display at the leading edge of the select."
         }
       ],
       "parts": [
@@ -26041,6 +26133,14 @@
         {
           "name": "slot",
           "text": "label - The label text to associate with the textarea. Use the `labelPlacement` property to control where the label is placed relative to the textarea. Use this if you need to render a label with custom HTML. (EXPERIMENTAL)"
+        },
+        {
+          "name": "slot",
+          "text": "start - Content to display at the leading edge of the textarea. (EXPERIMENTAL)"
+        },
+        {
+          "name": "slot",
+          "text": "end - Content to display at the trailing edge of the textarea. (EXPERIMENTAL)"
         }
       ],
       "usage": {},
@@ -27091,9 +27191,17 @@
         }
       ],
       "slots": [
+        {
+          "name": "end",
+          "docs": "Content to display at the trailing edge of the textarea. (EXPERIMENTAL)"
+        },
         {
           "name": "label",
           "docs": "The label text to associate with the textarea. Use the `labelPlacement` property to control where the label is placed relative to the textarea. Use this if you need to render a label with custom HTML. (EXPERIMENTAL)"
+        },
+        {
+          "name": "start",
+          "docs": "Content to display at the leading edge of the textarea. (EXPERIMENTAL)"
         }
       ],
       "parts": [],
@@ -27785,6 +27893,37 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "swipeGesture",
+          "type": "\"vertical\" | undefined",
+          "complexType": {
+            "original": "ToastSwipeGestureDirection",
+            "resolved": "\"vertical\" | undefined",
+            "references": {
+              "ToastSwipeGestureDirection": {
+                "location": "import",
+                "path": "./toast-interface",
+                "id": "src/components/toast/toast-interface.ts::ToastSwipeGestureDirection"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "swipe-gesture",
+          "reflectToAttr": false,
+          "docs": "If set to 'vertical', the Toast can be dismissed with\na swipe gesture. The swipe direction is determined by\nthe value of the `position` property:\n`top`: The Toast can be swiped up to dismiss.\n`bottom`: The Toast can be swiped down to dismiss.\n`middle`: The Toast can be swiped up or down to dismiss.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "vertical",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "translucent",
           "type": "boolean",
@@ -28264,6 +28403,10 @@
         {
           "name": "part",
           "text": "handle - The toggle handle, or knob, used to change the checked state."
+        },
+        {
+          "name": "part",
+          "text": "label - The label text describing the toggle."
         }
       ],
       "usage": {},
@@ -28717,6 +28860,10 @@
           "name": "handle",
           "docs": "The toggle handle, or knob, used to change the checked state."
         },
+        {
+          "name": "label",
+          "docs": "The label text describing the toggle."
+        },
         {
           "name": "track",
           "docs": "The background track of the toggle."
@@ -29093,6 +29240,11 @@
       "docstring": "Values are converted to strings when emitted which is\nwhy we do not have a `number` type here even though the\n`value` prop accepts a `number` type.",
       "path": "src/components/input/input-interface.ts"
     },
+    "src/components/radio-group/radio-group-interface.ts::RadioGroupCompareFn": {
+      "declaration": "(currentValue: any, compareValue: any) => boolean",
+      "docstring": "",
+      "path": "src/components/radio-group/radio-group-interface.ts"
+    },
     "src/components/radio-group/radio-group-interface.ts::RadioGroupChangeEventDetail": {
       "declaration": "export interface RadioGroupChangeEventDetail<T = any> {\n  value: T;\n  event?: Event;\n}",
       "docstring": "",
@@ -29343,6 +29495,11 @@
       "docstring": "",
       "path": "src/components/toast/toast-interface.ts"
     },
+    "src/components/toast/toast-interface.ts::ToastSwipeGestureDirection": {
+      "declaration": "\"vertical\"",
+      "docstring": "",
+      "path": "src/components/toast/toast-interface.ts"
+    },
     "src/components/toast/toast-interface.ts::ToastPresentOptions": {
       "declaration": "export type ToastPresentOptions = ToastPositionAlias & ToastAnimationPosition;",
       "docstring": "",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ionic/docs",
-  "version": "7.5.8",
+  "version": "7.6.1-dev.11701921257.1d512d3c",
   "description": "Pre-packaged API documentation for the Ionic docs.",
   "main": "core.json",
   "types": "core.d.ts",