@arcgis/map-components 4.34.0-next.107 → 4.34.0-next.108

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-08-22T04:42:19",
+  "timestamp": "2025-08-23T04:42:25",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.107",
+    "version": "4.34.0-next.108",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -12386,8 +12386,16 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "",
+      "docs": "Expand acts as a clickable button for displaying interactive content, most commonly other components.",
       "docsTags": [
+        {
+          "name": "see",
+          "text": "[Samples with the Expand component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-expand)"
+        },
+        {
+          "name": "example",
+          "text": "```html\n<arcgis-map item-id=\"45b3b2fb35e94ab09381d0caa0da5946\">\n <arcgis-expand slot=\"top-right\">\n  <arcgis-layer-list></arcgis-layer-list>\n </arcgis-expand>\n</arcgis-map>"
+        },
         {
           "name": "superclass",
           "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
@@ -12409,7 +12417,7 @@
           "mutable": true,
           "attr": "auto-collapse",
           "reflectToAttr": false,
-          "docs": "Automatically collapses the expand widget instance when the view's\n[viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#viewpoint) updates.",
+          "docs": "Automatically collapses the Expand component when the\n[viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#viewpoint) updates.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -12459,15 +12467,15 @@
           "mutable": true,
           "attr": "close-on-esc",
           "reflectToAttr": false,
-          "docs": "When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content.\nThis property can also be set to a function that returns a boolean, allowing for more customization for when to allow the Expand widget\nto be closed from the `esc` key.",
+          "docs": "When `true`, the Expand component will close after the Escape key is pressed when the keyboard focus is within its content.\nThis property can also be set to a function that returns a boolean, allowing for more customization for when to allow the Expand component\nto be closed from the `esc` key.",
           "docsTags": [
             {
               "name": "example",
-              "text": "let expand = new Expand({\n   view: view,\n   content: search,\n   // widget will not be able to be closed from the ESC key\n   closeOnEsc: false\n});"
+              "text": "```html\n<arcgis-expand slot=\"top-right\" close-on-esc=\"false\">\n  <arcgis-search></arcgis-search>\n</arcgis-expand>\n```"
             },
             {
               "name": "example",
-              "text": "let expand = new Expand({\n   view: view,\n   content: search,\n   // widget will close on ESC when Search has no active menu\n   closeOnEsc: function() {\n     return search.activeMenu === \"none\"\n   }\n});"
+              "text": "```html\n<arcgis-expand slot=\"top-right\">\n  <arcgis-search></arcgis-search>\n</arcgis-expand>\n\n<script>\n const expandElement = document.querySelector(\"arcgis-expand\");\n const searchElement = document.querySelector(\"arcgis-search\");\n expandElement.closeOnEsc = () => {\n    // only close the expand if the search is not active\n    return searchElement.activeMenu === \"none\";\n };\n</script>\n```"
             }
           ],
           "default": "true",
@@ -12493,15 +12501,11 @@
           "mutable": true,
           "attr": "collapse-icon",
           "reflectToAttr": true,
-          "docs": "Calcite icon used to style the Expand button when the [content](#content) can be collapsed.",
+          "docs": "Calcite icon used to style the Expand when it can be collapsed.",
           "docsTags": [
             {
               "name": "see",
               "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
-            },
-            {
-              "name": "since",
-              "text": "4.27"
             }
           ],
           "default": "\"chevrons-right\"",
@@ -12524,7 +12528,7 @@
           "mutable": true,
           "attr": "collapse-tooltip",
           "reflectToAttr": false,
-          "docs": "Tooltip to display to indicate Expand widget can be collapsed.",
+          "docs": "Tooltip to display to indicate the Expand can be collapsed.",
           "docsTags": [],
           "default": "\"Collapse\" (English locale)",
           "values": [
@@ -12546,7 +12550,7 @@
           "mutable": true,
           "attr": "expanded",
           "reflectToAttr": true,
-          "docs": "Indicates whether the widget is currently expanded or not.",
+          "docs": "Indicates whether the component is currently expanded or not.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -12568,15 +12572,11 @@
           "mutable": true,
           "attr": "expand-icon",
           "reflectToAttr": true,
-          "docs": "Calcite icon used when the widget is collapsed.\nWill automatically use the [content's](#content) icon if it has one.",
+          "docs": "Calcite icon used to style the Expand when it can be expanded.\nThe component will automatically use the icon of the component placed within the Expand if it has one.",
           "docsTags": [
             {
               "name": "see",
               "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
-            },
-            {
-              "name": "since",
-              "text": "4.27"
             }
           ],
           "default": "\"chevrons-left\"",
@@ -12599,7 +12599,7 @@
           "mutable": true,
           "attr": "expand-tooltip",
           "reflectToAttr": false,
-          "docs": "Tooltip to display to indicate Expand widget can be expanded.",
+          "docs": "Tooltip to display to indicate Expand can be expanded.",
           "docsTags": [],
           "default": "\"Expand\" (English locale)",
           "values": [
@@ -12643,15 +12643,11 @@
           "mutable": true,
           "attr": "group",
           "reflectToAttr": false,
-          "docs": "This value associates two or more Expand widget instances with each other, allowing one\ninstance to auto collapse when another instance in the same group is expanded. For auto collapsing\nto take effect, all instances of the group must be included in the view's `ui` property.\n\nFor example, if you place multiple Expand instances in the top-left of the view's ui, you can assign them to a\ngroup called `top-left`. If one Expand instance is expanded and the user clicks on a different instance in the\n`top-left` group, then the first instance is collapsed, allowing the content of the second instance to be\nfully visible.",
+          "docs": "This value associates two or more Expand components with each other, allowing one\ncomponent to auto collapse when another in the same group is expanded. For auto collapsing\nto take effect, all components in the group must be included in the same Map, Scene, or Link Chart component.\n\nFor example, if you place multiple Expand components in the `top-left` slot of the Map, you can assign them to a\ngroup called `top-left`. If one Expand component is expanded and the user clicks on a different component in the\n`top-left` group, then the first component is collapsed, allowing the content of the second component to be\nfully visible.",
           "docsTags": [
-            {
-              "name": "since",
-              "text": "4.6"
-            },
             {
               "name": "example",
-              "text": "let expand1 = new Expand({\n  view: view,\n  content: document.getElementById(\"bg-gallery\"),\n  expandIcon: \"basemap\",\n  group: \"bottom-right\"\n});\nlet expand2 = new Expand({\n  view: view,\n  content: document.getElementById(\"legend\"),\n  expandIcon: \"key\",\n  group: \"bottom-right\"\n});\n\nview.ui.add([expand1, expand2], \"bottom-right\");"
+              "text": "```html\n<arcgis-map basemap=\"topo-vector\">\n  <arcgis-expand slot=\"top-left\" group=\"top-left\" expanded>\n    <arcgis-layer-list></arcgis-layer-list>\n  </arcgis-expand>\n  <arcgis-expand slot=\"top-left\" group=\"top-left\">\n    <arcgis-basemap-gallery></arcgis-basemap-gallery>\n  </arcgis-expand>\n</arcgis-map>"
             }
           ],
           "values": [
@@ -12673,7 +12669,7 @@
           "mutable": true,
           "attr": "icon-number",
           "reflectToAttr": false,
-          "docs": "A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices.\n\n![expand widget icon number](../assets/img/apiref/widgets/expand-with-iconnumber.png)",
+          "docs": "A number to display at the corner of the component to indicate the number of, for example, open issues or unread notices.\n\n![expand component icon number](https://developers.arcgis.com/javascript/latest//assets/img/apiref/widgets/expand-with-iconnumber.png)",
           "docsTags": [],
           "default": "0",
           "values": [
@@ -12715,7 +12711,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "Overwrite localized strings for this component",
+          "docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -12732,13 +12728,8 @@
           "mutable": true,
           "attr": "mode",
           "reflectToAttr": false,
-          "docs": "The mode in which the widget displays. These modes are listed below.\n\nmode | description\n---------------|------------\nauto | This is the default mode. It is responsive to browser size changes and will update based on whether the widget is viewed in a desktop or mobile application.\nfloating | Use this mode if you wish to always display the widget as floating regardless of browser size.\ndrawer | Use this mode if you wish to always display the widget in a panel regardless of browser size.",
-          "docsTags": [
-            {
-              "name": "since",
-              "text": "4.7"
-            }
-          ],
+          "docs": "The mode in which the component displays. These modes are listed below.\n\n| mode         | description |\n|--------------|-------------|\n| auto         | This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application. |\n| floating     | Use this mode if you wish to always display the component as floating regardless of browser size. |\n| drawer       | Use this mode if you wish to always display the component in a panel regardless of browser size. |",
+          "docsTags": [],
           "default": "\"auto\"",
           "values": [
             {
@@ -12768,13 +12759,8 @@
           "mutable": true,
           "attr": "placement",
           "reflectToAttr": false,
-          "docs": "The placement used by the [calcite popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the widget is expanded.",
-          "docsTags": [
-            {
-              "name": "since",
-              "text": "4.30"
-            }
-          ],
+          "docs": "The placement used by the [calcite popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
+          "docsTags": [],
           "values": [
             {
               "value": "auto",
@@ -12946,8 +12932,13 @@
           "mutable": true,
           "attr": "reference-element",
           "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
+          "docs": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
+          "docsTags": [
+            {
+              "name": "see",
+              "text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
+            }
+          ],
           "values": [
             {
               "type": "HTMLArcgisLinkChartElement"
@@ -13019,7 +13010,7 @@
           },
           "signature": "collapse(): Promise<void>",
           "parameters": [],
-          "docs": "Collapse the widget.",
+          "docs": "Collapse the component.",
           "docsTags": []
         },
         {
@@ -13097,7 +13088,7 @@
           },
           "signature": "expand(): Promise<void>",
           "parameters": [],
-          "docs": "Expand the widget.",
+          "docs": "Expand the component.",
           "docsTags": []
         }
       ],
@@ -13113,7 +13104,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "",
+          "docs": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
           "docsTags": []
         },
         {
@@ -26809,7 +26800,44 @@
         }
       ],
       "styles": [],
-      "slots": [],
+      "slots": [
+        {
+          "name": "",
+          "docs": "Default slot for adding components to the link chart. User is responsible for positioning the content via CSS."
+        },
+        {
+          "name": "top-left",
+          "docs": "Slot for components positioned in the top-left corner."
+        },
+        {
+          "name": "top-right",
+          "docs": "Slot for components positioned in the top-right corner."
+        },
+        {
+          "name": "bottom-left",
+          "docs": "Slot for components positioned in the bottom-left corner."
+        },
+        {
+          "name": "bottom-right",
+          "docs": "Slot for components positioned in the bottom-right corner."
+        },
+        {
+          "name": "top-start",
+          "docs": "Slot for components positioned at the top-start (top-left in LTR, top-right in RTL)."
+        },
+        {
+          "name": "top-end",
+          "docs": "Slot for components positioned at the top-end (top-right in LTR, top-left in RTL)."
+        },
+        {
+          "name": "bottom-start",
+          "docs": "Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL)."
+        },
+        {
+          "name": "bottom-end",
+          "docs": "Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."
+        }
+      ],
       "parts": [],
       "listeners": []
     },
@@ -30203,7 +30231,44 @@
         }
       ],
       "styles": [],
-      "slots": [],
+      "slots": [
+        {
+          "name": "",
+          "docs": "Default slot for adding components to the map. User is responsible for positioning the content via CSS."
+        },
+        {
+          "name": "top-left",
+          "docs": "Slot for components positioned in the top-left corner."
+        },
+        {
+          "name": "top-right",
+          "docs": "Slot for components positioned in the top-right corner."
+        },
+        {
+          "name": "bottom-left",
+          "docs": "Slot for components positioned in the bottom-left corner."
+        },
+        {
+          "name": "bottom-right",
+          "docs": "Slot for components positioned in the bottom-right corner."
+        },
+        {
+          "name": "top-start",
+          "docs": "Slot for components positioned at the top-start (top-left in LTR, top-right in RTL)."
+        },
+        {
+          "name": "top-end",
+          "docs": "Slot for components positioned at the top-end (top-right in LTR, top-left in RTL)."
+        },
+        {
+          "name": "bottom-start",
+          "docs": "Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL)."
+        },
+        {
+          "name": "bottom-end",
+          "docs": "Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."
+        }
+      ],
       "parts": [],
       "listeners": []
     },
@@ -36240,7 +36305,44 @@
         }
       ],
       "styles": [],
