@microsoft/fast-element 2.7.0 → 2.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9167,6 +9167,37 @@
9167
9167
  "isProtected": false,
9168
9168
  "isAbstract": false
9169
9169
  },
9170
+ {
9171
+ "kind": "Property",
9172
+ "canonicalReference": "@microsoft/fast-element!FASTElementDefinition#lifecycleCallbacks:member",
9173
+ "docComment": "/**\n * Lifecycle callbacks for template events.\n */\n",
9174
+ "excerptTokens": [
9175
+ {
9176
+ "kind": "Content",
9177
+ "text": "readonly lifecycleCallbacks?: "
9178
+ },
9179
+ {
9180
+ "kind": "Reference",
9181
+ "text": "TemplateLifecycleCallbacks",
9182
+ "canonicalReference": "@microsoft/fast-element!TemplateLifecycleCallbacks:interface"
9183
+ },
9184
+ {
9185
+ "kind": "Content",
9186
+ "text": ";"
9187
+ }
9188
+ ],
9189
+ "isReadonly": true,
9190
+ "isOptional": true,
9191
+ "releaseTag": "Public",
9192
+ "name": "lifecycleCallbacks",
9193
+ "propertyTypeTokenRange": {
9194
+ "startIndex": 1,
9195
+ "endIndex": 2
9196
+ },
9197
+ "isStatic": false,
9198
+ "isProtected": false,
9199
+ "isAbstract": false
9200
+ },
9170
9201
  {
9171
9202
  "kind": "Property",
9172
9203
  "canonicalReference": "@microsoft/fast-element!FASTElementDefinition#name:member",
@@ -12336,6 +12367,60 @@
12336
12367
  "name": "HydratableElementController",
12337
12368
  "preserveMemberOrder": false,
12338
12369
  "members": [
12370
+ {
12371
+ "kind": "Method",
12372
+ "canonicalReference": "@microsoft/fast-element!HydratableElementController.config:member(1)",
12373
+ "docComment": "/**\n * Configure lifecycle callbacks for hydration events\n */\n",
12374
+ "excerptTokens": [
12375
+ {
12376
+ "kind": "Content",
12377
+ "text": "static config(callbacks: "
12378
+ },
12379
+ {
12380
+ "kind": "Reference",
12381
+ "text": "HydrationControllerCallbacks",
12382
+ "canonicalReference": "@microsoft/fast-element!HydrationControllerCallbacks:interface"
12383
+ },
12384
+ {
12385
+ "kind": "Content",
12386
+ "text": "): "
12387
+ },
12388
+ {
12389
+ "kind": "Content",
12390
+ "text": "typeof "
12391
+ },
12392
+ {
12393
+ "kind": "Reference",
12394
+ "text": "HydratableElementController",
12395
+ "canonicalReference": "@microsoft/fast-element!HydratableElementController:class"
12396
+ },
12397
+ {
12398
+ "kind": "Content",
12399
+ "text": ";"
12400
+ }
12401
+ ],
12402
+ "isStatic": true,
12403
+ "returnTypeTokenRange": {
12404
+ "startIndex": 3,
12405
+ "endIndex": 5
12406
+ },
12407
+ "releaseTag": "Beta",
12408
+ "isProtected": false,
12409
+ "overloadIndex": 1,
12410
+ "parameters": [
12411
+ {
12412
+ "parameterName": "callbacks",
12413
+ "parameterTypeTokenRange": {
12414
+ "startIndex": 1,
12415
+ "endIndex": 2
12416
+ },
12417
+ "isOptional": false
12418
+ }
12419
+ ],
12420
+ "isOptional": false,
12421
+ "isAbstract": false,
12422
+ "name": "config"
12423
+ },
12339
12424
  {
12340
12425
  "kind": "Method",
12341
12426
  "canonicalReference": "@microsoft/fast-element!HydratableElementController#connect:member(1)",
@@ -12508,6 +12593,37 @@
12508
12593
  "isAbstract": false,
12509
12594
  "name": "install"
12510
12595
  },
12596
+ {
12597
+ "kind": "Property",
12598
+ "canonicalReference": "@microsoft/fast-element!HydratableElementController.lifecycleCallbacks:member",
12599
+ "docComment": "/**\n * Lifecycle callbacks for hydration events\n */\n",
12600
+ "excerptTokens": [
12601
+ {
12602
+ "kind": "Content",
12603
+ "text": "static lifecycleCallbacks?: "
12604
+ },
12605
+ {
12606
+ "kind": "Reference",
12607
+ "text": "HydrationControllerCallbacks",
12608
+ "canonicalReference": "@microsoft/fast-element!HydrationControllerCallbacks:interface"
12609
+ },
12610
+ {
12611
+ "kind": "Content",
12612
+ "text": ";"
12613
+ }
12614
+ ],
12615
+ "isReadonly": false,
12616
+ "isOptional": true,
12617
+ "releaseTag": "Beta",
12618
+ "name": "lifecycleCallbacks",
12619
+ "propertyTypeTokenRange": {
12620
+ "startIndex": 1,
12621
+ "endIndex": 2
12622
+ },
12623
+ "isStatic": true,
12624
+ "isProtected": false,
12625
+ "isAbstract": false
12626
+ },
12511
12627
  {
12512
12628
  "kind": "Property",
12513
12629
  "canonicalReference": "@microsoft/fast-element!HydratableElementController#needsHydration:member",
@@ -12962,6 +13078,142 @@
12962
13078
  },
12963
13079
  "implementsTokenRanges": []
12964
13080
  },
13081
+ {
13082
+ "kind": "Interface",
13083
+ "canonicalReference": "@microsoft/fast-element!HydrationControllerCallbacks:interface",
13084
+ "docComment": "/**\n * Lifecycle callbacks for element hydration events\n *\n * @public\n */\n",
13085
+ "excerptTokens": [
13086
+ {
13087
+ "kind": "Content",
13088
+ "text": "export interface HydrationControllerCallbacks "
13089
+ }
13090
+ ],
13091
+ "fileUrlPath": "dist/dts/components/element-controller.d.ts",
13092
+ "releaseTag": "Public",
13093
+ "name": "HydrationControllerCallbacks",
13094
+ "preserveMemberOrder": false,
13095
+ "members": [
13096
+ {
13097
+ "kind": "MethodSignature",
13098
+ "canonicalReference": "@microsoft/fast-element!HydrationControllerCallbacks#elementDidHydrate:member(1)",
13099
+ "docComment": "/**\n * Called after hydration has finished\n */\n",
13100
+ "excerptTokens": [
13101
+ {
13102
+ "kind": "Content",
13103
+ "text": "elementDidHydrate?(name: "
13104
+ },
13105
+ {
13106
+ "kind": "Content",
13107
+ "text": "string"
13108
+ },
13109
+ {
13110
+ "kind": "Content",
13111
+ "text": "): "
13112
+ },
13113
+ {
13114
+ "kind": "Content",
13115
+ "text": "void"
13116
+ },
13117
+ {
13118
+ "kind": "Content",
13119
+ "text": ";"
13120
+ }
13121
+ ],
13122
+ "isOptional": true,
13123
+ "returnTypeTokenRange": {
13124
+ "startIndex": 3,
13125
+ "endIndex": 4
13126
+ },
13127
+ "releaseTag": "Public",
13128
+ "overloadIndex": 1,
13129
+ "parameters": [
13130
+ {
13131
+ "parameterName": "name",
13132
+ "parameterTypeTokenRange": {
13133
+ "startIndex": 1,
13134
+ "endIndex": 2
13135
+ },
13136
+ "isOptional": false
13137
+ }
13138
+ ],
13139
+ "name": "elementDidHydrate"
13140
+ },
13141
+ {
13142
+ "kind": "MethodSignature",
13143
+ "canonicalReference": "@microsoft/fast-element!HydrationControllerCallbacks#elementWillHydrate:member(1)",
13144
+ "docComment": "/**\n * Called before hydration has started\n */\n",
13145
+ "excerptTokens": [
13146
+ {
13147
+ "kind": "Content",
13148
+ "text": "elementWillHydrate?(name: "
13149
+ },
13150
+ {
13151
+ "kind": "Content",
13152
+ "text": "string"
13153
+ },
13154
+ {
13155
+ "kind": "Content",
13156
+ "text": "): "
13157
+ },
13158
+ {
13159
+ "kind": "Content",
13160
+ "text": "void"
13161
+ },
13162
+ {
13163
+ "kind": "Content",
13164
+ "text": ";"
13165
+ }
13166
+ ],
13167
+ "isOptional": true,
13168
+ "returnTypeTokenRange": {
13169
+ "startIndex": 3,
13170
+ "endIndex": 4
13171
+ },
13172
+ "releaseTag": "Public",
13173
+ "overloadIndex": 1,
13174
+ "parameters": [
13175
+ {
13176
+ "parameterName": "name",
13177
+ "parameterTypeTokenRange": {
13178
+ "startIndex": 1,
13179
+ "endIndex": 2
13180
+ },
13181
+ "isOptional": false
13182
+ }
13183
+ ],
13184
+ "name": "elementWillHydrate"
13185
+ },
13186
+ {
13187
+ "kind": "MethodSignature",
13188
+ "canonicalReference": "@microsoft/fast-element!HydrationControllerCallbacks#hydrationComplete:member(1)",
13189
+ "docComment": "/**\n * Called after all elements have completed hydration\n */\n",
13190
+ "excerptTokens": [
13191
+ {
13192
+ "kind": "Content",
13193
+ "text": "hydrationComplete?(): "
13194
+ },
13195
+ {
13196
+ "kind": "Content",
13197
+ "text": "void"
13198
+ },
13199
+ {
13200
+ "kind": "Content",
13201
+ "text": ";"
13202
+ }
13203
+ ],
13204
+ "isOptional": true,
13205
+ "returnTypeTokenRange": {
13206
+ "startIndex": 1,
13207
+ "endIndex": 2
13208
+ },
13209
+ "releaseTag": "Public",
13210
+ "overloadIndex": 1,
13211
+ "parameters": [],
13212
+ "name": "hydrationComplete"
13213
+ }
13214
+ ],
13215
+ "extendsTokenRanges": []
13216
+ },
12965
13217
  {
12966
13218
  "kind": "Class",
12967
13219
  "canonicalReference": "@microsoft/fast-element!InlineTemplateDirective:class",
@@ -14973,6 +15225,34 @@
14973
15225
  "endIndex": 2
14974
15226
  }
14975
15227
  },
