@microsoft/fast-element 2.0.0-beta.19 → 2.0.0-beta.20

package/dist/fast-element.api.json

@@ -2338,6 +2338,72 @@
             "endIndex": 7
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!Class:type",
+          "docComment": "/**\n * Represents a constructable class with a prototype.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type Class<T, C = "
+            },
+            {
+              "kind": "Content",
+              "text": "{}"
+            },
+            {
+              "kind": "Content",
+              "text": "> = "
+            },
+            {
+              "kind": "Content",
+              "text": "C & "
+            },
+            {
+              "kind": "Reference",
+              "text": "Constructable",
+              "canonicalReference": "@microsoft/fast-element!Constructable:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<T> & {\n    readonly prototype: T;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "Class",
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            },
+            {
+              "typeParameterName": "C",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "typeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 6
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@microsoft/fast-element!CompilationStrategy:type",
@@ -2587,7 +2653,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@microsoft/fast-element!Constructable:type",
-          "docComment": "/**\n * Allows for the creation of Constructable mixin classes.\n *\n * @public\n */\n",
+          "docComment": "/**\n * Represents a type which can be constructed with the new operator.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -3261,59 +3327,6 @@
           ],
           "extendsTokenRanges": []
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@microsoft/fast-element!cssPartial:var",
-          "docComment": "/**\n * @deprecated\n *\n * Use css.partial instead.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "cssPartial: "
-            },
-            {
-              "kind": "Content",
-              "text": "(strings: "
-            },
-            {
-              "kind": "Reference",
-              "text": "TemplateStringsArray",
-              "canonicalReference": "!TemplateStringsArray:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ", ...values: ("
-            },
-            {
-              "kind": "Reference",
-              "text": "ComposableStyles",
-              "canonicalReference": "@microsoft/fast-element!ComposableStyles:type"
-            },
-            {
-              "kind": "Content",
-              "text": " | "
-            },
-            {
-              "kind": "Reference",
-              "text": "CSSDirective",
-              "canonicalReference": "@microsoft/fast-element!CSSDirective:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ")[]) => "
-            },
-            {
-              "kind": "Reference",
-              "text": "CSSDirective",
-              "canonicalReference": "@microsoft/fast-element!CSSDirective:interface"
-            }
-          ],
-          "releaseTag": "Public",
-          "name": "cssPartial",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 9
-          }
-        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@microsoft/fast-element!CSSTemplateTag:type",
@@ -3478,185 +3491,6 @@
           ],
           "name": "customElement"
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/fast-element!dangerousHTML:function(1)",
-          "docComment": "/**\n * Injects static HTML without platform protection.\n *\n * @param html - The html to injection.\n *\n * @returns A DangerousHTMLDirective.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function dangerousHTML<TSource = "
-            },
-            {
-              "kind": "Content",
-              "text": "any"
-            },
-            {
-              "kind": "Content",
-              "text": ", TParent = "
-            },
-            {
-              "kind": "Content",
-              "text": "any"
-            },
-            {
-              "kind": "Content",
-              "text": ">(html: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Reference",
-              "text": "CaptureType",
-              "canonicalReference": "@microsoft/fast-element!CaptureType:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "<TSource, TParent>"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 7,
-            "endIndex": 9
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "html",
-              "parameterTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
-              },
-              "isOptional": false
-            }
-          ],
-          "typeParameters": [
-            {
-              "typeParameterName": "TSource",
-              "constraintTokenRange": {
-                "startIndex": 0,
-                "endIndex": 0
-              },
-              "defaultTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "typeParameterName": "TParent",
-              "constraintTokenRange": {
-                "startIndex": 0,
-                "endIndex": 0
-              },
-              "defaultTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              }
-            }
-          ],
-          "name": "dangerousHTML"
-        },
-        {
-          "kind": "Class",
-          "canonicalReference": "@microsoft/fast-element!DangerousHTMLDirective:class",
-          "docComment": "/**\n * A directive capable of injecting static HTML platform runtime protection.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare class DangerousHTMLDirective implements "
-            },
-            {
-              "kind": "Reference",
-              "text": "HTMLDirective",
-              "canonicalReference": "@microsoft/fast-element!HTMLDirective:interface"
-            },
-            {
-              "kind": "Content",
-              "text": " "
-            }
-          ],
-          "releaseTag": "Public",
-          "name": "DangerousHTMLDirective",
-          "members": [
-            {
-              "kind": "Constructor",
-              "canonicalReference": "@microsoft/fast-element!DangerousHTMLDirective:constructor(1)",
-              "docComment": "/**\n * Constructs a new instance of the `DangerousHTMLDirective` class\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "constructor(html: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ");"
-                }
-              ],
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "html",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ]
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/fast-element!DangerousHTMLDirective#createHTML:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "createHTML(): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [],
-              "name": "createHTML"
-            }
-          ],
-          "implementsTokenRanges": [
-            {
-              "startIndex": 1,
-              "endIndex": 2
-            }
-          ]
-        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@microsoft/fast-element!DecoratorAttributeConfiguration:type",
@@ -3756,25 +3590,7 @@
             },
             {
               "kind": "Content",
-              "text": "<{\n    queueUpdate: (callable: "
-            },
-            {
-              "kind": "Reference",
-              "text": "Callable",
-              "canonicalReference": "@microsoft/fast-element!Callable:type"
-            },
-            {
-              "kind": "Content",
-              "text": ") => void;\n    nextUpdate: () => "
-            },
-            {
-              "kind": "Reference",
-              "text": "Promise",
-              "canonicalReference": "!Promise:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "<void>;\n    processUpdates: () => void;\n    readonly policy: "
+              "text": "<{\n    readonly policy: "
             },
             {
               "kind": "Reference",
@@ -3817,7 +3633,7 @@
           "name": "DOM",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 15
+            "endIndex": 11
           }
         },
         {
@@ -8630,115 +8446,26 @@
           "extendsTokenRanges": []
         },
         {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/fast-element!html:function(1)",
+          "kind": "Variable",
+          "canonicalReference": "@microsoft/fast-element!html:var",
           "docComment": "/**\n * Transforms a template literal string into a ViewTemplate.\n *\n * @remarks\n *\n * The html helper supports interpolation of strings, numbers, binding expressions, other template instances, and Directive instances.\n *\n * @param strings - The string fragments that are interpolated with the values.\n *\n * @param values - The values that are interpolated with the string fragments.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare function html<TSource = "
-            },
-            {
-              "kind": "Content",
-              "text": "any"
-            },
-            {
-              "kind": "Content",
-              "text": ", TParent = "
-            },
-            {
-              "kind": "Content",
-              "text": "any"
-            },
-            {
-              "kind": "Content",
-              "text": ">(strings: "
-            },
-            {
-              "kind": "Reference",
-              "text": "TemplateStringsArray",
-              "canonicalReference": "!TemplateStringsArray:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ", ...values: "
+              "text": "html: "
             },
             {
               "kind": "Reference",
-              "text": "TemplateValue",
-              "canonicalReference": "@microsoft/fast-element!TemplateValue:type"
-            },
-            {
-              "kind": "Content",
-              "text": "<TSource, TParent>[]"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Reference",
-              "text": "ViewTemplate",
-              "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
-            },
-            {
-              "kind": "Content",
-              "text": "<TSource, TParent>"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
+              "text": "HTMLTemplateTag",
+              "canonicalReference": "@microsoft/fast-element!HTMLTemplateTag:type"
             }
           ],
