@microsoft/fast-element 2.8.0 → 2.8.2

package/dist/fast-element.api.json

@@ -4283,6 +4283,33 @@
             "endIndex": 5
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@microsoft/fast-element!deferHydrationAttribute:var",
+          "docComment": "/**\n * The attribute used to defer hydration of an element.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "deferHydrationAttribute = "
+            },
+            {
+              "kind": "Content",
+              "text": "\"defer-hydration\""
+            }
+          ],
+          "fileUrlPath": "dist/dts/components/element-controller.d.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "deferHydrationAttribute",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/fast-element!Disposable:interface",
@@ -4855,7 +4882,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/fast-element!ElementController#behaviors:member",
-              "docComment": "",
+              "docComment": "/**\n * The behaviors associated with the component.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -4899,7 +4926,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-element!ElementController#bindObservables:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Binds any observables that were set before upgrade.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -4961,7 +4988,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-element!ElementController#connectBehaviors:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Connects any existing behaviors on the associated element.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -5085,7 +5112,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-element!ElementController#disconnectBehaviors:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Disconnects any behaviors on the associated element.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -5273,6 +5300,36 @@
               "isAbstract": false,
               "name": "forCustomElement"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/fast-element!ElementController#hasExistingShadowRoot:member",
+              "docComment": "/**\n * Indicates whether the element has an existing shadow root (e.g. from declarative shadow DOM).\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected hasExistingShadowRoot: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "hasExistingShadowRoot",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/fast-element!ElementController#isBound:member",
@@ -5380,7 +5437,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/fast-element!ElementController#needsInitialization:member",
-              "docComment": "",
+              "docComment": "/**\n * Indicates whether the controller needs to perform initial rendering.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -5678,7 +5735,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-element!ElementController#renderTemplate:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Renders the provided template to the element.\n *\n * @remarks\n *\n * If `null` is provided, any existing view will be removed.\n *\n * @param template - The template to render.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -5780,7 +5837,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/fast-element!ElementController#shadowOptions:member",
-              "docComment": "",
+              "docComment": "/**\n * The shadow root options for the component.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -5889,7 +5946,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/fast-element!ElementController#stage:member",
-              "docComment": "",
+              "docComment": "/**\n * The current lifecycle stage of the controller.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -5898,7 +5955,7 @@
                 {
                   "kind": "Reference",
                   "text": "Stages",
-                  "canonicalReference": "@microsoft/fast-element!~Stages:enum"
+                  "canonicalReference": "@microsoft/fast-element!Stages:enum"
                 },
                 {
                   "kind": "Content",
@@ -12424,7 +12481,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-element!HydratableElementController#connect:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Runs connected lifecycle behavior on the associated element.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -12455,7 +12512,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-element!HydratableElementController#disconnect:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Unregisters the hydration observer when the element is disconnected.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -12485,47 +12542,16 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/fast-element!HydratableElementController.forCustomElement:member(1)",
-              "docComment": "",
+              "canonicalReference": "@microsoft/fast-element!HydratableElementController.install:member(1)",
+              "docComment": "/**\n * Sets the ElementController strategy to HydratableElementController.\n *\n * @remarks\n *\n * This method is typically called during application startup to enable hydration support for FAST elements.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "static forCustomElement(element: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "HTMLElement",
-                  "canonicalReference": "!HTMLElement:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", override?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "ElementController",
-                  "canonicalReference": "@microsoft/fast-element!ElementController:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
-                {
-                  "kind": "Reference",
-                  "text": "HTMLElement",
-                  "canonicalReference": "!HTMLElement:interface"
+                  "text": "static install(): "
                 },
                 {
                   "kind": "Content",
-                  "text": ">"
+                  "text": "void"
                 },
                 {
                   "kind": "Content",
@@ -12534,64 +12560,47 @@
               ],
               "isStatic": true,
               "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 9
+                "startIndex": 1,
+                "endIndex": 2
               },
               "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "element",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "override",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": true
-                }
-              ],
+              "parameters": [],
               "isOptional": false,
               "isAbstract": false,
-              "name": "forCustomElement"
+              "name": "install"
             },
             {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/fast-element!HydratableElementController.install:member(1)",
-              "docComment": "",
+              "kind": "Property",
+              "canonicalReference": "@microsoft/fast-element!HydratableElementController.lifecycleCallbacks:member",
+              "docComment": "/**\n * Lifecycle callbacks for hydration events\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "static install(): "
+                  "text": "static lifecycleCallbacks?: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "void"
+                  "kind": "Reference",
+                  "text": "HydrationControllerCallbacks",
+                  "canonicalReference": "@microsoft/fast-element!HydrationControllerCallbacks:interface"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isStatic": true,
-              "returnTypeTokenRange": {
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Beta",
+              "name": "lifecycleCallbacks",
+              "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Beta",
+              "isStatic": true,
               "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "install"
+              "isAbstract": false
             },
             {
               "kind": "Property",
@@ -12622,6 +12631,50 @@
               "isStatic": false,
               "isProtected": true,
               "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/fast-element!HydratableElementController#shadowOptions:member",
+              "docComment": "/**\n * The shadow root options for the component.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get shadowOptions(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ShadowRootOptions",
+                  "canonicalReference": "@microsoft/fast-element!ShadowRootOptions:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n\nset shadowOptions(value: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ShadowRootOptions",
+                  "canonicalReference": "@microsoft/fast-element!ShadowRootOptions:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined);"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "shadowOptions",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
             }
           ],
           "extendsTokenRange": {
@@ -13596,6 +13649,33 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@microsoft/fast-element!needsHydrationAttribute:var",
+          "docComment": "/**\n * The attribute used to indicate that an element needs hydration.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "needsHydrationAttribute = "
+            },
+            {
+              "kind": "Content",
+              "text": "\"needs-hydration\""
+            }
+          ],
+          "fileUrlPath": "dist/dts/components/element-controller.d.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "needsHydrationAttribute",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/fast-element!NodeBehaviorOptions:interface",
@@ -19562,6 +19642,107 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Enum",
+          "canonicalReference": "@microsoft/fast-element!Stages:enum",
+          "docComment": "/**\n * The various lifecycle stages of an ElementController.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare const enum Stages "
+            }
+          ],
+          "fileUrlPath": "dist/dts/components/element-controller.d.ts",
+          "releaseTag": "Public",
+          "name": "Stages",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@microsoft/fast-element!Stages.connected:member",
+              "docComment": "/**\n * The element is connected.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "connected = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "1"
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "connected"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@microsoft/fast-element!Stages.connecting:member",
+              "docComment": "/**\n * The element is in the process of connecting.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "connecting = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "0"
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "connecting"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@microsoft/fast-element!Stages.disconnected:member",
+              "docComment": "/**\n * The element is disconnected.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "disconnected = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "3"
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "disconnected"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@microsoft/fast-element!Stages.disconnecting:member",
+              "docComment": "/**\n * The element is in the process of disconnecting.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "disconnecting = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "2"
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "disconnecting"
+            }
+          ]
+        },
         {
           "kind": "Class",
           "canonicalReference": "@microsoft/fast-element!StatelessAttachedAttributeDirective:class",