15228
+ {
15229
+ "kind": "PropertySignature",
15230
+ "canonicalReference": "@microsoft/fast-element!PartialFASTElementDefinition#lifecycleCallbacks:member",
15231
+ "docComment": "/**\n * Lifecycle callbacks for template events.\n */\n",
15232
+ "excerptTokens": [
15233
+ {
15234
+ "kind": "Content",
15235
+ "text": "readonly lifecycleCallbacks?: "
15236
+ },
15237
+ {
15238
+ "kind": "Reference",
15239
+ "text": "TemplateLifecycleCallbacks",
15240
+ "canonicalReference": "@microsoft/fast-element!TemplateLifecycleCallbacks:interface"
15241
+ },
15242
+ {
15243
+ "kind": "Content",
15244
+ "text": ";"
15245
+ }
15246
+ ],
15247
+ "isReadonly": true,
15248
+ "isOptional": true,
15249
+ "releaseTag": "Public",
15250
+ "name": "lifecycleCallbacks",
15251
+ "propertyTypeTokenRange": {
15252
+ "startIndex": 1,
15253
+ "endIndex": 2
15254
+ }
15255
+ },
14976
15256
  {
14977
15257
  "kind": "PropertySignature",
14978
15258
  "canonicalReference": "@microsoft/fast-element!PartialFASTElementDefinition#name:member",
@@ -20790,10 +21070,118 @@
20790
21070
  ],
