@genesislcap/foundation-layout 14.393.2 → 14.393.3-FUI-2471.2
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.
- package/dist/custom-elements.json +318 -24
- package/dist/dts/index.d.ts +1 -1
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/main/layout-main.d.ts +12 -5
- package/dist/dts/main/layout-main.d.ts.map +1 -1
- package/dist/dts/main/layout-popout-controller.d.ts +40 -0
- package/dist/dts/main/layout-popout-controller.d.ts.map +1 -0
- package/dist/dts/utils/constants.d.ts +7 -1
- package/dist/dts/utils/constants.d.ts.map +1 -1
- package/dist/dts/utils/index.d.ts +1 -0
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/dts/utils/popout-events.d.ts +37 -0
- package/dist/dts/utils/popout-events.d.ts.map +1 -0
- package/dist/dts/utils/types.d.ts +28 -0
- package/dist/dts/utils/types.d.ts.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/main/layout-main.js +47 -21
- package/dist/esm/main/layout-popout-controller.js +243 -0
- package/dist/esm/utils/constants.js +7 -1
- package/dist/esm/utils/index.js +1 -0
- package/dist/esm/utils/popout-events.js +5 -0
- package/dist/foundation-layout.api.json +94 -10
- package/dist/foundation-layout.d.ts +96 -4
- package/docs/api/foundation-layout.foundationlayout.md +3 -3
- package/docs/api/foundation-layout.foundationlayout.popoutconfig.md +2 -2
- package/docs/api/foundation-layout.foundationlayout.tryactivatepopoutmode.md +38 -1
- package/docs/api/foundation-layout.layout_popout_control_key.md +16 -0
- package/docs/api/foundation-layout.layoutpopoutconfig.md +22 -0
- package/docs/api/foundation-layout.md +22 -0
- package/docs/api/foundation-layout.serialisedlayout.md +3 -0
- package/docs/api-report.md.api.md +29 -2
- package/package.json +15 -13
|
@@ -143,6 +143,22 @@
|
|
|
143
143
|
"module": "./utils"
|
|
144
144
|
}
|
|
145
145
|
},
|
|
146
|
+
{
|
|
147
|
+
"kind": "js",
|
|
148
|
+
"name": "LAYOUT_POPOUT_CONTROL_KEY",
|
|
149
|
+
"declaration": {
|
|
150
|
+
"name": "LAYOUT_POPOUT_CONTROL_KEY",
|
|
151
|
+
"module": "./utils"
|
|
152
|
+
}
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"kind": "js",
|
|
156
|
+
"name": "LayoutPopoutConfig",
|
|
157
|
+
"declaration": {
|
|
158
|
+
"name": "LayoutPopoutConfig",
|
|
159
|
+
"module": "./utils"
|
|
160
|
+
}
|
|
161
|
+
},
|
|
146
162
|
{
|
|
147
163
|
"kind": "js",
|
|
148
164
|
"name": "registerFactory",
|
|
@@ -600,19 +616,10 @@
|
|
|
600
616
|
"kind": "field",
|
|
601
617
|
"name": "popoutConfig",
|
|
602
618
|
"type": {
|
|
603
|
-
"text": "
|
|
619
|
+
"text": "LayoutPopoutConfig | undefined"
|
|
604
620
|
},
|
|
605
621
|
"default": "undefined",
|
|
606
|
-
"description": "Controls whether popout functionality is enabled on the layout. Defaults to disabled.\
|
|
607
|
-
},
|
|
608
|
-
{
|
|
609
|
-
"kind": "field",
|
|
610
|
-
"name": "popupMode",
|
|
611
|
-
"type": {
|
|
612
|
-
"text": "boolean"
|
|
613
|
-
},
|
|
614
|
-
"privacy": "private",
|
|
615
|
-
"default": "false"
|
|
622
|
+
"description": "Controls whether popout functionality is enabled on the layout. Defaults to disabled.\nPass an empty object `{}` to use default configurations, or a LayoutPopoutConfig object to further customise."
|
|
616
623
|
},
|
|
617
624
|
{
|
|
618
625
|
"kind": "method",
|
|
@@ -663,6 +670,16 @@
|
|
|
663
670
|
"text": "boolean"
|
|
664
671
|
}
|
|
665
672
|
},
|
|
673
|
+
"parameters": [
|
|
674
|
+
{
|
|
675
|
+
"name": "autoloading",
|
|
676
|
+
"default": "false",
|
|
677
|
+
"type": {
|
|
678
|
+
"text": "boolean"
|
|
679
|
+
},
|
|
680
|
+
"description": "If true, this respects the {@link LayoutPopoutConfig.loadAutomatically}property.\n * You might want to set this to false and call it manually if you're manually registering components to the layout in order to avoid race conditions.\n * "
|
|
681
|
+
}
|
|
682
|
+
],
|
|
666
683
|
"description": "If in a popout window from the dynamic layout, this function will run the flow to put the component in popout mode.\nThis function is automatically called if using the declarative HTML API, but if only using the JavaScript API then you will need to call this function manually."
|
|
667
684
|
},
|
|
668
685
|
{
|
|
@@ -966,18 +983,6 @@
|
|
|
966
983
|
},
|
|
967
984
|
"description": "Attribute which if set will auto save and load the layout as the user changes it.\nOmit this attribute to disable this feature.\nSet attribute using `auto-save-key`.",
|
|
968
985
|
"fieldName": "autoSaveKey"
|
|
969
|
-
},
|
|
970
|
-
{
|
|
971
|
-
"name": "popout-config",
|
|
972
|
-
"type": {
|
|
973
|
-
"text": "string | undefined"
|
|
974
|
-
},
|
|
975
|
-
"default": "undefined",
|
|
976
|
-
"description": "Controls whether popout functionality is enabled on the layout. Defaults to disabled.\nSet this attribute to any string to enable popout functionality. If this string is of format `number;number` then this will be interpreted as the width and height of the popout window.",
|
|
977
|
-
"resolveInitializer": {
|
|
978
|
-
"module": "src/main/layout-main.ts"
|
|
979
|
-
},
|
|
980
|
-
"fieldName": "popoutConfig"
|
|
981
986
|
}
|
|
982
987
|
],
|
|
983
988
|
"superclass": {
|
|
@@ -990,7 +995,7 @@
|
|
|
990
995
|
{
|
|
991
996
|
"kind": "variable",
|
|
992
997
|
"name": "layoutTemplate",
|
|
993
|
-
"default": "html<FoundationLayout>`\n <template>\n ${when((x) => !x.hasFirstLoaded && x.usingDeclerativeAPI, loadingTemplate)}\n <div class=\"layout-container\" ${ref('layoutElement')}></div>\n </template>\n`",
|
|
998
|
+
"default": "html<FoundationLayout>`\n <template>\n ${when(\n (x) => Boolean(x.popoutConfig),\n html<FoundationLayout>`\n <foundation-layout-popout-controller\n ${ref('popoutController')}\n channel-name=\"${(x) => x.popoutConfig?.channelName}\"\n ></foundation-layout-popout-controller>\n `,\n )}\n ${when((x) => !x.hasFirstLoaded && x.usingDeclerativeAPI, loadingTemplate)}\n <div class=\"layout-container\" ${ref('layoutElement')}></div>\n </template>\n`",
|
|
994
999
|
"description": "`ViewTemplate` which defines the html for FoundationLayout.",
|
|
995
1000
|
"privacy": "public"
|
|
996
1001
|
}
|
|
@@ -1022,6 +1027,227 @@
|
|
|
1022
1027
|
}
|
|
1023
1028
|
]
|
|
1024
1029
|
},
|
|
1030
|
+
{
|
|
1031
|
+
"kind": "javascript-module",
|
|
1032
|
+
"path": "src/main/layout-popout-controller.ts",
|
|
1033
|
+
"declarations": [
|
|
1034
|
+
{
|
|
1035
|
+
"kind": "class",
|
|
1036
|
+
"description": "",
|
|
1037
|
+
"name": "FoundationLayoutPopoutController",
|
|
1038
|
+
"members": [
|
|
1039
|
+
{
|
|
1040
|
+
"kind": "field",
|
|
1041
|
+
"name": "channelName",
|
|
1042
|
+
"type": {
|
|
1043
|
+
"text": "string"
|
|
1044
|
+
}
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
"kind": "field",
|
|
1048
|
+
"name": "layoutKey",
|
|
1049
|
+
"type": {
|
|
1050
|
+
"text": "string"
|
|
1051
|
+
},
|
|
1052
|
+
"privacy": "private"
|
|
1053
|
+
},
|
|
1054
|
+
{
|
|
1055
|
+
"kind": "field",
|
|
1056
|
+
"name": "channel",
|
|
1057
|
+
"type": {
|
|
1058
|
+
"text": "TypedBroadcastChannel<LayoutPopoutEvents>"
|
|
1059
|
+
},
|
|
1060
|
+
"privacy": "private"
|
|
1061
|
+
},
|
|
1062
|
+
{
|
|
1063
|
+
"kind": "field",
|
|
1064
|
+
"name": "pollInterval",
|
|
1065
|
+
"type": {
|
|
1066
|
+
"text": "any"
|
|
1067
|
+
},
|
|
1068
|
+
"privacy": "private"
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"kind": "field",
|
|
1072
|
+
"name": "unloadHandler",
|
|
1073
|
+
"type": {
|
|
1074
|
+
"text": "() => void"
|
|
1075
|
+
},
|
|
1076
|
+
"privacy": "private"
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"kind": "field",
|
|
1080
|
+
"name": "lastGeometry",
|
|
1081
|
+
"type": {
|
|
1082
|
+
"text": "string"
|
|
1083
|
+
},
|
|
1084
|
+
"privacy": "private"
|
|
1085
|
+
},
|
|
1086
|
+
{
|
|
1087
|
+
"kind": "field",
|
|
1088
|
+
"name": "popoutRegistry",
|
|
1089
|
+
"type": {
|
|
1090
|
+
"text": "Map<string, { geometry: PopoutState['geometry']; window?: Window }>"
|
|
1091
|
+
},
|
|
1092
|
+
"privacy": "private",
|
|
1093
|
+
"default": "new Map()"
|
|
1094
|
+
},
|
|
1095
|
+
{
|
|
1096
|
+
"kind": "method",
|
|
1097
|
+
"name": "setupChannel",
|
|
1098
|
+
"privacy": "private"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"kind": "method",
|
|
1102
|
+
"name": "setupListener",
|
|
1103
|
+
"privacy": "private"
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
"kind": "method",
|
|
1107
|
+
"name": "setupUnloadListener",
|
|
1108
|
+
"privacy": "private"
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"kind": "method",
|
|
1112
|
+
"name": "teardownUnloadListener",
|
|
1113
|
+
"privacy": "private"
|
|
1114
|
+
},
|
|
1115
|
+
{
|
|
1116
|
+
"kind": "method",
|
|
1117
|
+
"name": "emitAutosave",
|
|
1118
|
+
"privacy": "private"
|
|
1119
|
+
},
|
|
1120
|
+
{
|
|
1121
|
+
"kind": "method",
|
|
1122
|
+
"name": "startPolling",
|
|
1123
|
+
"privacy": "private"
|
|
1124
|
+
},
|
|
1125
|
+
{
|
|
1126
|
+
"kind": "method",
|
|
1127
|
+
"name": "stopPolling",
|
|
1128
|
+
"privacy": "private"
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"kind": "method",
|
|
1132
|
+
"name": "getGeometry",
|
|
1133
|
+
"privacy": "private"
|
|
1134
|
+
},
|
|
1135
|
+
{
|
|
1136
|
+
"kind": "method",
|
|
1137
|
+
"name": "broadcastGeometry",
|
|
1138
|
+
"privacy": "private",
|
|
1139
|
+
"parameters": [
|
|
1140
|
+
{
|
|
1141
|
+
"name": "geometry",
|
|
1142
|
+
"type": {
|
|
1143
|
+
"text": "Awaited<ReturnType<typeof this.getGeometry>>"
|
|
1144
|
+
}
|
|
1145
|
+
}
|
|
1146
|
+
]
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"kind": "method",
|
|
1150
|
+
"name": "openPopout",
|
|
1151
|
+
"privacy": "public",
|
|
1152
|
+
"parameters": [
|
|
1153
|
+
{
|
|
1154
|
+
"name": "registration",
|
|
1155
|
+
"type": {
|
|
1156
|
+
"text": "string"
|
|
1157
|
+
},
|
|
1158
|
+
"description": "The registration ID of the component to pop out."
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"name": "geometry",
|
|
1162
|
+
"optional": true,
|
|
1163
|
+
"type": {
|
|
1164
|
+
"text": "any"
|
|
1165
|
+
},
|
|
1166
|
+
"description": "Optional geometry to use for the new window."
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"name": "uuid",
|
|
1170
|
+
"optional": true,
|
|
1171
|
+
"type": {
|
|
1172
|
+
"text": "any"
|
|
1173
|
+
},
|
|
1174
|
+
"description": "UUID generator from parent layout"
|
|
1175
|
+
}
|
|
1176
|
+
],
|
|
1177
|
+
"description": "Opens a component in a popout window."
|
|
1178
|
+
},
|
|
1179
|
+
{
|
|
1180
|
+
"kind": "method",
|
|
1181
|
+
"name": "getRegistry",
|
|
1182
|
+
"privacy": "public",
|
|
1183
|
+
"return": {
|
|
1184
|
+
"type": {
|
|
1185
|
+
"text": "{ [layoutKey: string]: PopoutState }"
|
|
1186
|
+
}
|
|
1187
|
+
}
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
"kind": "method",
|
|
1191
|
+
"name": "restorePopouts",
|
|
1192
|
+
"privacy": "public",
|
|
1193
|
+
"parameters": [
|
|
1194
|
+
{
|
|
1195
|
+
"name": "registry",
|
|
1196
|
+
"type": {
|
|
1197
|
+
"text": "{ [layoutKey: string]: PopoutState }"
|
|
1198
|
+
}
|
|
1199
|
+
},
|
|
1200
|
+
{
|
|
1201
|
+
"name": "uuid",
|
|
1202
|
+
"type": {
|
|
1203
|
+
"text": "any"
|
|
1204
|
+
}
|
|
1205
|
+
}
|
|
1206
|
+
],
|
|
1207
|
+
"description": "Restores popouts from a registry"
|
|
1208
|
+
},
|
|
1209
|
+
{
|
|
1210
|
+
"kind": "method",
|
|
1211
|
+
"name": "closeAllPopouts",
|
|
1212
|
+
"privacy": "public"
|
|
1213
|
+
}
|
|
1214
|
+
],
|
|
1215
|
+
"attributes": [
|
|
1216
|
+
{
|
|
1217
|
+
"name": "channel-name",
|
|
1218
|
+
"type": {
|
|
1219
|
+
"text": "string"
|
|
1220
|
+
},
|
|
1221
|
+
"fieldName": "channelName"
|
|
1222
|
+
}
|
|
1223
|
+
],
|
|
1224
|
+
"superclass": {
|
|
1225
|
+
"name": "FASTElement",
|
|
1226
|
+
"package": "@microsoft/fast-element"
|
|
1227
|
+
},
|
|
1228
|
+
"tagName": "foundation-layout-popout-controller",
|
|
1229
|
+
"customElement": true
|
|
1230
|
+
}
|
|
1231
|
+
],
|
|
1232
|
+
"exports": [
|
|
1233
|
+
{
|
|
1234
|
+
"kind": "js",
|
|
1235
|
+
"name": "FoundationLayoutPopoutController",
|
|
1236
|
+
"declaration": {
|
|
1237
|
+
"name": "FoundationLayoutPopoutController",
|
|
1238
|
+
"module": "src/main/layout-popout-controller.ts"
|
|
1239
|
+
}
|
|
1240
|
+
},
|
|
1241
|
+
{
|
|
1242
|
+
"kind": "custom-element-definition",
|
|
1243
|
+
"name": "foundation-layout-popout-controller",
|
|
1244
|
+
"declaration": {
|
|
1245
|
+
"name": "FoundationLayoutPopoutController",
|
|
1246
|
+
"module": "src/main/layout-popout-controller.ts"
|
|
1247
|
+
}
|
|
1248
|
+
}
|
|
1249
|
+
]
|
|
1250
|
+
},
|
|
1025
1251
|
{
|
|
1026
1252
|
"kind": "javascript-module",
|
|
1027
1253
|
"path": "src/main/layout-region.ts",
|
|
@@ -1336,6 +1562,24 @@
|
|
|
1336
1562
|
"description": "Default time in milliseconds for the layout to buffer calls to reloading\nthe layout while the declarative API is loading.\n\nDuring the first load of the layout, a loading spinner will be shown.",
|
|
1337
1563
|
"privacy": "public"
|
|
1338
1564
|
},
|
|
1565
|
+
{
|
|
1566
|
+
"kind": "variable",
|
|
1567
|
+
"name": "LAYOUT_POPOUT_CONTROL_KEY",
|
|
1568
|
+
"type": {
|
|
1569
|
+
"text": "string"
|
|
1570
|
+
},
|
|
1571
|
+
"default": "'f-layout-key'",
|
|
1572
|
+
"description": "Key to be used for controlling popout behaviour"
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"kind": "variable",
|
|
1576
|
+
"name": "POPOUT_GEOMETRY_BROADCAST_INTERVAL",
|
|
1577
|
+
"type": {
|
|
1578
|
+
"text": "number"
|
|
1579
|
+
},
|
|
1580
|
+
"default": "1000",
|
|
1581
|
+
"description": "How often a popout window should check to broadcast its\ngeometry"
|
|
1582
|
+
},
|
|
1339
1583
|
{
|
|
1340
1584
|
"kind": "variable",
|
|
1341
1585
|
"name": "LAYOUT_POPOUT_CONTAINER_CLASS",
|
|
@@ -1367,6 +1611,22 @@
|
|
|
1367
1611
|
"module": "src/utils/constants.ts"
|
|
1368
1612
|
}
|
|
1369
1613
|
},
|
|
1614
|
+
{
|
|
1615
|
+
"kind": "js",
|
|
1616
|
+
"name": "LAYOUT_POPOUT_CONTROL_KEY",
|
|
1617
|
+
"declaration": {
|
|
1618
|
+
"name": "LAYOUT_POPOUT_CONTROL_KEY",
|
|
1619
|
+
"module": "src/utils/constants.ts"
|
|
1620
|
+
}
|
|
1621
|
+
},
|
|
1622
|
+
{
|
|
1623
|
+
"kind": "js",
|
|
1624
|
+
"name": "POPOUT_GEOMETRY_BROADCAST_INTERVAL",
|
|
1625
|
+
"declaration": {
|
|
1626
|
+
"name": "POPOUT_GEOMETRY_BROADCAST_INTERVAL",
|
|
1627
|
+
"module": "src/utils/constants.ts"
|
|
1628
|
+
}
|
|
1629
|
+
},
|
|
1370
1630
|
{
|
|
1371
1631
|
"kind": "js",
|
|
1372
1632
|
"name": "LAYOUT_POPOUT_CONTAINER_CLASS",
|
|
@@ -1631,6 +1891,14 @@
|
|
|
1631
1891
|
"package": "./templates"
|
|
1632
1892
|
}
|
|
1633
1893
|
},
|
|
1894
|
+
{
|
|
1895
|
+
"kind": "js",
|
|
1896
|
+
"name": "*",
|
|
1897
|
+
"declaration": {
|
|
1898
|
+
"name": "*",
|
|
1899
|
+
"package": "./popout-events"
|
|
1900
|
+
}
|
|
1901
|
+
},
|
|
1634
1902
|
{
|
|
1635
1903
|
"kind": "js",
|
|
1636
1904
|
"name": "*",
|
|
@@ -1675,6 +1943,32 @@
|
|
|
1675
1943
|
"declarations": [],
|
|
1676
1944
|
"exports": []
|
|
1677
1945
|
},
|
|
1946
|
+
{
|
|
1947
|
+
"kind": "javascript-module",
|
|
1948
|
+
"path": "src/utils/popout-events.ts",
|
|
1949
|
+
"declarations": [
|
|
1950
|
+
{
|
|
1951
|
+
"kind": "variable",
|
|
1952
|
+
"name": "LAYOUT_POPOUT_CHANNEL_NAME",
|
|
1953
|
+
"type": {
|
|
1954
|
+
"text": "string"
|
|
1955
|
+
},
|
|
1956
|
+
"default": "'f-layout-popout-channel'",
|
|
1957
|
+
"description": "Name of the default broadcast channel used for layout popouts",
|
|
1958
|
+
"privacy": "public"
|
|
1959
|
+
}
|
|
1960
|
+
],
|
|
1961
|
+
"exports": [
|
|
1962
|
+
{
|
|
1963
|
+
"kind": "js",
|
|
1964
|
+
"name": "LAYOUT_POPOUT_CHANNEL_NAME",
|
|
1965
|
+
"declaration": {
|
|
1966
|
+
"name": "LAYOUT_POPOUT_CHANNEL_NAME",
|
|
1967
|
+
"module": "src/utils/popout-events.ts"
|
|
1968
|
+
}
|
|
1969
|
+
}
|
|
1970
|
+
]
|
|
1971
|
+
},
|
|
1678
1972
|
{
|
|
1679
1973
|
"kind": "javascript-module",
|
|
1680
1974
|
"path": "src/utils/templates.ts",
|
package/dist/dts/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export * from './main';
|
|
2
2
|
export { LAYOUT_ICONS } from './styles';
|
|
3
|
-
export { ComponentFactory, CustomButton, DEFAULT_RELOAD_BUFFER, LayoutComponentWithState, LayoutEmitEvents, LayoutReceiveEvents, LayoutReceiveEventsDetail, LayoutRegionType, LayoutRegistrationError, LayoutUsageError, Placement, RegisteredElementConfig, RegistrationConfig, SerialisedLayout, LAYOUT_POPOUT_CONTAINER_CLASS, } from './utils';
|
|
3
|
+
export { ComponentFactory, CustomButton, DEFAULT_RELOAD_BUFFER, LayoutComponentWithState, LayoutEmitEvents, LayoutReceiveEvents, LayoutReceiveEventsDetail, LayoutRegionType, LayoutRegistrationError, LayoutUsageError, Placement, RegisteredElementConfig, RegistrationConfig, SerialisedLayout, LAYOUT_POPOUT_CONTAINER_CLASS, LAYOUT_POPOUT_CONTROL_KEY, LayoutPopoutConfig, } from './utils';
|
|
4
4
|
export { registerFactory, getFactory, unregisterFactory } from './utils/factory-registry';
|
|
5
5
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/dts/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,qBAAqB,EACrB,wBAAwB,EACxB,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,uBAAuB,EACvB,gBAAgB,EAChB,SAAS,EACT,uBAAuB,EACvB,kBAAkB,EAClB,gBAAgB,EAChB,6BAA6B,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,qBAAqB,EACrB,wBAAwB,EACxB,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,uBAAuB,EACvB,gBAAgB,EAChB,SAAS,EACT,uBAAuB,EACvB,kBAAkB,EAClB,gBAAgB,EAChB,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { LayoutConfig, RootItemConfig } from '@genesis-community/golden-layout';
|
|
2
2
|
import { FoundationElement } from '@microsoft/fast-foundation';
|
|
3
|
-
import { ComponentFactory, componentType, CustomButton, LayoutComponent, Placement, RegisteredElementConfig, RegistrationConfig, SerialisedLayout } from '../utils/';
|
|
3
|
+
import { ComponentFactory, componentType, CustomButton, LayoutComponent, LayoutPopoutConfig, Placement, RegisteredElementConfig, RegistrationConfig, SerialisedLayout } from '../utils/';
|
|
4
|
+
import { FoundationLayoutPopoutController } from './layout-popout-controller';
|
|
4
5
|
export { layoutStyles } from '../styles';
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
@@ -95,13 +96,16 @@ export declare class FoundationLayout extends FoundationElement implements Layou
|
|
|
95
96
|
* has changed and know you potentially need to gate some of your lifecycle functionality.
|
|
96
97
|
*/
|
|
97
98
|
lifecycleUpdateToken: string | undefined;
|
|
99
|
+
/** @internal */
|
|
100
|
+
popupMode: boolean;
|
|
101
|
+
/** @internal */
|
|
102
|
+
popoutController: FoundationLayoutPopoutController;
|
|
98
103
|
/**
|
|
99
104
|
* Controls whether popout functionality is enabled on the layout. Defaults to disabled.
|
|
100
|
-
*
|
|
105
|
+
* Pass an empty object `{}` to use default configurations, or a {@link LayoutPopoutConfig} object to further customise.
|
|
101
106
|
* @beta
|
|
102
107
|
*/
|
|
103
|
-
popoutConfig:
|
|
104
|
-
private popupMode;
|
|
108
|
+
popoutConfig: LayoutPopoutConfig | undefined;
|
|
105
109
|
/** @internal */
|
|
106
110
|
constructor();
|
|
107
111
|
/** @internal */
|
|
@@ -172,9 +176,12 @@ export declare class FoundationLayout extends FoundationElement implements Layou
|
|
|
172
176
|
* If you set the `LAYOUT_POPOUT_CONTAINER_CLASS` on an element which is a DOM parent of the layout,
|
|
173
177
|
* then if the layout goes into popout mode then it will place itself as the only child for the popout container you set.
|
|
174
178
|
* It is likely you'll want to attach this class to your design system provider.
|
|
179
|
+
*
|
|
180
|
+
* @param autoloading - If true, this respects the {@link LayoutPopoutConfig.loadAutomatically} property.
|
|
181
|
+
* You might want to set this to false and call it manually if you're manually registering components to the layout in order to avoid race conditions.
|
|
175
182
|
* @beta
|
|
176
183
|
*/
|
|
177
|
-
tryActivatePopoutMode(): boolean;
|
|
184
|
+
tryActivatePopoutMode(autoloading?: boolean): boolean;
|
|
178
185
|
/**
|
|
179
186
|
* Try to load a layout from local storage, or return false. Only required if manually calling {@link FoundationLayout.registerItem}
|
|
180
187
|
* @remarks
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"layout-main.d.ts","sourceRoot":"","sources":["../../../src/main/layout-main.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,YAAY,EAEZ,cAAc,EAGf,MAAM,kCAAkC,CAAC;AAK1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAGL,gBAAgB,EAChB,aAAa,EACb,YAAY,EAOZ,eAAe,
|
|
1
|
+
{"version":3,"file":"layout-main.d.ts","sourceRoot":"","sources":["../../../src/main/layout-main.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,YAAY,EAEZ,cAAc,EAGf,MAAM,kCAAkC,CAAC;AAK1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAGL,gBAAgB,EAChB,aAAa,EACb,YAAY,EAOZ,eAAe,EAGf,kBAAkB,EAGlB,SAAS,EAET,uBAAuB,EACvB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,WAAW,CAAC;AAInB,OAAO,EAAE,gCAAgC,EAAE,MAAM,4BAA4B,CAAC;AAE9E,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAmBzC;;;;;;;;;;;GAWG;AACH,qBAAa,gBAAiB,SAAQ,iBAAkB,YAAW,eAAe;;IAChF,OAAO,CAAC,MAAM,CAAe;IAC7B,gBAAgB;IAChB,aAAa,EAAE,WAAW,CAAC;IAC3B,OAAO,CAAC,YAAY,CAAqC;IACzD,OAAO,CAAC,mBAAmB,CAAqC;IAEhE,gBAAgB;IAChB,CAAC,aAAa,CAAC,EAAG,MAAM,CAAU;IAElC;;;;OAIG;IACmC,YAAY,EAAE,MAAM,CAAyB;IACnF,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,oBAAoB,CAAK;IAEjC,gBAAgB;IACV,OAAO,CAAC,IAAI,CAAO;IAEzB,gBAAgB;IACP,OAAO,CAAC,OAAO,CAAU;IAClC;;;;;OAKG;IACmC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC3D;;;;OAIG;IACS,sBAAsB,GAAI,aAAa,MAAM,YAC2B;IAEpF;;;OAGG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC;IAE3C;;;;;;;;;;OAUG;IACS,cAAc,UAAS;IACnC,gBAAgB;IACJ,mBAAmB,UAAS;IAExC;;;;;OAKG;IACH,aAAa,EAAE,YAAY,EAAE,CAAM;IAEnC;;;OAGG;IACS,QAAQ,EAAE,OAAO,CAAS;IAEtC;;;;;OAKG;IACI,KAAK,EAAG,sBAAsB,CAAU;IAE/C;;;;;;;OAOG;IACI,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAa;IAE5D,gBAAgB;IACJ,SAAS,UAAS;IAE9B,gBAAgB;IAChB,gBAAgB,EAAE,gCAAgC,CAAC;IACnD;;;;OAIG;IACS,YAAY,EAAE,kBAAkB,GAAG,SAAS,CAAa;IAErE,gBAAgB;;IAahB,gBAAgB;IAChB,iBAAiB,IAAI,IAAI;IA+BzB,gBAAgB;IAChB,oBAAoB,IAAI,IAAI;IAY5B,gBAAgB;IAChB,OAAO,CAAC,WAAW;IAInB,gBAAgB;IAChB,OAAO,CAAC,UAAU;IAMlB,gBAAgB;IAChB,OAAO,CAAC,eAAe;IAKvB,gBAAgB;IAChB,OAAO,CAAC,gBAAgB;IAIxB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAOzB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAKzB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAIzB,gBAAgB;IAChB,OAAO,CAAC,kBAAkB;IAI1B,gBAAgB;IAChB,OAAO,CAAC,kBAAkB;IAI1B,gBAAgB;IACJ,OAAO,CAAC,eAAe,CAAqB;IACxD,gBAAgB;IAChB,sBAAsB;IAQtB;;OAEG;IAEH;;;;;;;;;;OAUG;IACH,MAAM,CAAC,2BAA2B,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,EAAE;IActE;;;;;;;;OAQG;IACH,eAAe,IAAI,MAAM,EAAE;IAI3B;;;;;;OAMG;IACH,SAAS,IAAI,gBAAgB;IA8B7B;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,WAAW,GAAE,OAAe,GAAG,OAAO;IAyC5D;;;;;;;;;;;;;OAaG;IACH,6BAA6B,IAAI,OAAO;IAcxC;;;;;;;;;;;;OAYG;IACH,+BAA+B,IAAI,OAAO;IAyB1C;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,MAAM,EAAE,gBAAgB,EACxB,iBAAiB,GAAE,aAAa,GAAG,OAAiB,EACpD,YAAY,GAAE,OAAe;IAwC/B;;;;;;;;;;;OAWG;IACH,OAAO,CACL,MAAM,EAAE,uBAAuB,GAAG,uBAAuB,EAAE,EAC3D,SAAS,GAAE,SAAmC;IAsEhD;;;;;;;;;OASG;IACH,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,GAAE,OAAe,GAAG,MAAM;IAgDjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,GAAG,gBAAgB,GAAG,MAAM;IA4B3F;;OAEG;IAEH;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;IACH,mBAAmB,IAAI,IAAI;IAqB3B;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC;IAetD;;;;;;;;OAQG;IACH,wBAAwB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IA4J5D;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAehC;;;;;;;;SAQK;IACL,OAAO,CAAC,kBAAkB;IAY1B;;;;;;;;OAQG;IACH,OAAO,CAAC,kCAAkC;IA4B1C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,oBAAoB;IAe5B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IASzB;;;;;;;;OAQG;IACH,OAAO,CAAC,mBAAmB;IAU3B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAM3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAWpC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;CAgChC;AAKD;;;;;GAKG;AACH,eAAO,MAAM,cAAc,uEAc1B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;2BAI3B,CAAC"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { FASTElement } from '@microsoft/fast-element';
|
|
2
|
+
import { PopoutState } from '../utils';
|
|
3
|
+
export declare class FoundationLayoutPopoutController extends FASTElement {
|
|
4
|
+
channelName: string;
|
|
5
|
+
private layoutKey;
|
|
6
|
+
private channel;
|
|
7
|
+
private pollInterval;
|
|
8
|
+
private unloadHandler;
|
|
9
|
+
private lastGeometry;
|
|
10
|
+
private popoutRegistry;
|
|
11
|
+
connectedCallback(): void;
|
|
12
|
+
disconnectedCallback(): void;
|
|
13
|
+
private setupChannel;
|
|
14
|
+
private setupListener;
|
|
15
|
+
private setupUnloadListener;
|
|
16
|
+
private teardownUnloadListener;
|
|
17
|
+
private emitAutosave;
|
|
18
|
+
private startPolling;
|
|
19
|
+
private stopPolling;
|
|
20
|
+
private getGeometry;
|
|
21
|
+
private broadcastGeometry;
|
|
22
|
+
/**
|
|
23
|
+
* Opens a component in a popout window.
|
|
24
|
+
* @param registration - The registration ID of the component to pop out.
|
|
25
|
+
* @param geometry - Optional geometry to use for the new window.
|
|
26
|
+
* @param uuid - UUID generator from parent layout
|
|
27
|
+
*/
|
|
28
|
+
openPopout(registration: string, geometry?: any, uuid?: any): Promise<Window>;
|
|
29
|
+
getRegistry(): {
|
|
30
|
+
[layoutKey: string]: PopoutState;
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Restores popouts from a registry
|
|
34
|
+
*/
|
|
35
|
+
restorePopouts(registry: {
|
|
36
|
+
[layoutKey: string]: PopoutState;
|
|
37
|
+
}, uuid: any): Promise<void>;
|
|
38
|
+
closeAllPopouts(): void;
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=layout-popout-controller.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"layout-popout-controller.d.ts","sourceRoot":"","sources":["../../../src/main/layout-popout-controller.ts"],"names":[],"mappings":"AAIA,OAAO,EAAuB,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAIL,WAAW,EACZ,MAAM,UAAU,CAAC;AAGlB,qBAKa,gCAAiC,SAAQ,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IAEzD,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,OAAO,CAA4C;IAC3D,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,aAAa,CAAa;IAClC,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,cAAc,CACV;IAEZ,iBAAiB;IAYjB,oBAAoB;IAapB,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,aAAa;IAkBrB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,sBAAsB;IAO9B,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,WAAW;YAML,WAAW;IAwBzB,OAAO,CAAC,iBAAiB;IAWzB;;;;;OAKG;IACU,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG;IA+DjE,WAAW,IAAI;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE;IAU1D;;OAEG;IACU,cAAc,CAAC,QAAQ,EAAE;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,EAAE,IAAI,EAAE,GAAG;IAqB9E,eAAe;CAQvB"}
|
|
@@ -23,9 +23,15 @@ export declare const DEFAULT_RELOAD_BUFFER = 500;
|
|
|
23
23
|
export declare const AUTOSAVE_KEY = "foundation-layout-autosave";
|
|
24
24
|
/**
|
|
25
25
|
* Key to be used for controlling popout behaviour
|
|
26
|
-
* @
|
|
26
|
+
* @beta
|
|
27
27
|
*/
|
|
28
28
|
export declare const LAYOUT_POPOUT_CONTROL_KEY = "f-layout-key";
|
|
29
|
+
/**
|
|
30
|
+
* How often a popout window should check to broadcast its
|
|
31
|
+
* geometry
|
|
32
|
+
* @interal
|
|
33
|
+
*/
|
|
34
|
+
export declare const POPOUT_GEOMETRY_BROADCAST_INTERVAL = 1000;
|
|
29
35
|
/**
|
|
30
36
|
* Put this classname on an element which is a DOM parent of the layout, and
|
|
31
37
|
* if the layout goes into popout mode then it will place itself as the only child
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/utils/constants.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,aAAa,eAA2B,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,eAA+B,CAAC;AAE9D;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,YAAY,+BAA+B,CAAC;AAEzD;;;GAGG;AACH,eAAO,MAAM,yBAAyB,iBAAiB,CAAC;AAExD;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,oBAAoB,CAAC;AAE/D,eAAO,MAAM,kBAAkB,SAAS,CAAC;AAGzC,eAAO,MAAM,qBAAqB,cAKjC,CAAC"}
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/utils/constants.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,aAAa,eAA2B,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,eAA+B,CAAC;AAE9D;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,YAAY,+BAA+B,CAAC;AAEzD;;;GAGG;AACH,eAAO,MAAM,yBAAyB,iBAAiB,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,OAAO,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,oBAAoB,CAAC;AAE/D,eAAO,MAAM,kBAAkB,SAAS,CAAC;AAGzC,eAAO,MAAM,qBAAqB,cAKjC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { EventDetailMap } from '@genesislcap/foundation-events';
|
|
2
|
+
/**
|
|
3
|
+
* Geometry details for a popout window
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type PopoutGeometry = {
|
|
7
|
+
screenX: number;
|
|
8
|
+
screenY: number;
|
|
9
|
+
outerWidth: number;
|
|
10
|
+
outerHeight: number;
|
|
11
|
+
screenId?: string;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Events for layout popout communication
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export interface LayoutPopoutEvents extends EventDetailMap {
|
|
18
|
+
/**
|
|
19
|
+
* Emitted by a popout window when its geometry changes
|
|
20
|
+
*/
|
|
21
|
+
'popout-geometry-change': {
|
|
22
|
+
layoutKey: string;
|
|
23
|
+
geometry: PopoutGeometry;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Emitted by a popout window when it is closed
|
|
27
|
+
*/
|
|
28
|
+
'popout-closed': {
|
|
29
|
+
layoutKey: string;
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Name of the default broadcast channel used for layout popouts
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
export declare const LAYOUT_POPOUT_CHANNEL_NAME = "f-layout-popout-channel";
|
|
37
|
+
//# sourceMappingURL=popout-events.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"popout-events.d.ts","sourceRoot":"","sources":["../../../src/utils/popout-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;OAEG;IACH,wBAAwB,EAAE;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,cAAc,CAAC;KAC1B,CAAC;IACF;;OAEG;IACH,eAAe,EAAE;QACf,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;;GAGG;AACH,eAAO,MAAM,0BAA0B,4BAA4B,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { ComponentContainer, ResolvedLayoutConfig } from '@genesis-community/golden-layout';
|
|
2
2
|
import { componentType, instanceContainer } from './constants';
|
|
3
|
+
import { PopoutGeometry } from './popout-events';
|
|
3
4
|
/**
|
|
4
5
|
* Definition of a custom button which will be added to all layout items.
|
|
5
6
|
* @remarks
|
|
@@ -25,6 +26,20 @@ export type CustomButton = {
|
|
|
25
26
|
export type SerialisedLayout = {
|
|
26
27
|
v: '1';
|
|
27
28
|
c: ResolvedLayoutConfig;
|
|
29
|
+
/**
|
|
30
|
+
* Optional registry of popped out components and their window geometry.
|
|
31
|
+
* @beta
|
|
32
|
+
*/
|
|
33
|
+
popouts?: {
|
|
34
|
+
[layoutKey: string]: PopoutState;
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* @beta
|
|
39
|
+
* State of a popped out window
|
|
40
|
+
*/
|
|
41
|
+
export type PopoutState = {
|
|
42
|
+
geometry: PopoutGeometry;
|
|
28
43
|
};
|
|
29
44
|
/**
|
|
30
45
|
* Interface to implement on an item which is a component of the layout and you wish to serialise state with. This is saved separately for each instance of the component, which allows you to restore multiple instances of the same component with different state.
|
|
@@ -200,4 +215,17 @@ export interface LayoutComponent {
|
|
|
200
215
|
export type AutosavedLayouts = {
|
|
201
216
|
[x: string]: string;
|
|
202
217
|
};
|
|
218
|
+
/** @beta */
|
|
219
|
+
export type LayoutPopoutConfig = {
|
|
220
|
+
/**
|
|
221
|
+
* The name of the broadcast channel to use for communication between the main window and popout windows.
|
|
222
|
+
* Defaults to 'f-layout-popout-channel'.
|
|
223
|
+
*/
|
|
224
|
+
channelName?: string;
|
|
225
|
+
loadAutomatically?: boolean;
|
|
226
|
+
popoutDimension?: {
|
|
227
|
+
width: number;
|
|
228
|
+
height: number;
|
|
229
|
+
};
|
|
230
|
+
};
|
|
203
231
|
//# sourceMappingURL=types.d.ts.map
|