-          "returnTypeTokenRange": {
-            "startIndex": 10,
-            "endIndex": 12
-          },
           "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "strings",
-              "parameterTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
-              },
-              "isOptional": false
-            },
-            {
-              "parameterName": "values",
-              "parameterTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 9
-              },
-              "isOptional": false
-            }
-          ],
-          "typeParameters": [
-            {
-              "typeParameterName": "TSource",
-              "constraintTokenRange": {
-                "startIndex": 0,
-                "endIndex": 0
-              },
-              "defaultTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "typeParameterName": "TParent",
-              "constraintTokenRange": {
-                "startIndex": 0,
-                "endIndex": 0
-              },
-              "defaultTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              }
-            }
-          ],
-          "name": "html"
+          "name": "html",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
         },
         {
           "kind": "Class",
@@ -9614,7 +9341,68 @@
               "name": "createView"
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!HTMLTemplateTag:type",
+          "docComment": "/**\n * Transforms a template literal string into a ViewTemplate.\n *\n * @remarks\n *\n * The html helper supports interpolation of strings, numbers, binding expressions, other template instances, and Directive instances.\n *\n * @param strings - The string fragments that are interpolated with the values.\n *\n * @param values - The values that are interpolated with the string fragments.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type HTMLTemplateTag = "
+            },
+            {
+              "kind": "Content",
+              "text": "(<TSource = any, TParent = any>(strings: "
+            },
+            {
+              "kind": "Reference",
+              "text": "TemplateStringsArray",
+              "canonicalReference": "!TemplateStringsArray:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", ...values: "
+            },
+            {
+              "kind": "Reference",
+              "text": "TemplateValue",
+              "canonicalReference": "@microsoft/fast-element!TemplateValue:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<TSource, TParent>[]) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "ViewTemplate",
+              "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
+            },
+            {
+              "kind": "Content",
+              "text": "<TSource, TParent>) & {\n    partial(html: string): "
+            },
+            {
+              "kind": "Reference",
+              "text": "InlineTemplateDirective",
+              "canonicalReference": "@microsoft/fast-element!InlineTemplateDirective:class"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "HTMLTemplateTag",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 10
+          }
         },
         {
           "kind": "Class",
@@ -10720,6 +10508,172 @@
             }
           ]
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "@microsoft/fast-element!InlineTemplateDirective:class",
+          "docComment": "/**\n * Inlines a template into another template.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class InlineTemplateDirective implements "
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLDirective",
+              "canonicalReference": "@microsoft/fast-element!HTMLDirective:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "InlineTemplateDirective",
+          "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "@microsoft/fast-element!InlineTemplateDirective:constructor(1)",
+              "docComment": "/**\n * Creates an instance of InlineTemplateDirective.\n *\n * @param template - The template to inline.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor(html: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", factories?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ViewBehaviorFactory",
+                  "canonicalReference": "@microsoft/fast-element!ViewBehaviorFactory:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ");"
+                }
+              ],
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "html",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "factories",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 7
+                  },
+                  "isOptional": true
+                }
+              ]
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/fast-element!InlineTemplateDirective#createHTML:member(1)",
+              "docComment": "/**\n * Creates HTML to be used within a template.\n *\n * @param add - Can be used to add behavior factories to a template.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "createHTML(add: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AddViewBehaviorFactory",
+                  "canonicalReference": "@microsoft/fast-element!AddViewBehaviorFactory:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "add",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "createHTML"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/fast-element!InlineTemplateDirective.empty:member",
+              "docComment": "/**\n * An empty template partial.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static readonly empty: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "InlineTemplateDirective",
+                  "canonicalReference": "@microsoft/fast-element!InlineTemplateDirective:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "empty",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": true
+            }
+          ],
+          "implementsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/fast-element!LengthObserver:interface",
@@ -11885,6 +11839,28 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@microsoft/fast-element!nullableBooleanConverter:var",
+          "docComment": "/**\n * A {@link ValueConverter} that converts to and from `boolean` values. `null`, `undefined`, `\"\"`, and `void` values are converted to `null`.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "nullableBooleanConverter: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ValueConverter",
+              "canonicalReference": "@microsoft/fast-element!ValueConverter:interface"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "nullableBooleanConverter",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@microsoft/fast-element!nullableNumberConverter:var",
@@ -16891,6 +16867,39 @@
               "overloadIndex": 1,
               "parameters": [],
               "name": "create"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@microsoft/fast-element!SyntheticViewTemplate#inline:member(1)",
+              "docComment": "/**\n * Returns a directive that can inline the template.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "inline(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CaptureType",
+                  "canonicalReference": "@microsoft/fast-element!CaptureType:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TSource, TParent>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "inline"
             }
           ],
           "extendsTokenRanges": []
@@ -16984,6 +16993,31 @@
             "endIndex": 11
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/fast-element!TrustedTypesPolicy:type",
+          "docComment": "/**\n * A policy for use with the standard trustedTypes platform API.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type TrustedTypesPolicy = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    createHTML(html: string): string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "TrustedTypesPolicy",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/fast-element!UpdateQueue:interface",
@@ -18304,6 +18338,40 @@
               },
               "isStatic": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/fast-element!ViewTemplate#inline:member(1)",
+              "docComment": "/**\n * Returns a directive that can inline the template.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "inline(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CaptureType",
+                  "canonicalReference": "@microsoft/fast-element!CaptureType:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TSource, TParent>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "inline"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/fast-element!ViewTemplate#render:member(1)",