20791
21071
  "extendsTokenRanges": []
20792
21072
  },
21073
+ {
21074
+ "kind": "Interface",
21075
+ "canonicalReference": "@microsoft/fast-element!TemplateLifecycleCallbacks:interface",
21076
+ "docComment": "/**\n * Lifecycle callbacks for template events.\n *\n * @public\n */\n",
21077
+ "excerptTokens": [
21078
+ {
21079
+ "kind": "Content",
21080
+ "text": "export interface TemplateLifecycleCallbacks "
21081
+ }
21082
+ ],
21083
+ "fileUrlPath": "dist/dts/components/fast-definitions.d.ts",
21084
+ "releaseTag": "Public",
21085
+ "name": "TemplateLifecycleCallbacks",
21086
+ "preserveMemberOrder": false,
21087
+ "members": [
21088
+ {
21089
+ "kind": "MethodSignature",
21090
+ "canonicalReference": "@microsoft/fast-element!TemplateLifecycleCallbacks#elementDidDefine:member(1)",
21091
+ "docComment": "/**\n * Called after the custom element has been defined\n */\n",
21092
+ "excerptTokens": [
21093
+ {
21094
+ "kind": "Content",
21095
+ "text": "elementDidDefine?(name: "
21096
+ },
21097
+ {
21098
+ "kind": "Content",
21099
+ "text": "string"
21100
+ },
21101
+ {
21102
+ "kind": "Content",
21103
+ "text": "): "
21104
+ },
21105
+ {
21106
+ "kind": "Content",
21107
+ "text": "void"
21108
+ },
21109
+ {
21110
+ "kind": "Content",
21111
+ "text": ";"
21112
+ }
21113
+ ],
21114
+ "isOptional": true,
21115
+ "returnTypeTokenRange": {
21116
+ "startIndex": 3,
21117
+ "endIndex": 4
21118
+ },
21119
+ "releaseTag": "Public",
21120
+ "overloadIndex": 1,
21121
+ "parameters": [
21122
+ {
21123
+ "parameterName": "name",
21124
+ "parameterTypeTokenRange": {
21125
+ "startIndex": 1,
21126
+ "endIndex": 2
21127
+ },
21128
+ "isOptional": false
21129
+ }
21130
+ ],
21131
+ "name": "elementDidDefine"
21132
+ },
21133
+ {
21134
+ "kind": "MethodSignature",
21135
+ "canonicalReference": "@microsoft/fast-element!TemplateLifecycleCallbacks#templateDidUpdate:member(1)",
21136
+ "docComment": "/**\n * Called after the template has been assigned to the definition\n */\n",
21137
+ "excerptTokens": [
21138
+ {
21139
+ "kind": "Content",
21140
+ "text": "templateDidUpdate?(name: "
21141
+ },
21142
+ {
21143
+ "kind": "Content",
21144
+ "text": "string"
21145
+ },
21146
+ {
21147
+ "kind": "Content",
21148
+ "text": "): "
21149
+ },
21150
+ {
21151
+ "kind": "Content",
21152
+ "text": "void"
21153
+ },
21154
+ {
21155
+ "kind": "Content",
21156
+ "text": ";"
21157
+ }
21158
+ ],
21159
+ "isOptional": true,
21160
+ "returnTypeTokenRange": {
21161
+ "startIndex": 3,
21162
+ "endIndex": 4
21163
+ },
21164
+ "releaseTag": "Public",
21165
+ "overloadIndex": 1,
21166
+ "parameters": [
21167
+ {
21168
+ "parameterName": "name",
21169
+ "parameterTypeTokenRange": {
21170
+ "startIndex": 1,
21171
+ "endIndex": 2
21172
+ },
21173
+ "isOptional": false
21174
+ }
21175
+ ],
21176
+ "name": "templateDidUpdate"
21177
+ }
21178
+ ],
21179
+ "extendsTokenRanges": []
21180
+ },
20793
21181
  {
20794
21182
  "kind": "TypeAlias",
20795
21183
  "canonicalReference": "@microsoft/fast-element!TemplateOptions:type",
20796
- "docComment": "/**\n * Template options.\n *\n * @alpha\n */\n",
21184
+ "docComment": "/**\n * Type for the `TemplateOptions` const enum.\n *\n * @alpha\n */\n",
20797
21185
  "excerptTokens": [
20798
21186
  {
20799
21187
  "kind": "Content",
@@ -20801,7 +21189,25 @@
20801
21189
  },
20802
21190
  {
20803
21191
  "kind": "Content",
20804
- "text": "\"defer-and-hydrate\""
21192
+ "text": "(typeof "
21193
+ },
21194
+ {
21195
+ "kind": "Reference",
21196
+ "text": "TemplateOptions",
21197
+ "canonicalReference": "@microsoft/fast-element!TemplateOptions:var"
21198
+ },
21199
+ {
21200
+ "kind": "Content",
21201
+ "text": ")[keyof typeof "
21202
+ },
21203
+ {
21204
+ "kind": "Reference",
21205
+ "text": "TemplateOptions",
21206
+ "canonicalReference": "@microsoft/fast-element!TemplateOptions:var"
21207
+ },
21208
+ {
21209
+ "kind": "Content",
21210
+ "text": "]"
20805
21211
  },
20806
21212
  {
20807
21213
  "kind": "Content",
@@ -20812,6 +21218,29 @@
20812
21218
  "releaseTag": "Alpha",
20813
21219
  "name": "TemplateOptions",
20814
21220
  "typeTokenRange": {
21221
+ "startIndex": 1,
21222
+ "endIndex": 6
21223
+ }
21224
+ },
21225
+ {
21226
+ "kind": "Variable",
21227
+ "canonicalReference": "@microsoft/fast-element!TemplateOptions:var",
21228
+ "docComment": "/**\n * Values for the `templateOptions` property.\n *\n * @alpha\n */\n",
21229
+ "excerptTokens": [
21230
+ {
21231
+ "kind": "Content",
21232
+ "text": "TemplateOptions: "
21233
+ },
21234
+ {
21235
+ "kind": "Content",
21236
+ "text": "{\n readonly deferAndHydrate: \"defer-and-hydrate\";\n}"
21237
+ }
21238
+ ],
21239
+ "fileUrlPath": "dist/dts/components/fast-definitions.d.ts",
21240
+ "isReadonly": true,
21241
+ "releaseTag": "Alpha",
21242
+ "name": "TemplateOptions",
21243
+ "variableTypeTokenRange": {
20815
21244
  "startIndex": 1,
20816
21245
  "endIndex": 2
20817
21246
  }