@arcgis/map-components 4.34.0-next.20 → 4.34.0-next.21

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-06-09T04:52:12",
+  "timestamp": "2025-06-10T04:47:59",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.20",
+    "version": "4.34.0-next.21",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -14652,7 +14652,7 @@
               "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/"
             },
             {
-              "description": "Expand with Custom Content\nThe Expand component with custom content. The content must be wrapped in an [Placement](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-placement/) component.",
+              "description": "Expand with Custom Content\nThe Expand component with custom content. The content must be wrapped in a [Placement](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-placement/) component.",
               "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--custom-content&singleStory=true"
             },
             {
@@ -14906,7 +14906,13 @@
                 ]
               },
               "default": "false",
-              "attribute": "focus-trap-disabled"
+              "attribute": "focus-trap-disabled",
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.33"
+                }
+              ]
             },
             {
               "kind": "field",
@@ -16496,6 +16502,166 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/feature-content/feature-content.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisFeatureContent",
+          "tagName": "arcgis-feature-content",
+          "demos": [
+            {
+              "description": "Docs",
+              "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-content/"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "encapsulation": "none",
+          "pascalCaseName": "ArcgisFeatureContent",
+          "importPath": "components/arcgis-feature-content",
+          "members": [
+            {
+              "kind": "field",
+              "name": "autoDestroyDisabled",
+              "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-content/#destroy) method when you are done to\nprevent memory leaks.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "auto-destroy-disabled"
+            },
+            {
+              "kind": "method",
+              "name": "componentOnReady",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "module": "lib/lib.es5.d.ts",
+                      "name": "Promise",
+                      "package": "typescript",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "description": "Create a promise that resolves once component is fully loaded.",
+              "signature": "(): Promise<void>",
+              "async": true,
+              "inheritedFrom": {
+                "name": "LitElement",
+                "package": "@arcgis/lumina"
+              },
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "```js\nconst arcgisFeatureContent = document.createElement(\"arcgis-feature-content\");\ndocument.body.append(arcgisFeatureContent);\narcgisFeatureContent.componentOnReady().then(() => {\n  console.log(\"arcgis-feature-content is ready to go!\");\n});\n```"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "creator",
+              "type": {
+                "text": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "destroy",
+              "description": "Permanently destroy the component.",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "signature": "(): Promise<void>",
+              "async": true
+            },
+            {
+              "kind": "field",
+              "name": "destroyer",
+              "type": {
+                "text": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "graphic",
+              "type": {
+                "text": "Graphic",
+                "references": [
+                  {
+                    "name": "Graphic",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html",
+                    "start": 0,
+                    "end": 7
+                  }
+                ]
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "auto-destroy-disabled",
+              "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-content/#destroy) method when you are done to\nprevent memory leaks.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "autoDestroyDisabled"
+            }
+          ],
+          "events": [
+            {
+              "name": "arcgisReady",
+              "description": "Emitted when the component associated with a map or scene view is is ready to be interacted with.",
+              "type": {
+                "text": "void"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-feature-content",
+          "declaration": {
+            "name": "ArcgisFeatureContent",
+            "module": "src/components/feature-content/feature-content.tsx"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/feature-form/feature-form.tsx",
@@ -29881,7 +30047,7 @@
             {
               "kind": "method",
               "name": "viewOnReady",
-              "description": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
+              "description": "`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.",
               "parameters": [
                 {
                   "name": "callback",
@@ -29937,6 +30103,20 @@
                   ]
                 }
               },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.33"
+                },
+                {
+                  "name": "see",
+                  "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
+                },
+                {
+                  "name": "example",
+                  "text": "```js\nconst viewElement = document.querySelector(\"arcgis-link-chart\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\n```"
+                }
+              ],
               "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
               "async": true
             },
@@ -33353,7 +33533,7 @@
             {
               "kind": "method",
               "name": "viewOnReady",
-              "description": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
+              "description": "`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.",
               "parameters": [
                 {
                   "name": "callback",
@@ -33409,6 +33589,20 @@
                   ]
                 }
               },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.33"
+                },
+                {
+                  "name": "see",
+                  "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
+                },
+                {
+                  "name": "example",
+                  "text": "```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"
+                }
+              ],
               "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
               "async": true
             },
@@ -40115,7 +40309,7 @@
             {
               "kind": "method",
               "name": "viewOnReady",
-              "description": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
+              "description": "`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.",
               "parameters": [
                 {
                   "name": "callback",
@@ -40171,6 +40365,20 @@
                   ]
                 }
               },
+              "docsTags": [
+                {
+                  "name": "since",
+                  "text": "4.33"
+                },
+                {
+                  "name": "see",
+                  "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
+                },
+                {
+                  "name": "example",
+                  "text": "```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"
+                }
+              ],
               "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
               "async": true
             },

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-06-09T04:52:12",
+  "timestamp": "2025-06-10T04:47:59",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.20",
+    "version": "4.34.0-next.21",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -12238,7 +12238,12 @@
           "attr": "focus-trap-disabled",
           "reflectToAttr": false,
           "docs": "Disables focus trapping within the expand component.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.33"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -13488,6 +13493,179 @@
       "parts": [],
       "listeners": []
     },
+    {
+      "filePath": "src/components/feature-content/feature-content.tsx",
+      "tag": "arcgis-feature-content",
+      "overview": "",
+      "readme": "",
+      "usage": {},
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "superclass",
+          "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+        }
+      ],
+      "encapsulation": "none",
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {},
+      "props": [
+        {
+          "name": "autoDestroyDisabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "auto-destroy-disabled",
+          "reflectToAttr": false,
+          "docs": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-content/#destroy) method when you are done to\nprevent memory leaks.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "creator",
+          "type": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))",
+          "complexType": {
+            "original": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))",
+            "resolved": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))",
+            "references": {}
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "destroyer",
+          "type": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))",
+          "complexType": {
+            "original": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))",
+            "resolved": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))",
+            "references": {}
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "graphic",
+          "type": "Graphic",
+          "complexType": {
+            "original": "Graphic",
+            "resolved": "Graphic",
+            "references": {
+              "Graphic": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "componentOnReady",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): Promise<void>",
+            "parameters": [],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "componentOnReady(): Promise<void>",
+          "parameters": [],
+          "docs": "Create a promise that resolves once component is fully loaded.",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": "```js\nconst arcgisFeatureContent = document.createElement(\"arcgis-feature-content\");\ndocument.body.append(arcgisFeatureContent);\narcgisFeatureContent.componentOnReady().then(() => {\n  console.log(\"arcgis-feature-content is ready to go!\");\n});\n```"
+            },
+            {
+              "name": "inheritedFrom",
+              "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+            }
+          ]
+        },
+        {
+          "name": "destroy",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): Promise<void>",
+            "parameters": [],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "destroy(): Promise<void>",
+          "parameters": [],
+          "docs": "Permanently destroy the component.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "arcgisReady",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the component associated with a map or scene view is is ready to be interacted with.",
+          "docsTags": []
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "listeners": []
+    },
     {
       "filePath": "src/components/feature-form/feature-form.tsx",
       "tag": "arcgis-feature-form",
@@ -25477,8 +25655,21 @@
               "docs": ""
             }
           ],
-          "docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
-          "docsTags": []
+          "docs": "`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.33"
+            },
+            {
+              "name": "see",
+              "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
+            },
+            {
+              "name": "example",
+              "text": "```js\nconst viewElement = document.querySelector(\"arcgis-link-chart\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\n```"
+            }
+          ]
         },
         {
           "name": "whenLayerView",
@@ -28766,8 +28957,21 @@
               "docs": ""
             }
           ],
-          "docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
-          "docsTags": []
+          "docs": "`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.33"
+            },
+            {
+              "name": "see",
+              "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
+            },
+            {
+              "name": "example",
+              "text": "```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"
+            }
+          ]
         },
         {
           "name": "whenLayerView",
@@ -34651,8 +34855,21 @@
               "docs": ""
             }
           ],
-          "docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.",
-          "docsTags": []
+          "docs": "`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.33"
+            },
+            {
+              "name": "see",
+              "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
+            },
+            {
+              "name": "example",
+              "text": "```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"
+            }
+          ]
         },
         {
           "name": "whenAnalysisView",