-      "slots": [],
+      "slots": [
+        {
+          "name": "",
+          "docs": "Default slot for adding components to the scene. User is responsible for positioning the content via CSS."
+        },
+        {
+          "name": "top-left",
+          "docs": "Slot for components positioned in the top-left corner."
+        },
+        {
+          "name": "top-right",
+          "docs": "Slot for components positioned in the top-right corner."
+        },
+        {
+          "name": "bottom-left",
+          "docs": "Slot for components positioned in the bottom-left corner."
+        },
+        {
+          "name": "bottom-right",
+          "docs": "Slot for components positioned in the bottom-right corner."
+        },
+        {
+          "name": "top-start",
+          "docs": "Slot for components positioned at the top-start (top-left in LTR, top-right in RTL)."
+        },
+        {
+          "name": "top-end",
+          "docs": "Slot for components positioned at the top-end (top-right in LTR, top-left in RTL)."
+        },
+        {
+          "name": "bottom-start",
+          "docs": "Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL)."
+        },
+        {
+          "name": "bottom-end",
+          "docs": "Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."
+        }
+      ],
       "parts": [],
       "listeners": []
     },
@@ -47730,7 +47832,44 @@
         }
       ],
       "styles": [],
-      "slots": [],
+      "slots": [
+        {
+          "name": "",
+          "docs": "Default slot for adding components to the video. User is responsible for positioning the content via CSS."
+        },
+        {
+          "name": "top-left",
+          "docs": "Slot for components positioned in the top-left corner."
+        },
+        {
+          "name": "top-right",
+          "docs": "Slot for components positioned in the top-right corner."
+        },
+        {
+          "name": "bottom-left",
+          "docs": "Slot for components positioned in the bottom-left corner."
+        },
+        {
+          "name": "bottom-right",
+          "docs": "Slot for components positioned in the bottom-right corner."
+        },
+        {
+          "name": "top-start",
+          "docs": "Slot for components positioned at the top-start (top-left in LTR, top-right in RTL)."
+        },
+        {
+          "name": "top-end",
+          "docs": "Slot for components positioned at the top-end (top-right in LTR, top-left in RTL)."
+        },
+        {
+          "name": "bottom-start",
+          "docs": "Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL)."
+        },
+        {
+          "name": "bottom-end",
+          "docs": "Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."
+        }
+      ],
       "parts": [],
       "listeners": []
     },