@genesislcap/foundation-layout 14.207.3 → 14.208.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (2) hide show
  1. package/dist/custom-elements.json +1044 -1044
  2. package/package.json +12 -12
package/dist/custom-elements.json CHANGED
@@ -145,47 +145,87 @@
145
145
  },
146
146
  {
147
147
  "kind": "javascript-module",
148
- "path": "src/main/index.ts",
149
- "declarations": [],
148
+ "path": "src/styles/constants.ts",
149
+ "declarations": [
150
+ {
151
+ "kind": "variable",
152
+ "name": "glVisualConfig",
153
+ "type": {
154
+ "text": "Omit<LayoutConfig, 'root'>"
155
+ },
156
+ "default": "{\n dimensions: {\n headerHeight: 38,\n borderWidth: 12,\n },\n header: {\n maximise: 'maximise',\n minimise: 'minimise',\n popout: false,\n },\n}"
157
+ },
158
+ {
159
+ "kind": "variable",
160
+ "name": "LAYOUT_ICONS",
161
+ "type": {
162
+ "text": "{\n renameSVG,\n maximiseSVG,\n minimiseSVG,\n closeSVG,\n tabDropdownSVG,\n popoutSVG,\n}"
163
+ },
164
+ "default": "{\n renameSVG,\n maximiseSVG,\n minimiseSVG,\n closeSVG,\n tabDropdownSVG,\n popoutSVG,\n}",
165
+ "description": "A collection of SVG icons in base64 format.",
166
+ "privacy": "public"
167
+ }
168
+ ],
150
169
  "exports": [
151
170
  {
152
171
  "kind": "js",
153
- "name": "FoundationLayoutItem",
172
+ "name": "glVisualConfig",
154
173
  "declaration": {
155
- "name": "FoundationLayoutItem",
156
- "module": "./layout-item"
174
+ "name": "glVisualConfig",
175
+ "module": "src/styles/constants.ts"
157
176
  }
158
177
  },
159
178
  {
160
179
  "kind": "js",
161
- "name": "FoundationLayoutRegion",
180
+ "name": "LAYOUT_ICONS",
162
181
  "declaration": {
163
- "name": "FoundationLayoutRegion",
164
- "module": "./layout-region"
182
+ "name": "LAYOUT_ICONS",
183
+ "module": "src/styles/constants.ts"
165
184
  }
166
- },
185
+ }
186
+ ]
187
+ },
188
+ {
189
+ "kind": "javascript-module",
190
+ "path": "src/styles/dragging.styles.ts",
191
+ "declarations": [
192
+ {
193
+ "kind": "variable",
194
+ "name": "globalDraggingStyles",
195
+ "default": "`\n .lm_dragProxy .lm_content {\n box-shadow: 2px 2px 4px rgba(0, 0, 0, 0.9);\n }\n .lm_dropTargetIndicator {\n box-shadow: inset 0 0 30px #000000;\n outline: 1px dashed #cccccc;\n transition: all 200ms ease;\n }\n .lm_dropTargetIndicator .lm_inner {\n background: var(${neutralFillStealthRest.cssCustomProperty});\n opacity: 0.2;\n }\n .lm_dragProxy.lm_left .lm_header,\n .lm_dragProxy.lm_right .lm_header {\n width: 20px;\n float: left;\n vertical-align: top;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs,\n .lm_dragProxy.lm_right .lm_header .lm_tabs {\n transform-origin: left top;\n top: 0;\n width: 1000px;\n }\n .lm_dragProxy.lm_left .lm_header .lm_controls,\n .lm_dragProxy.lm_right .lm_header .lm_controls {\n bottom: 0;\n }\n .lm_dragProxy.lm_left .lm_items,\n .lm_dragProxy.lm_right .lm_items {\n float: left;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs {\n transform: rotate(-90deg) scaleX(-1);\n left: 0;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs .lm_tab {\n transform: scaleX(-1);\n margin-top: 1px;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabdropdown_list {\n top: initial;\n right: initial;\n left: 20px;\n }\n .lm_dragProxy.lm_right .lm_content {\n float: left;\n }\n .lm_dragProxy.lm_right .lm_header .lm_tabs {\n transform: rotate(90deg) scaleX(1);\n left: 100%;\n margin-left: 0;\n }\n .lm_dragProxy.lm_right .lm_header .lm_controls {\n left: 3px;\n }\n .lm_dragProxy.lm_right .lm_header .lm_tabdropdown_list {\n top: initial;\n right: 20px;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_tab {\n margin-top: 0;\n border-top: none;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_controls,\n .lm_stack.lm_bottom .lm_header .lm_controls {\n top: 3px;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_tabdropdown_list,\n .lm_stack.lm_bottom .lm_header .lm_tabdropdown_list {\n top: initial;\n bottom: 20px;\n }\n .lm_dragProxy {\n cursor: move;\n position: absolute;\n top: 0;\n left: 0;\n z-index: 30;\n }\n .lm_dragProxy .lm_header {\n background: transparent;\n }\n .lm_dragProxy .lm_title {\n color: white;\n padding-left: 10px;\n }\n .lm_dragProxy .lm_content {\n border-top: none;\n overflow: hidden;\n }\n .lm_dropTargetIndicator {\n display: none;\n position: absolute;\n z-index: 20;\n }\n .lm_dropTargetIndicator .lm_inner {\n width: 100%;\n height: 100%;\n position: relative;\n top: 0;\n left: 0;\n }\n .lm_transition_indicator {\n display: none;\n width: 20px;\n height: 20px;\n position: absolute;\n top: 0;\n left: 0;\n z-index: 20;\n }\n`",
196
+ "description": "This is defined as a string rather than a css template\nbecause it is applied to a CSSStyleSheet object rather than\nused as a FAST template"
197
+ }
198
+ ],
199
+ "exports": [
167
200
  {
168
201
  "kind": "js",
169
- "name": "FoundationLayout",
202
+ "name": "globalDraggingStyles",
170
203
  "declaration": {
171
- "name": "FoundationLayout",
172
- "module": "./layout-main"
204
+ "name": "globalDraggingStyles",
205
+ "module": "src/styles/dragging.styles.ts"
173
206
  }
174
- },
207
+ }
208
+ ]
209
+ },
210
+ {
211
+ "kind": "javascript-module",
212
+ "path": "src/styles/index.ts",
213
+ "declarations": [],
214
+ "exports": [
175
215
  {
176
216
  "kind": "js",
177
- "name": "layoutStyles",
217
+ "name": "*",
178
218
  "declaration": {
179
- "name": "layoutStyles",
180
- "module": "./layout-main"
219
+ "name": "*",
220
+ "package": "./constants"
181
221
  }
182
222
  },
183
223
  {
184
224
  "kind": "js",
185
- "name": "layoutTemplate",
225
+ "name": "*",
186
226
  "declaration": {
187
- "name": "layoutTemplate",
188
- "module": "./layout-main"
227
+ "name": "*",
228
+ "package": "./dragging.styles"
189
229
  }
190
230
  },
191
231
  {
@@ -193,892 +233,966 @@
193
233
  "name": "*",
194
234
  "declaration": {
195
235
  "name": "*",
196
- "package": "./layout-components"
236
+ "package": "./layout.styles"
197
237
  }
198
238
  }
199
239
  ]
200
240
  },
201
241
  {
202
242
  "kind": "javascript-module",
203
- "path": "src/main/layout-components.ts",
243
+ "path": "src/styles/layout.styles.ts",
204
244
  "declarations": [
205
245
  {
206
246
  "kind": "variable",
207
- "name": "foundationLayoutComponents",
247
+ "name": "layoutStyles",
248
+ "default": "css`\n ${containerStyles}\n ${loadingSpinnerStyles}\n\n .lm_goldenlayout {\n padding: 1px;\n background: ${neutralLayer1};\n border-radius: calc(${controlCornerRadius} * 1.5px);\n }\n\n .lm_stack.lm_item {\n background-color: ${neutralLayer4};\n border-radius: calc(${controlCornerRadius} * 1.5px);\n }\n .lm_maximised .lm_header {\n background-color: ${neutralLayer4};\n border-radius: calc(${controlCornerRadius} * 1.5px);\n position: unset;\n }\n\n .lm_maximised .lm_header .lm_tabs {\n z-index: 3;\n }\n\n .lm_content {\n background-color: ${neutralLayer3};\n border-radius: calc(${controlCornerRadius} * 1.5px);\n border: 1px solid;\n border-color: #2e3339;\n box-sizing: border-box;\n }\n\n .lm-header {\n z-index: 1;\n }\n .lm_header .lm_tabs {\n padding: 0 16px;\n }\n\n .lm_stack > .lm_items {\n z-index: 2;\n box-shadow: 0px -1px 15px rgba(0, 0, 0, 0.35);\n }\n\n .lm_header .lm_tab.lm_active.lm_focused {\n background-color: ${neutralLayer3};\n }\n .lm_header .lm_tab.lm_active {\n background-color: ${neutralLayer3};\n border: 1px solid;\n border-color: #2e3339;\n border-bottom: 0;\n color: ${accentFillRest};\n }\n\n .lm_header .lm_tab {\n align-items: center;\n background-color: ${neutralLayer4};\n border: 1px solid;\n border-bottom-color: #2e3339;\n border-bottom: 0px solid;\n border-color: rgba(0, 0, 0, 0.35);\n border-radius: calc(${controlCornerRadius} * 1.5px) calc(${controlCornerRadius} * 1.5px) 0 0;\n box-shadow: 1px -1px 2px rgba(0, 0, 0, 0.35);\n color: rgba(255, 255, 255, 0.3);\n display: flex;\n font-family: inherit;\n font-size: 13px;\n font-weight: 700;\n height: 30px;\n margin-right: 2px;\n margin-top: 3px;\n padding: 2px 16px;\n }\n\n .lm_header .lm_tab:not(.lm_active):hover {\n background-color: rgba(255, 255, 255, 0.1);\n color: #f1f1f1;\n }\n\n .lm_header .lm_controls {\n top: 4px;\n display: flex;\n }\n .lm_header .lm_controls > * {\n width: 30px;\n height: 30px;\n background-repeat: no-repeat;\n background-position: center;\n background-size: 16px;\n background-color: rgba(255, 255, 255, 0.03);\n border-radius: calc(${controlCornerRadius} * 1.5px);\n margin-right: 4px;\n top: 3px;\n opacity: 1;\n }\n .lm_header .lm_controls > *:hover {\n background-color: rgba(255, 255, 255, 0.1);\n cursor: pointer;\n }\n\n .lm_controls .lm_maximise {\n background-image: url('${LAYOUT_ICONS.maximiseSVG}');\n }\n .lm_maximised .lm_controls .lm_maximise {\n background-image: url('${LAYOUT_ICONS.minimiseSVG}');\n }\n .lm_controls .lm_close {\n background-image: url('${LAYOUT_ICONS.closeSVG}');\n }\n .lm_header .lm_tab .lm_close_tab {\n background-image: url('${LAYOUT_ICONS.closeSVG}');\n background-size: 10px;\n background-repeat: no-repeat;\n margin-left: 12px;\n position: relative;\n top: 0;\n right: 0;\n }\n\n .lm_header .lm_tab.lm_active {\n padding: 4px 25px 3px 10px;\n }\n\n .lm_header .lm_tab:not(.lm_active) .lm_title {\n color: ${accentFillRest};\n opacity: 0.7;\n }\n\n .lm_header .lm_controls .lm_tabdropdown::before {\n content: none;\n }\n .lm_header .lm_controls .lm_tabdropdown {\n background-image: url('${LAYOUT_ICONS.tabDropdownSVG}');\n }\n .lm_header .lm_tabdropdown_list {\n top: 38px;\n right: 108px;\n background-color: ${neutralLayer3};\n border: 1px solid;\n border-color: #2e3339;\n border-radius: calc(${controlCornerRadius} * 1.5px);\n box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.35);\n }\n .lm_header .lm_tabdropdown_list > .lm_tab {\n box-shadow: none;\n padding: 0 16px;\n white-space: nowrap;\n background-color: transparent;\n color: #c9c9c9;\n height: 36px;\n border-radius: 0;\n overflow: visible;\n text-overflow: normal;\n }\n .lm_header .lm_tabdropdown_list > .lm_tab:last-child {\n border-bottom: 0;\n }\n\n /* gl base styles start */\n .lm_root {\n position: relative;\n }\n .lm_row > .lm_item {\n float: left;\n }\n .lm_content {\n overflow: hidden;\n position: relative;\n }\n .lm_dragging,\n .lm_dragging * {\n cursor: move !important;\n user-select: none;\n }\n .lm_maximised {\n left: 0;\n padding: 1px;\n position: absolute;\n top: 0;\n z-index: 40;\n }\n .lm_maximise_placeholder {\n display: none;\n }\n .lm_splitter {\n position: relative;\n z-index: 20;\n }\n .lm_splitter:hover,\n .lm_splitter.lm_dragging {\n background: ${accentFillRest};\n border-radius: calc(${controlCornerRadius} * 4px);\n }\n .lm_splitter.lm_vertical .lm_drag_handle {\n width: 100%;\n height: 15px;\n position: absolute;\n top: -5px;\n cursor: ns-resize !important;\n }\n .lm_splitter.lm_horizontal {\n float: left;\n height: 100%;\n }\n .lm_splitter.lm_horizontal .lm_drag_handle {\n width: 15px;\n height: 100%;\n position: absolute;\n left: -5px;\n cursor: ew-resize !important;\n }\n .lm_header {\n overflow: visible;\n position: relative;\n z-index: 1;\n }\n .lm_header [class^='lm_'] {\n box-sizing: content-box !important;\n }\n .lm_header .lm_controls {\n position: absolute;\n right: 3px;\n }\n .lm_header .lm_controls > li {\n cursor: pointer;\n float: left;\n width: 18px;\n height: 18px;\n text-align: center;\n }\n .lm_header ul {\n margin: 0;\n padding: 0;\n list-style-type: none;\n }\n .lm_header .lm_tabs {\n position: absolute;\n }\n .lm_header .lm_tab {\n cursor: pointer;\n float: left;\n margin-top: 1px;\n padding: 3px 25px 3px 10px;\n position: relative;\n }\n .lm_header .lm_tab i {\n width: 2px;\n height: 19px;\n position: absolute;\n }\n .lm_header .lm_tab i.lm_left {\n top: 0;\n left: -2px;\n }\n .lm_header .lm_tab i.lm_right {\n top: 0;\n right: -2px;\n }\n .lm_header .lm_tab .lm_title {\n display: inline-block;\n overflow: hidden;\n text-overflow: ellipsis;\n user-select: none;\n }\n .lm_header .lm_tab .lm_title:only-child {\n padding-left: 10px;\n }\n .lm_header .lm_tab .lm_close_tab {\n width: 14px;\n height: 14px;\n position: absolute;\n top: 11px;\n right: 0;\n text-align: center;\n }\n .lm_stack.lm_left .lm_header,\n .lm_stack.lm_right .lm_header {\n height: 100%;\n }\n .lm_dragProxy.lm_left .lm_header,\n .lm_dragProxy.lm_right .lm_header,\n .lm_stack.lm_left .lm_header,\n .lm_stack.lm_right .lm_header {\n width: 20px;\n float: left;\n vertical-align: top;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs,\n .lm_dragProxy.lm_right .lm_header .lm_tabs,\n .lm_stack.lm_left .lm_header .lm_tabs,\n .lm_stack.lm_right .lm_header .lm_tabs {\n transform-origin: left top;\n top: 0;\n width: 1000px;\n }\n .lm_dragProxy.lm_left .lm_header .lm_controls,\n .lm_dragProxy.lm_right .lm_header .lm_controls,\n .lm_stack.lm_left .lm_header .lm_controls,\n .lm_stack.lm_right .lm_header .lm_controls {\n bottom: 0;\n }\n .lm_dragProxy.lm_left .lm_items,\n .lm_dragProxy.lm_right .lm_items,\n .lm_stack.lm_left .lm_items,\n .lm_stack.lm_right .lm_items {\n float: left;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs,\n .lm_stack.lm_left .lm_header .lm_tabs {\n transform: rotate(-90deg) scaleX(-1);\n left: 0;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs .lm_tab,\n .lm_stack.lm_left .lm_header .lm_tabs .lm_tab {\n transform: scaleX(-1);\n margin-top: 1px;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabdropdown_list,\n .lm_stack.lm_left .lm_header .lm_tabdropdown_list {\n top: initial;\n right: initial;\n left: 20px;\n }\n .lm_dragProxy.lm_right .lm_content {\n float: left;\n }\n .lm_dragProxy.lm_right .lm_header .lm_tabs,\n .lm_stack.lm_right .lm_header .lm_tabs {\n transform: rotate(90deg) scaleX(1);\n left: 100%;\n margin-left: 0;\n }\n .lm_dragProxy.lm_right .lm_header .lm_controls,\n .lm_stack.lm_right .lm_header .lm_controls {\n left: 3px;\n }\n .lm_dragProxy.lm_right .lm_header .lm_tabdropdown_list,\n .lm_stack.lm_right .lm_header .lm_tabdropdown_list {\n top: initial;\n right: 20px;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_tab,\n .lm_stack.lm_bottom .lm_header .lm_tab {\n margin-top: 0;\n border-top: none;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_controls,\n .lm_stack.lm_bottom .lm_header .lm_controls {\n top: 3px;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_tabdropdown_list,\n .lm_stack.lm_bottom .lm_header .lm_tabdropdown_list {\n top: initial;\n bottom: 20px;\n }\n .lm_drop_tab_placeholder {\n float: left;\n width: 100px;\n height: 10px;\n visibility: hidden;\n }\n .lm_header .lm_tabdropdown_list {\n position: absolute;\n top: 20px;\n right: 0;\n z-index: 5;\n overflow: hidden;\n }\n .lm_header .lm_tabdropdown_list .lm_tab {\n clear: both;\n padding-right: 10px;\n margin: 0;\n }\n .lm_header .lm_tabdropdown_list .lm_tab .lm_title {\n width: 100px;\n }\n .lm_header .lm_tabdropdown_list .lm_close_tab {\n display: none !important;\n }\n .lm_dragProxy {\n position: absolute;\n top: 0;\n left: 0;\n z-index: 30;\n }\n .lm_dragProxy .lm_header {\n background: transparent;\n }\n .lm_dragProxy .lm_content {\n border-top: none;\n overflow: hidden;\n }\n .lm_dropTargetIndicator {\n display: none;\n position: absolute;\n z-index: 20;\n }\n .lm_dropTargetIndicator .lm_inner {\n width: 100%;\n height: 100%;\n position: relative;\n top: 0;\n left: 0;\n }\n .lm_transition_indicator {\n display: none;\n width: 20px;\n height: 20px;\n position: absolute;\n top: 0;\n left: 0;\n z-index: 20;\n }\n .lm_popin {\n width: 20px;\n height: 20px;\n position: absolute;\n bottom: 0;\n right: 0;\n z-index: 9999;\n }\n .lm_popin > * {\n width: 100%;\n height: 100%;\n position: absolute;\n top: 0;\n left: 0;\n }\n .lm_popin > .lm_bg {\n z-index: 10;\n }\n .lm_popin > .lm_icon {\n z-index: 20;\n } /*# sourceMappingURL=goldenlayout-base.css.map */\n`",
249
+ "description": "`ElementStyles` which defines the css for FoundationLayout.",
250
+ "privacy": "public"
251
+ }
252
+ ],
253
+ "exports": [
254
+ {
255
+ "kind": "js",
256
+ "name": "layoutStyles",
257
+ "declaration": {
258
+ "name": "layoutStyles",
259
+ "module": "src/styles/layout.styles.ts"
260
+ }
261
+ }
262
+ ]
263
+ },
264
+ {
265
+ "kind": "javascript-module",
266
+ "path": "src/utils/constants.ts",
267
+ "declarations": [
268
+ {
269
+ "kind": "variable",
270
+ "name": "DEFAULT_RELOAD_BUFFER",
208
271
  "type": {
209
- "text": "object"
272
+ "text": "number"
210
273
  },
211
- "default": "{\n foundationLayout,\n foundationLayoutRegion,\n foundationLayoutItem,\n register(container?: Container, ...rest: any[]) {\n if (!container) {\n // preserve backward compatibility with code that loops through\n // the values of this object and calls them as funcs with no args\n return;\n }\n for (const key in this) {\n if (key === 'register') {\n continue;\n }\n this[key]().register(container, ...rest);\n }\n },\n}",
212
- "description": "Registration object to register the layout with your design system.",
274
+ "default": "500",
275
+ "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.",
213
276
  "privacy": "public"
277
+ },
278
+ {
279
+ "kind": "variable",
280
+ "name": "LAYOUT_POPOUT_CONTAINER_CLASS",
281
+ "type": {
282
+ "text": "string"
283
+ },
284
+ "default": "'f-layout-popout'",
285
+ "description": "Put this classname on an element which is a DOM parent of the layout, and\nif the layout goes into popout mode then it will place itself as the only child\nfor the popout container you set."
214
286
  }
215
287
  ],
216
288
  "exports": [
217
289
  {
218
290
  "kind": "js",
219
- "name": "foundationLayoutComponents",
291
+ "name": "DEFAULT_RELOAD_BUFFER",
220
292
  "declaration": {
221
- "name": "foundationLayoutComponents",
222
- "module": "src/main/layout-components.ts"
293
+ "name": "DEFAULT_RELOAD_BUFFER",
294
+ "module": "src/utils/constants.ts"
295
+ }
296
+ },
297
+ {
298
+ "kind": "js",
299
+ "name": "LAYOUT_POPOUT_CONTAINER_CLASS",
300
+ "declaration": {
301
+ "name": "LAYOUT_POPOUT_CONTAINER_CLASS",
302
+ "module": "src/utils/constants.ts"
223
303
  }
224
304
  }
225
305
  ]
226
306
  },
227
307
  {
228
308
  "kind": "javascript-module",
229
- "path": "src/main/layout-item.ts",
309
+ "path": "src/utils/error.ts",
230
310
  "declarations": [
231
311
  {
232
312
  "kind": "class",
233
313
  "description": "",
234
- "name": "FoundationLayoutItem",
235
- "members": [
236
- {
237
- "kind": "field",
238
- "name": "title",
239
- "type": {
240
- "text": "string"
241
- },
242
- "description": "Sets the title of the item which is displayed on the tab.",
243
- "privacy": "public"
244
- },
245
- {
246
- "kind": "field",
247
- "name": "closable",
248
- "type": {
249
- "text": "boolean"
250
- },
251
- "default": "false",
252
- "description": "Boolean attribute controls whether the window can be closed in the GUI.\nDefaults to `false`.",
253
- "privacy": "public"
254
- },
255
- {
256
- "kind": "field",
257
- "name": "size",
258
- "type": {
259
- "text": "string"
260
- },
261
- "description": "optional string describing the size of the new item (see the written documentation for more info)",
262
- "privacy": "public"
263
- },
264
- {
265
- "kind": "field",
266
- "name": "registration",
267
- "type": {
268
- "text": "string"
269
- },
270
- "description": "Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem.",
271
- "privacy": "public"
272
- },
273
- {
274
- "kind": "field",
275
- "name": "_presentation",
276
- "type": {
277
- "text": "ComponentPresentation | null | undefined"
278
- },
279
- "privacy": "private",
280
- "default": "void 0",
281
- "inheritedFrom": {
282
- "name": "FoundationElement",
283
- "module": "src/foundation-element/foundation-element.ts"
284
- }
285
- },
286
- {
287
- "kind": "field",
288
- "name": "$presentation",
289
- "type": {
290
- "text": "ComponentPresentation | null"
291
- },
292
- "privacy": "public",
293
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
294
- "inheritedFrom": {
295
- "name": "FoundationElement",
296
- "module": "src/foundation-element/foundation-element.ts"
297
- }
298
- },
299
- {
300
- "kind": "field",
301
- "name": "template",
302
- "type": {
303
- "text": "ElementViewTemplate | void | null"
304
- },
305
- "privacy": "public",
306
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
307
- "inheritedFrom": {
308
- "name": "FoundationElement",
309
- "module": "src/foundation-element/foundation-element.ts"
310
- }
311
- },
312
- {
313
- "kind": "method",
314
- "name": "templateChanged",
315
- "privacy": "protected",
316
- "return": {
317
- "type": {
318
- "text": "void"
319
- }
320
- },
321
- "inheritedFrom": {
322
- "name": "FoundationElement",
323
- "module": "src/foundation-element/foundation-element.ts"
324
- }
325
- },
326
- {
327
- "kind": "field",
328
- "name": "styles",
329
- "type": {
330
- "text": "ElementStyles | void | null"
331
- },
332
- "privacy": "public",
333
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
334
- "inheritedFrom": {
335
- "name": "FoundationElement",
336
- "module": "src/foundation-element/foundation-element.ts"
337
- }
338
- },
339
- {
340
- "kind": "method",
341
- "name": "stylesChanged",
342
- "privacy": "protected",
343
- "return": {
344
- "type": {
345
- "text": "void"
346
- }
347
- },
348
- "inheritedFrom": {
349
- "name": "FoundationElement",
350
- "module": "src/foundation-element/foundation-element.ts"
351
- }
352
- },
353
- {
354
- "kind": "method",
355
- "name": "compose",
356
- "privacy": "public",
357
- "static": true,
358
- "return": {
359
- "type": {
360
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
361
- }
362
- },
363
- "parameters": [
364
- {
365
- "name": "this",
366
- "type": {
367
- "text": "K"
368
- }
369
- },
370
- {
371
- "name": "elementDefinition",
372
- "type": {
373
- "text": "T"
374
- },
375
- "description": "The definition of the element to create the registry\nfunction for."
376
- }
377
- ],
378
- "description": "Defines an element registry function with a set of element definition defaults.",
379
- "inheritedFrom": {
380
- "name": "FoundationElement",
381
- "module": "src/foundation-element/foundation-element.ts"
382
- }
383
- }
384
- ],
385
- "attributes": [
386
- {
387
- "name": "title",
388
- "type": {
389
- "text": "string"
390
- },
391
- "description": "Sets the title of the item which is displayed on the tab.",
392
- "fieldName": "title"
393
- },
394
- {
395
- "type": {
396
- "text": "boolean"
397
- },
398
- "default": "false",
399
- "description": "Boolean attribute controls whether the window can be closed in the GUI.\nDefaults to `false`.",
400
- "fieldName": "closable"
401
- },
402
- {
403
- "name": "size",
404
- "type": {
405
- "text": "string"
406
- },
407
- "description": "optional string describing the size of the new item (see the written documentation for more info)",
408
- "fieldName": "size"
409
- },
410
- {
411
- "name": "registration",
412
- "type": {
413
- "text": "string"
414
- },
415
- "description": "Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem.",
416
- "fieldName": "registration"
417
- }
418
- ],
314
+ "name": "LayoutUsageError",
419
315
  "superclass": {
420
- "name": "FoundationElement",
421
- "package": "@microsoft/fast-foundation"
316
+ "name": "Error",
317
+ "module": "src/utils/error.ts"
318
+ }
319
+ },
320
+ {
321
+ "kind": "class",
322
+ "description": "",
323
+ "name": "LayoutRegistrationError",
324
+ "superclass": {
325
+ "name": "Error",
326
+ "module": "src/utils/error.ts"
327
+ }
328
+ }
329
+ ],
330
+ "exports": [
331
+ {
332
+ "kind": "js",
333
+ "name": "LayoutUsageError",
334
+ "declaration": {
335
+ "name": "LayoutUsageError",
336
+ "module": "src/utils/error.ts"
337
+ }
338
+ },
339
+ {
340
+ "kind": "js",
341
+ "name": "LayoutRegistrationError",
342
+ "declaration": {
343
+ "name": "LayoutRegistrationError",
344
+ "module": "src/utils/error.ts"
345
+ }
346
+ }
347
+ ]
348
+ },
349
+ {
350
+ "kind": "javascript-module",
351
+ "path": "src/utils/events.ts",
352
+ "declarations": [
353
+ {
354
+ "kind": "variable",
355
+ "name": "LayoutEmitEvents",
356
+ "type": {
357
+ "text": "{\n firstLoaded: 'first-loaded',\n itemAdded: 'item-added',\n itemRemoved: 'item-removed',\n itemResized: 'item-resized',\n}"
422
358
  },
423
- "tagName": "%%prefix%%-layout-item",
424
- "customElement": true
359
+ "default": "{\n firstLoaded: 'first-loaded',\n itemAdded: 'item-added',\n itemRemoved: 'item-removed',\n itemResized: 'item-resized',\n}",
360
+ "description": "Defines events that the layout system emits\n\n'firstLoaded' - emitted when the layout has finished loading the first time\nusing the declarative API after DEFAULT_RELOAD_BUFFER ms.\n<br/>\n'itemAdded' - emitted when an item is added to the layout'\n<br/>\n'itemRemoved' - emitted when an item is removed from the layout'\n<br/>\n'itemResized' - emitted when the user drags the divider to resize elements",
361
+ "privacy": "public"
362
+ },
363
+ {
364
+ "kind": "variable",
365
+ "name": "LayoutReceiveEvents",
366
+ "type": {
367
+ "text": "{\n changeTitle: 'change-title',\n autosave: 'autosave',\n}"
368
+ },
369
+ "default": "{\n changeTitle: 'change-title',\n autosave: 'autosave',\n}",
370
+ "description": "Defines events that the layout system listens for\n\n'changeTitle' - emit this from a contained item to update the title of the window that contains it.\n'autosave' - emit this from a contained item to hint to the layout system that it should autosave the layout. A contained item should do this if it has just changed some state it would like to persist. See LayoutComponentWithState.",
371
+ "privacy": "public"
425
372
  }
426
373
  ],
427
374
  "exports": [
428
375
  {
429
376
  "kind": "js",
430
- "name": "FoundationLayoutItem",
377
+ "name": "LayoutEmitEvents",
431
378
  "declaration": {
432
- "name": "FoundationLayoutItem",
433
- "module": "src/main/layout-item.ts"
379
+ "name": "LayoutEmitEvents",
380
+ "module": "src/utils/events.ts"
381
+ }
382
+ },
383
+ {
384
+ "kind": "js",
385
+ "name": "LayoutReceiveEvents",
386
+ "declaration": {
387
+ "name": "LayoutReceiveEvents",
388
+ "module": "src/utils/events.ts"
434
389
  }
435
390
  }
436
391
  ]
437
392
  },
438
393
  {
439
394
  "kind": "javascript-module",
440
- "path": "src/main/layout-main.ts",
395
+ "path": "src/utils/index.ts",
396
+ "declarations": [],
397
+ "exports": [
398
+ {
399
+ "kind": "js",
400
+ "name": "*",
401
+ "declaration": {
402
+ "name": "*",
403
+ "package": "./constants"
404
+ }
405
+ },
406
+ {
407
+ "kind": "js",
408
+ "name": "*",
409
+ "declaration": {
410
+ "name": "*",
411
+ "package": "./error"
412
+ }
413
+ },
414
+ {
415
+ "kind": "js",
416
+ "name": "*",
417
+ "declaration": {
418
+ "name": "*",
419
+ "package": "./events"
420
+ }
421
+ },
422
+ {
423
+ "kind": "js",
424
+ "name": "*",
425
+ "declaration": {
426
+ "name": "*",
427
+ "package": "./misc"
428
+ }
429
+ },
430
+ {
431
+ "kind": "js",
432
+ "name": "*",
433
+ "declaration": {
434
+ "name": "*",
435
+ "package": "./templates"
436
+ }
437
+ },
438
+ {
439
+ "kind": "js",
440
+ "name": "*",
441
+ "declaration": {
442
+ "name": "*",
443
+ "package": "./types"
444
+ }
445
+ },
446
+ {
447
+ "kind": "js",
448
+ "name": "*",
449
+ "declaration": {
450
+ "name": "*",
451
+ "package": "./error"
452
+ }
453
+ }
454
+ ]
455
+ },
456
+ {
457
+ "kind": "javascript-module",
458
+ "path": "src/utils/logger.ts",
441
459
  "declarations": [
442
460
  {
443
- "kind": "class",
444
- "description": "",
445
- "name": "FoundationLayout",
446
- "members": [
447
- {
448
- "kind": "field",
449
- "name": "layout",
450
- "type": {
451
- "text": "GoldenLayout"
452
- },
453
- "privacy": "private"
454
- },
455
- {
456
- "kind": "field",
457
- "name": "layoutConfig",
458
- "type": {
459
- "text": "LayoutConfig"
460
- },
461
- "privacy": "private",
462
- "default": "{ root: undefined }"
463
- },
464
- {
465
- "kind": "field",
466
- "name": "reloadBuffer",
467
- "type": {
468
- "text": "number"
469
- },
470
- "default": "DEFAULT_RELOAD_BUFFER",
471
- "description": "Number describing how long to wait in ms before reloading the config when adding items\ndeclaratively by the html API. Default 500 (ms).",
472
- "privacy": "public"
473
- },
474
- {
475
- "kind": "field",
476
- "name": "reloadPending",
477
- "type": {
478
- "text": "boolean"
479
- },
480
- "privacy": "private",
481
- "default": "false"
482
- },
483
- {
484
- "kind": "field",
485
- "name": "registeredComponents",
486
- "type": {
487
- "text": "number"
488
- },
489
- "privacy": "private",
490
- "default": "0"
491
- },
492
- {
493
- "kind": "field",
494
- "name": "autoSaveKey",
495
- "type": {
496
- "text": "string | undefined"
497
- },
498
- "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`.",
499
- "privacy": "public"
500
- },
501
- {
502
- "kind": "field",
503
- "name": "missingItemPlaceholder",
504
- "description": "Function which is used to generate the placeholder text when a layout is loaded\nwith a missing item.",
505
- "privacy": "public"
506
- },
461
+ "kind": "variable",
462
+ "name": "logger"
463
+ }
464
+ ],
465
+ "exports": [
466
+ {
467
+ "kind": "js",
468
+ "name": "logger",
469
+ "declaration": {
470
+ "name": "logger",
471
+ "module": "src/utils/logger.ts"
472
+ }
473
+ }
474
+ ]
475
+ },
476
+ {
477
+ "kind": "javascript-module",
478
+ "path": "src/utils/misc.ts",
479
+ "declarations": [],
480
+ "exports": []
481
+ },
482
+ {
483
+ "kind": "javascript-module",
484
+ "path": "src/utils/templates.ts",
485
+ "declarations": [],
486
+ "exports": []
487
+ },
488
+ {
489
+ "kind": "javascript-module",
490
+ "path": "src/utils/types.ts",
491
+ "declarations": [],
492
+ "exports": []
493
+ },
494
+ {
495
+ "kind": "javascript-module",
496
+ "path": "src/main/index.ts",
497
+ "declarations": [],
498
+ "exports": [
499
+ {
500
+ "kind": "js",
501
+ "name": "FoundationLayoutItem",
502
+ "declaration": {
503
+ "name": "FoundationLayoutItem",
504
+ "module": "./layout-item"
505
+ }
506
+ },
507
+ {
508
+ "kind": "js",
509
+ "name": "FoundationLayoutRegion",
510
+ "declaration": {
511
+ "name": "FoundationLayoutRegion",
512
+ "module": "./layout-region"
513
+ }
514
+ },
515
+ {
516
+ "kind": "js",
517
+ "name": "FoundationLayout",
518
+ "declaration": {
519
+ "name": "FoundationLayout",
520
+ "module": "./layout-main"
521
+ }
522
+ },
523
+ {
524
+ "kind": "js",
525
+ "name": "layoutStyles",
526
+ "declaration": {
527
+ "name": "layoutStyles",
528
+ "module": "./layout-main"
529
+ }
530
+ },
531
+ {
532
+ "kind": "js",
533
+ "name": "layoutTemplate",
534
+ "declaration": {
535
+ "name": "layoutTemplate",
536
+ "module": "./layout-main"
537
+ }
538
+ },
539
+ {
540
+ "kind": "js",
541
+ "name": "*",
542
+ "declaration": {
543
+ "name": "*",
544
+ "package": "./layout-components"
545
+ }
546
+ }
547
+ ]
548
+ },
549
+ {
550
+ "kind": "javascript-module",
551
+ "path": "src/main/layout-components.ts",
552
+ "declarations": [
553
+ {
554
+ "kind": "variable",
555
+ "name": "foundationLayoutComponents",
556
+ "type": {
557
+ "text": "object"
558
+ },
559
+ "default": "{\n foundationLayout,\n foundationLayoutRegion,\n foundationLayoutItem,\n register(container?: Container, ...rest: any[]) {\n if (!container) {\n // preserve backward compatibility with code that loops through\n // the values of this object and calls them as funcs with no args\n return;\n }\n for (const key in this) {\n if (key === 'register') {\n continue;\n }\n this[key]().register(container, ...rest);\n }\n },\n}",
560
+ "description": "Registration object to register the layout with your design system.",
561
+ "privacy": "public"
562
+ }
563
+ ],
564
+ "exports": [
565
+ {
566
+ "kind": "js",
567
+ "name": "foundationLayoutComponents",
568
+ "declaration": {
569
+ "name": "foundationLayoutComponents",
570
+ "module": "src/main/layout-components.ts"
571
+ }
572
+ }
573
+ ]
574
+ },
575
+ {
576
+ "kind": "javascript-module",
577
+ "path": "src/main/layout-item.ts",
578
+ "declarations": [
579
+ {
580
+ "kind": "class",
581
+ "description": "",
582
+ "name": "FoundationLayoutItem",
583
+ "members": [
507
584
  {
508
585
  "kind": "field",
509
- "name": "dimensionsConfig",
586
+ "name": "title",
510
587
  "type": {
511
- "text": "LayoutConfig.Dimensions | undefined"
588
+ "text": "string"
512
589
  },
513
- "description": "Apply dimensions config to the layout, such as setting the size of the drag handles.",
590
+ "description": "Sets the title of the item which is displayed on the tab.",
514
591
  "privacy": "public"
515
592
  },
516
593
  {
517
594
  "kind": "field",
518
- "name": "hasFirstLoaded",
595
+ "name": "closable",
519
596
  "type": {
520
597
  "text": "boolean"
521
598
  },
522
599
  "default": "false",
523
- "description": "Boolean signifies whether the layout has loaded for the first time or not.",
600
+ "description": "Boolean attribute controls whether the window can be closed in the GUI.\nDefaults to `false`.",
524
601
  "privacy": "public"
525
602
  },
526
603
  {
527
604
  "kind": "field",
528
- "name": "customButtons",
605
+ "name": "size",
529
606
  "type": {
530
- "text": "CustomButton[]"
607
+ "text": "string"
531
608
  },
532
- "default": "[]",
533
- "description": "Set custom button definition on this property to add them to the layout header controls",
609
+ "description": "optional string describing the size of the new item (see the written documentation for more info)",
534
610
  "privacy": "public"
535
611
  },
536
612
  {
537
613
  "kind": "field",
538
- "name": "dragging",
614
+ "name": "registration",
539
615
  "type": {
540
- "text": "boolean"
616
+ "text": "string"
541
617
  },
542
- "default": "false",
618
+ "description": "Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem.",
543
619
  "privacy": "public"
544
620
  },
545
621
  {
546
622
  "kind": "field",
547
- "name": "class",
548
- "privacy": "public",
549
- "default": "'FoundationLayoutMain'",
623
+ "name": "_presentation",
550
624
  "type": {
551
- "text": "'FoundationLayoutMain'"
625
+ "text": "ComponentPresentation | null | undefined"
626
+ },
627
+ "privacy": "private",
628
+ "default": "void 0",
629
+ "inheritedFrom": {
630
+ "name": "FoundationElement",
631
+ "module": "src/foundation-element/foundation-element.ts"
552
632
  }
553
633
  },
554
634
  {
555
635
  "kind": "field",
556
- "name": "lifecycleUpdateToken",
636
+ "name": "$presentation",
557
637
  "type": {
558
- "text": "string | undefined"
638
+ "text": "ComponentPresentation | null"
559
639
  },
560
640
  "privacy": "public",
561
- "default": "undefined",
562
- "description": "Used to calculate whether a layout item should run its lifecycle methods or not"
563
- },
564
- {
565
- "kind": "field",
566
- "name": "popoutConfig",
567
- "type": {
568
- "text": "string | undefined"
569
- },
570
- "default": "undefined",
571
- "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."
641
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
642
+ "inheritedFrom": {
643
+ "name": "FoundationElement",
644
+ "module": "src/foundation-element/foundation-element.ts"
645
+ }
572
646
  },
573
647
  {
574
648
  "kind": "field",
575
- "name": "popupMode",
649
+ "name": "template",
576
650
  "type": {
577
- "text": "boolean"
651
+ "text": "ElementViewTemplate | void | null"
578
652
  },
579
- "privacy": "private",
580
- "default": "false"
653
+ "privacy": "public",
654
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
655
+ "inheritedFrom": {
656
+ "name": "FoundationElement",
657
+ "module": "src/foundation-element/foundation-element.ts"
658
+ }
581
659
  },
582
660
  {
583
661
  "kind": "method",
584
- "name": "layoutRequiredRegistrations",
585
- "static": true,
662
+ "name": "templateChanged",
663
+ "privacy": "protected",
586
664
  "return": {
587
665
  "type": {
588
- "text": ""
666
+ "text": "void"
589
667
  }
590
668
  },
591
- "parameters": [
592
- {
593
- "name": "layout",
594
- "type": {
595
- "text": "SerialisedLayout"
596
- },
597
- "description": "any version of {@link SerialisedLayout}object describing the layout\n * "
598
- }
599
- ],
600
- "description": "JS API, public",
601
- "privacy": "public"
669
+ "inheritedFrom": {
670
+ "name": "FoundationElement",
671
+ "module": "src/foundation-element/foundation-element.ts"
672
+ }
602
673
  },
603
674
  {
604
- "kind": "method",
605
- "name": "registeredItems",
606
- "return": {
607
- "type": {
608
- "text": ""
609
- }
675
+ "kind": "field",
676
+ "name": "styles",
677
+ "type": {
678
+ "text": "ElementStyles | void | null"
610
679
  },
611
- "privacy": "public"
680
+ "privacy": "public",
681
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
682
+ "inheritedFrom": {
683
+ "name": "FoundationElement",
684
+ "module": "src/foundation-element/foundation-element.ts"
685
+ }
612
686
  },
613
687
  {
614
688
  "kind": "method",
615
- "name": "getLayout",
689
+ "name": "stylesChanged",
690
+ "privacy": "protected",
616
691
  "return": {
617
692
  "type": {
618
- "text": ""
693
+ "text": "void"
619
694
  }
620
695
  },
621
- "privacy": "public"
696
+ "inheritedFrom": {
697
+ "name": "FoundationElement",
698
+ "module": "src/foundation-element/foundation-element.ts"
699
+ }
622
700
  },
623
701
  {
624
702
  "kind": "method",
625
- "name": "tryActivatePopoutMode",
703
+ "name": "compose",
704
+ "privacy": "public",
705
+ "static": true,
626
706
  "return": {
627
707
  "type": {
628
- "text": "boolean"
629
- }
630
- },
631
- "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."
632
- },
633
- {
634
- "kind": "method",
635
- "name": "tryLoadLayoutFromLocalStorage",
636
- "return": {
637
- "type": {
638
- "text": ""
708
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
639
709
  }
640
710
  },
641
- "description": "Try to load a layout from local storage, or return false. Only required if manually calling FoundationLayout.registerItem",
642
- "privacy": "public"
643
- },
644
- {
645
- "kind": "method",
646
- "name": "loadLayout",
647
711
  "parameters": [
648
712
  {
649
- "name": "layout",
650
- "type": {
651
- "text": "SerialisedLayout"
652
- },
653
- "description": "any version of {@link SerialisedLayout}object describing the layout\n * "
654
- },
655
- {
656
- "name": "handleMissingItem",
657
- "default": "'error'",
713
+ "name": "this",
658
714
  "type": {
659
- "text": "'placeholder' | 'error'"
660
- },
661
- "description": "what to do if the layout contains items that are not currently registered with the layout system. Defaults to 'error' which will throw an error. If set to 'placeholder' then any missing items will be replaced with a placeholder element. You can control the text of the placeholder element with {@link FoundationLayout.missingItemPlaceholder}.\n * "
715
+ "text": "K"
716
+ }
662
717
  },
663
718
  {
664
- "name": "disableCache",
665
- "default": "false",
719
+ "name": "elementDefinition",
666
720
  "type": {
667
- "text": "boolean"
721
+ "text": "T"
668
722
  },
669
- "description": "if set to true then the layout will give you a new instance of every item, even if it has a currently cached item to use. Using this will not stop you from saving and loading state via the {@link LayoutComponentWithState}interface. Defaults to false.\n * "
723
+ "description": "The definition of the element to create the registry\nfunction for."
670
724
  }
671
725
  ],
672
- "privacy": "public"
673
- },
726
+ "description": "Defines an element registry function with a set of element definition defaults.",
727
+ "inheritedFrom": {
728
+ "name": "FoundationElement",
729
+ "module": "src/foundation-element/foundation-element.ts"
730
+ }
731
+ }
732
+ ],
733
+ "attributes": [
674
734
  {
675
- "kind": "method",
676
- "name": "addItem",
677
- "parameters": [
678
- {
679
- "name": "config",
680
- "type": {
681
- "text": "RegisteredElementConfig | RegisteredElementConfig[]"
682
- },
683
- "description": "{@link RegisteredElementConfig}configuration items for the new items(s). Pass an array of {@link RegisteredElementConfig}to add multiple items at once.\n * "
684
- },
685
- {
686
- "name": "placement",
687
- "default": "defaultAddItemPlacement",
688
- "type": {
689
- "text": "Placement"
690
- },
691
- "description": "where and how to add the new items to the layout. For more info and defaults see {@link Placement}.\n * "
692
- }
693
- ],
694
- "privacy": "public"
735
+ "name": "title",
736
+ "type": {
737
+ "text": "string"
738
+ },
739
+ "description": "Sets the title of the item which is displayed on the tab.",
740
+ "fieldName": "title"
695
741
  },
696
742
  {
697
- "kind": "method",
698
- "name": "removeItems",
699
- "return": {
700
- "type": {
701
- "text": ""
702
- }
743
+ "type": {
744
+ "text": "boolean"
703
745
  },
704
- "parameters": [
705
- {
706
- "name": "registration",
707
- "type": {
708
- "text": "string"
709
- },
710
- "description": "string of the registration ID"
711
- },
712
- {
713
- "name": "force",
714
- "default": "false",
715
- "type": {
716
- "text": "boolean"
717
- },
718
- "description": "if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header."
719
- }
720
- ],
721
- "privacy": "public"
746
+ "default": "false",
747
+ "description": "Boolean attribute controls whether the window can be closed in the GUI.\nDefaults to `false`.",
748
+ "fieldName": "closable"
722
749
  },
723
750
  {
724
- "kind": "method",
725
- "name": "registerItem",
726
- "return": {
727
- "type": {
728
- "text": ""
729
- }
751
+ "name": "size",
752
+ "type": {
753
+ "text": "string"
730
754
  },
731
- "parameters": [
732
- {
733
- "name": "registration",
734
- "type": {
735
- "text": "string"
736
- },
737
- "description": "string of the registration ID"
738
- },
739
- {
740
- "name": "elements",
741
- "type": {
742
- "text": "Element[]"
743
- },
744
- "description": "Elements[] containing the reference to the elements to register for later usage"
745
- }
746
- ],
747
- "privacy": "public"
755
+ "description": "optional string describing the size of the new item (see the written documentation for more info)",
756
+ "fieldName": "size"
748
757
  },
749
758
  {
750
- "kind": "method",
751
- "name": "updateLifecycleToken",
752
- "privacy": "private",
753
- "return": {
754
- "type": {
755
- "text": "void"
756
- }
759
+ "name": "registration",
760
+ "type": {
761
+ "text": "string"
757
762
  },
758
- "description": "The `LifecycleMixin` can use the lifecycleUpdateToken to determine if it needs to gate\nlifecycle methods from running when other items have been added or deleted.\nThis key is updated every time one of these actions are performed, so you can check if the key has changed and know you potentially need to gate some of your lifecycle functionality.\nThis method should be called whenever we are about to perform an action which will cause a lifecycle update, should as adding or removing an item from the layout"
763
+ "description": "Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem.",
764
+ "fieldName": "registration"
765
+ }
766
+ ],
767
+ "superclass": {
768
+ "name": "FoundationElement",
769
+ "package": "@microsoft/fast-foundation"
770
+ },
771
+ "tagName": "%%prefix%%-layout-item",
772
+ "customElement": true
773
+ }
774
+ ],
775
+ "exports": [
776
+ {
777
+ "kind": "js",
778
+ "name": "FoundationLayoutItem",
779
+ "declaration": {
780
+ "name": "FoundationLayoutItem",
781
+ "module": "src/main/layout-item.ts"
782
+ }
783
+ }
784
+ ]
785
+ },
786
+ {
787
+ "kind": "javascript-module",
788
+ "path": "src/main/layout-main.ts",
789
+ "declarations": [
790
+ {
791
+ "kind": "class",
792
+ "description": "",
793
+ "name": "FoundationLayout",
794
+ "members": [
795
+ {
796
+ "kind": "field",
797
+ "name": "layout",
798
+ "type": {
799
+ "text": "GoldenLayout"
800
+ },
801
+ "privacy": "private"
759
802
  },
760
803
  {
761
804
  "kind": "field",
762
- "name": "_presentation",
805
+ "name": "layoutConfig",
763
806
  "type": {
764
- "text": "ComponentPresentation | null | undefined"
807
+ "text": "LayoutConfig"
765
808
  },
766
809
  "privacy": "private",
767
- "default": "void 0",
768
- "inheritedFrom": {
769
- "name": "FoundationElement",
770
- "module": "src/foundation-element/foundation-element.ts"
771
- }
810
+ "default": "{ root: undefined }"
772
811
  },
773
812
  {
774
813
  "kind": "field",
775
- "name": "$presentation",
814
+ "name": "reloadBuffer",
776
815
  "type": {
777
- "text": "ComponentPresentation | null"
816
+ "text": "number"
778
817
  },
779
- "privacy": "public",
780
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
781
- "inheritedFrom": {
782
- "name": "FoundationElement",
783
- "module": "src/foundation-element/foundation-element.ts"
784
- }
818
+ "default": "DEFAULT_RELOAD_BUFFER",
819
+ "description": "Number describing how long to wait in ms before reloading the config when adding items\ndeclaratively by the html API. Default 500 (ms).",
820
+ "privacy": "public"
785
821
  },
786
822
  {
787
823
  "kind": "field",
788
- "name": "template",
824
+ "name": "reloadPending",
789
825
  "type": {
790
- "text": "ElementViewTemplate | void | null"
826
+ "text": "boolean"
791
827
  },
792
- "privacy": "public",
793
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
794
- "inheritedFrom": {
795
- "name": "FoundationElement",
796
- "module": "src/foundation-element/foundation-element.ts"
797
- }
828
+ "privacy": "private",
829
+ "default": "false"
798
830
  },
799
831
  {
800
- "kind": "method",
801
- "name": "templateChanged",
802
- "privacy": "protected",
803
- "return": {
804
- "type": {
805
- "text": "void"
806
- }
832
+ "kind": "field",
833
+ "name": "registeredComponents",
834
+ "type": {
835
+ "text": "number"
807
836
  },
808
- "inheritedFrom": {
809
- "name": "FoundationElement",
810
- "module": "src/foundation-element/foundation-element.ts"
811
- }
837
+ "privacy": "private",
838
+ "default": "0"
812
839
  },
813
840
  {
814
841
  "kind": "field",
815
- "name": "styles",
842
+ "name": "autoSaveKey",
816
843
  "type": {
817
- "text": "ElementStyles | void | null"
844
+ "text": "string | undefined"
818
845
  },
819
- "privacy": "public",
820
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
821
- "inheritedFrom": {
822
- "name": "FoundationElement",
823
- "module": "src/foundation-element/foundation-element.ts"
824
- }
846
+ "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`.",
847
+ "privacy": "public"
825
848
  },
826
849
  {
827
- "kind": "method",
828
- "name": "stylesChanged",
829
- "privacy": "protected",
830
- "return": {
831
- "type": {
832
- "text": "void"
833
- }
834
- },
835
- "inheritedFrom": {
836
- "name": "FoundationElement",
837
- "module": "src/foundation-element/foundation-element.ts"
838
- }
839
- },
840
- {
841
- "kind": "method",
842
- "name": "compose",
843
- "privacy": "public",
844
- "static": true,
845
- "return": {
846
- "type": {
847
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
848
- }
849
- },
850
- "parameters": [
851
- {
852
- "name": "this",
853
- "type": {
854
- "text": "K"
855
- }
856
- },
857
- {
858
- "name": "elementDefinition",
859
- "type": {
860
- "text": "T"
861
- },
862
- "description": "The definition of the element to create the registry\nfunction for."
863
- }
864
- ],
865
- "description": "Defines an element registry function with a set of element definition defaults.",
866
- "inheritedFrom": {
867
- "name": "FoundationElement",
868
- "module": "src/foundation-element/foundation-element.ts"
869
- }
870
- }
871
- ],
872
- "events": [
873
- {
874
- "description": "emitted when the layout has finished loading the first time",
875
- "name": "first-loaded"
876
- },
877
- {
878
- "description": "emitted when an item is added to the layout",
879
- "name": "item-added"
880
- },
881
- {
882
- "description": "emitted when an item is removed from the layout",
883
- "name": "item-removed"
850
+ "kind": "field",
851
+ "name": "missingItemPlaceholder",
852
+ "description": "Function which is used to generate the placeholder text when a layout is loaded\nwith a missing item.",
853
+ "privacy": "public"
884
854
  },
885
855
  {
886
- "description": "emitted when the user drags the divider to resize elements",
887
- "name": "item-resized"
888
- }
889
- ],
890
- "attributes": [
891
- {
892
- "name": "reload-buffer",
856
+ "kind": "field",
857
+ "name": "dimensionsConfig",
893
858
  "type": {
894
- "text": "number"
895
- },
896
- "default": "DEFAULT_RELOAD_BUFFER",
897
- "description": "Number describing how long to wait in ms before reloading the config when adding items\ndeclaratively by the html API. Default 500 (ms).",
898
- "resolveInitializer": {
899
- "module": "/src/utils/"
859
+ "text": "LayoutConfig.Dimensions | undefined"
900
860
  },
901
- "fieldName": "reloadBuffer"
861
+ "description": "Apply dimensions config to the layout, such as setting the size of the drag handles.",
862
+ "privacy": "public"
902
863
  },
903
864
  {
904
- "name": "auto-save-key",
865
+ "kind": "field",
866
+ "name": "hasFirstLoaded",
905
867
  "type": {
906
- "text": "string | undefined"
868
+ "text": "boolean"
907
869
  },
908
- "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`.",
909
- "fieldName": "autoSaveKey"
870
+ "default": "false",
871
+ "description": "Boolean signifies whether the layout has loaded for the first time or not.",
872
+ "privacy": "public"
910
873
  },
911
- {
912
- "name": "popout-config",
913
- "type": {
914
- "text": "string | undefined"
915
- },
916
- "default": "undefined",
917
- "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.",
918
- "resolveInitializer": {
919
- "module": "src/main/layout-main.ts"
920
- },
921
- "fieldName": "popoutConfig"
922
- }
923
- ],
924
- "superclass": {
925
- "name": "FoundationElement",
926
- "package": "@microsoft/fast-foundation"
927
- },
928
- "tagName": "%%prefix%%-layout",
929
- "customElement": true
930
- },
931
- {
932
- "kind": "variable",
933
- "name": "layoutTemplate",
934
- "default": "html<FoundationLayout>`\n <template>\n ${when((x) => !x.hasFirstLoaded && x.usingDeclerativeAPI, loadingTemplate)}\n <div class=\"layout-container\" ${ref('layoutElement')}></div>\n </template>\n`",
935
- "description": "`ViewTemplate` which defines the html for FoundationLayout.",
936
- "privacy": "public"
937
- }
938
- ],
939
- "exports": [
940
- {
941
- "kind": "js",
942
- "name": "layoutStyles",
943
- "declaration": {
944
- "name": "layoutStyles",
945
- "module": "../styles"
946
- }
947
- },
948
- {
949
- "kind": "js",
950
- "name": "FoundationLayout",
951
- "declaration": {
952
- "name": "FoundationLayout",
953
- "module": "src/main/layout-main.ts"
954
- }
955
- },
956
- {
957
- "kind": "js",
958
- "name": "layoutTemplate",
959
- "declaration": {
960
- "name": "layoutTemplate",
961
- "module": "src/main/layout-main.ts"
962
- }
963
- }
964
- ]
965
- },
966
- {
967
- "kind": "javascript-module",
968
- "path": "src/main/layout-region.ts",
969
- "declarations": [
970
- {
971
- "kind": "class",
972
- "description": "",
973
- "name": "FoundationLayoutRegion",
974
- "members": [
975
874
  {
976
875
  "kind": "field",
977
- "name": "size",
876
+ "name": "customButtons",
978
877
  "type": {
979
- "text": "string"
878
+ "text": "CustomButton[]"
980
879
  },
981
- "description": "optional string describing the size of the new item (see the written documentation for more info)",
880
+ "default": "[]",
881
+ "description": "Set custom button definition on this property to add them to the layout header controls",
982
882
  "privacy": "public"
983
883
  },
984
884
  {
985
885
  "kind": "field",
986
- "name": "type",
886
+ "name": "dragging",
987
887
  "type": {
988
- "text": "LayoutRegionType"
888
+ "text": "boolean"
989
889
  },
990
- "default": "layoutRegionValue[0]",
991
- "description": "Defines the LayoutRegionType| type of the region.\nDefaults to `horizontal`.",
890
+ "default": "false",
992
891
  "privacy": "public"
993
892
  },
994
893
  {
995
894
  "kind": "field",
996
- "name": "_presentation",
895
+ "name": "class",
896
+ "privacy": "public",
897
+ "default": "'FoundationLayoutMain'",
997
898
  "type": {
998
- "text": "ComponentPresentation | null | undefined"
999
- },
1000
- "privacy": "private",
1001
- "default": "void 0",
1002
- "inheritedFrom": {
1003
- "name": "FoundationElement",
1004
- "module": "src/foundation-element/foundation-element.ts"
899
+ "text": "'FoundationLayoutMain'"
1005
900
  }
1006
901
  },
1007
902
  {
1008
903
  "kind": "field",
1009
- "name": "$presentation",
904
+ "name": "lifecycleUpdateToken",
1010
905
  "type": {
1011
- "text": "ComponentPresentation | null"
906
+ "text": "string | undefined"
1012
907
  },
1013
908
  "privacy": "public",
1014
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
1015
- "inheritedFrom": {
1016
- "name": "FoundationElement",
1017
- "module": "src/foundation-element/foundation-element.ts"
1018
- }
909
+ "default": "undefined",
910
+ "description": "Used to calculate whether a layout item should run its lifecycle methods or not"
1019
911
  },
1020
912
  {
1021
913
  "kind": "field",
1022
- "name": "template",
914
+ "name": "popoutConfig",
1023
915
  "type": {
1024
- "text": "ElementViewTemplate | void | null"
916
+ "text": "string | undefined"
1025
917
  },
1026
- "privacy": "public",
1027
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
1028
- "inheritedFrom": {
1029
- "name": "FoundationElement",
1030
- "module": "src/foundation-element/foundation-element.ts"
1031
- }
918
+ "default": "undefined",
919
+ "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."
920
+ },
921
+ {
922
+ "kind": "field",
923
+ "name": "popupMode",
924
+ "type": {
925
+ "text": "boolean"
926
+ },
927
+ "privacy": "private",
928
+ "default": "false"
1032
929
  },
1033
930
  {
1034
931
  "kind": "method",
1035
- "name": "templateChanged",
1036
- "privacy": "protected",
932
+ "name": "layoutRequiredRegistrations",
933
+ "static": true,
1037
934
  "return": {
1038
935
  "type": {
1039
- "text": "void"
936
+ "text": ""
1040
937
  }
1041
938
  },
1042
- "inheritedFrom": {
1043
- "name": "FoundationElement",
1044
- "module": "src/foundation-element/foundation-element.ts"
1045
- }
939
+ "parameters": [
940
+ {
941
+ "name": "layout",
942
+ "type": {
943
+ "text": "SerialisedLayout"
944
+ },
945
+ "description": "any version of {@link SerialisedLayout}object describing the layout\n * "
946
+ }
947
+ ],
948
+ "description": "JS API, public",
949
+ "privacy": "public"
1046
950
  },
1047
951
  {
1048
- "kind": "field",
1049
- "name": "styles",
1050
- "type": {
1051
- "text": "ElementStyles | void | null"
952
+ "kind": "method",
953
+ "name": "registeredItems",
954
+ "return": {
955
+ "type": {
956
+ "text": ""
957
+ }
1052
958
  },
1053
- "privacy": "public",
1054
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
1055
- "inheritedFrom": {
1056
- "name": "FoundationElement",
1057
- "module": "src/foundation-element/foundation-element.ts"
1058
- }
959
+ "privacy": "public"
1059
960
  },
1060
961
  {
1061
962
  "kind": "method",
1062
- "name": "stylesChanged",
1063
- "privacy": "protected",
963
+ "name": "getLayout",
1064
964
  "return": {
1065
965
  "type": {
1066
- "text": "void"
966
+ "text": ""
1067
967
  }
1068
968
  },
1069
- "inheritedFrom": {
1070
- "name": "FoundationElement",
1071
- "module": "src/foundation-element/foundation-element.ts"
1072
- }
969
+ "privacy": "public"
1073
970
  },
1074
971
  {
1075
972
  "kind": "method",
1076
- "name": "compose",
1077
- "privacy": "public",
1078
- "static": true,
973
+ "name": "tryActivatePopoutMode",
1079
974
  "return": {
1080
975
  "type": {
1081
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
976
+ "text": "boolean"
977
+ }
978
+ },
979
+ "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."
980
+ },
981
+ {
982
+ "kind": "method",
983
+ "name": "tryLoadLayoutFromLocalStorage",
984
+ "return": {
985
+ "type": {
986
+ "text": ""
987
+ }
988
+ },
989
+ "description": "Try to load a layout from local storage, or return false. Only required if manually calling FoundationLayout.registerItem",
990
+ "privacy": "public"
991
+ },
992
+ {
993
+ "kind": "method",
994
+ "name": "loadLayout",
995
+ "parameters": [
996
+ {
997
+ "name": "layout",
998
+ "type": {
999
+ "text": "SerialisedLayout"
1000
+ },
1001
+ "description": "any version of {@link SerialisedLayout}object describing the layout\n * "
1002
+ },
1003
+ {
1004
+ "name": "handleMissingItem",
1005
+ "default": "'error'",
1006
+ "type": {
1007
+ "text": "'placeholder' | 'error'"
1008
+ },
1009
+ "description": "what to do if the layout contains items that are not currently registered with the layout system. Defaults to 'error' which will throw an error. If set to 'placeholder' then any missing items will be replaced with a placeholder element. You can control the text of the placeholder element with {@link FoundationLayout.missingItemPlaceholder}.\n * "
1010
+ },
1011
+ {
1012
+ "name": "disableCache",
1013
+ "default": "false",
1014
+ "type": {
1015
+ "text": "boolean"
1016
+ },
1017
+ "description": "if set to true then the layout will give you a new instance of every item, even if it has a currently cached item to use. Using this will not stop you from saving and loading state via the {@link LayoutComponentWithState}interface. Defaults to false.\n * "
1018
+ }
1019
+ ],
1020
+ "privacy": "public"
1021
+ },
1022
+ {
1023
+ "kind": "method",
1024
+ "name": "addItem",
1025
+ "parameters": [
1026
+ {
1027
+ "name": "config",
1028
+ "type": {
1029
+ "text": "RegisteredElementConfig | RegisteredElementConfig[]"
1030
+ },
1031
+ "description": "{@link RegisteredElementConfig}configuration items for the new items(s). Pass an array of {@link RegisteredElementConfig}to add multiple items at once.\n * "
1032
+ },
1033
+ {
1034
+ "name": "placement",
1035
+ "default": "defaultAddItemPlacement",
1036
+ "type": {
1037
+ "text": "Placement"
1038
+ },
1039
+ "description": "where and how to add the new items to the layout. For more info and defaults see {@link Placement}.\n * "
1040
+ }
1041
+ ],
1042
+ "privacy": "public"
1043
+ },
1044
+ {
1045
+ "kind": "method",
1046
+ "name": "removeItems",
1047
+ "return": {
1048
+ "type": {
1049
+ "text": ""
1050
+ }
1051
+ },
1052
+ "parameters": [
1053
+ {
1054
+ "name": "registration",
1055
+ "type": {
1056
+ "text": "string"
1057
+ },
1058
+ "description": "string of the registration ID"
1059
+ },
1060
+ {
1061
+ "name": "force",
1062
+ "default": "false",
1063
+ "type": {
1064
+ "text": "boolean"
1065
+ },
1066
+ "description": "if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header."
1067
+ }
1068
+ ],
1069
+ "privacy": "public"
1070
+ },
1071
+ {
1072
+ "kind": "method",
1073
+ "name": "registerItem",
1074
+ "return": {
1075
+ "type": {
1076
+ "text": ""
1077
+ }
1078
+ },
1079
+ "parameters": [
1080
+ {
1081
+ "name": "registration",
1082
+ "type": {
1083
+ "text": "string"
1084
+ },
1085
+ "description": "string of the registration ID"
1086
+ },
1087
+ {
1088
+ "name": "elements",
1089
+ "type": {
1090
+ "text": "Element[]"
1091
+ },
1092
+ "description": "Elements[] containing the reference to the elements to register for later usage"
1093
+ }
1094
+ ],
1095
+ "privacy": "public"
1096
+ },
1097
+ {
1098
+ "kind": "method",
1099
+ "name": "updateLifecycleToken",
1100
+ "privacy": "private",
1101
+ "return": {
1102
+ "type": {
1103
+ "text": "void"
1104
+ }
1105
+ },
1106
+ "description": "The `LifecycleMixin` can use the lifecycleUpdateToken to determine if it needs to gate\nlifecycle methods from running when other items have been added or deleted.\nThis key is updated every time one of these actions are performed, so you can check if the key has changed and know you potentially need to gate some of your lifecycle functionality.\nThis method should be called whenever we are about to perform an action which will cause a lifecycle update, should as adding or removing an item from the layout"
1107
+ },
1108
+ {
1109
+ "kind": "field",
1110
+ "name": "_presentation",
1111
+ "type": {
1112
+ "text": "ComponentPresentation | null | undefined"
1113
+ },
1114
+ "privacy": "private",
1115
+ "default": "void 0",
1116
+ "inheritedFrom": {
1117
+ "name": "FoundationElement",
1118
+ "module": "src/foundation-element/foundation-element.ts"
1119
+ }
1120
+ },
1121
+ {
1122
+ "kind": "field",
1123
+ "name": "$presentation",
1124
+ "type": {
1125
+ "text": "ComponentPresentation | null"
1126
+ },
1127
+ "privacy": "public",
1128
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
1129
+ "inheritedFrom": {
1130
+ "name": "FoundationElement",
1131
+ "module": "src/foundation-element/foundation-element.ts"
1132
+ }
1133
+ },
1134
+ {
1135
+ "kind": "field",
1136
+ "name": "template",
1137
+ "type": {
1138
+ "text": "ElementViewTemplate | void | null"
1139
+ },
1140
+ "privacy": "public",
1141
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
1142
+ "inheritedFrom": {
1143
+ "name": "FoundationElement",
1144
+ "module": "src/foundation-element/foundation-element.ts"
1145
+ }
1146
+ },
1147
+ {
1148
+ "kind": "method",
1149
+ "name": "templateChanged",
1150
+ "privacy": "protected",
1151
+ "return": {
1152
+ "type": {
1153
+ "text": "void"
1154
+ }
1155
+ },
1156
+ "inheritedFrom": {
1157
+ "name": "FoundationElement",
1158
+ "module": "src/foundation-element/foundation-element.ts"
1159
+ }
1160
+ },
1161
+ {
1162
+ "kind": "field",
1163
+ "name": "styles",
1164
+ "type": {
1165
+ "text": "ElementStyles | void | null"
1166
+ },
1167
+ "privacy": "public",
1168
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
1169
+ "inheritedFrom": {
1170
+ "name": "FoundationElement",
1171
+ "module": "src/foundation-element/foundation-element.ts"
1172
+ }
1173
+ },
1174
+ {
1175
+ "kind": "method",
1176
+ "name": "stylesChanged",
1177
+ "privacy": "protected",
1178
+ "return": {
1179
+ "type": {
1180
+ "text": "void"
1181
+ }
1182
+ },
1183
+ "inheritedFrom": {
1184
+ "name": "FoundationElement",
1185
+ "module": "src/foundation-element/foundation-element.ts"
1186
+ }
1187
+ },
1188
+ {
1189
+ "kind": "method",
1190
+ "name": "compose",
1191
+ "privacy": "public",
1192
+ "static": true,
1193
+ "return": {
1194
+ "type": {
1195
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
1082
1196
  }
1083
1197
  },
1084
1198
  "parameters": [
@@ -1103,394 +1217,280 @@
1103
1217
  }
1104
1218
  }
1105
1219
  ],
1106
- "attributes": [
1220
+ "events": [
1107
1221
  {
1108
- "name": "size",
1109
- "type": {
1110
- "text": "string"
1111
- },
1112
- "description": "optional string describing the size of the new item (see the written documentation for more info)",
1113
- "fieldName": "size"
1222
+ "description": "emitted when the layout has finished loading the first time",
1223
+ "name": "first-loaded"
1114
1224
  },
1115
1225
  {
1116
- "name": "type",
1117
- "type": {
1118
- "text": "LayoutRegionType"
1119
- },
1120
- "default": "defaultLayoutType",
1121
- "description": "Defines the LayoutRegionType| type of the region.\nDefaults to `horizontal`.",
1122
- "resolveInitializer": {
1123
- "module": "src/main/layout-region.ts"
1124
- },
1125
- "fieldName": "type"
1226
+ "description": "emitted when an item is added to the layout",
1227
+ "name": "item-added"
1228
+ },
1229
+ {
1230
+ "description": "emitted when an item is removed from the layout",
1231
+ "name": "item-removed"
1232
+ },
1233
+ {
1234
+ "description": "emitted when the user drags the divider to resize elements",
1235
+ "name": "item-resized"
1126
1236
  }
1127
1237
  ],
1128
- "superclass": {
1129
- "name": "FoundationElement",
1130
- "package": "@microsoft/fast-foundation"
1131
- },
1132
- "tagName": "%%prefix%%-layout-region",
1133
- "customElement": true
1134
- }
1135
- ],
1136
- "exports": [
1137
- {
1138
- "kind": "js",
1139
- "name": "FoundationLayoutRegion",
1140
- "declaration": {
1141
- "name": "FoundationLayoutRegion",
1142
- "module": "src/main/layout-region.ts"
1143
- }
1144
- }
1145
- ]
1146
- },
1147
- {
1148
- "kind": "javascript-module",
1149
- "path": "src/styles/constants.ts",
1150
- "declarations": [
1151
- {
1152
- "kind": "variable",
1153
- "name": "glVisualConfig",
1154
- "type": {
1155
- "text": "Omit<LayoutConfig, 'root'>"
1156
- },
1157
- "default": "{\n dimensions: {\n headerHeight: 38,\n borderWidth: 12,\n },\n header: {\n maximise: 'maximise',\n minimise: 'minimise',\n popout: false,\n },\n}"
1158
- },
1159
- {
1160
- "kind": "variable",
1161
- "name": "LAYOUT_ICONS",
1162
- "type": {
1163
- "text": "{\n renameSVG,\n maximiseSVG,\n minimiseSVG,\n closeSVG,\n tabDropdownSVG,\n popoutSVG,\n}"
1164
- },
1165
- "default": "{\n renameSVG,\n maximiseSVG,\n minimiseSVG,\n closeSVG,\n tabDropdownSVG,\n popoutSVG,\n}",
1166
- "description": "A collection of SVG icons in base64 format.",
1167
- "privacy": "public"
1168
- }
1169
- ],
1170
- "exports": [
1171
- {
1172
- "kind": "js",
1173
- "name": "glVisualConfig",
1174
- "declaration": {
1175
- "name": "glVisualConfig",
1176
- "module": "src/styles/constants.ts"
1177
- }
1178
- },
1179
- {
1180
- "kind": "js",
1181
- "name": "LAYOUT_ICONS",
1182
- "declaration": {
1183
- "name": "LAYOUT_ICONS",
1184
- "module": "src/styles/constants.ts"
1185
- }
1186
- }
1187
- ]
1188
- },
1189
- {
1190
- "kind": "javascript-module",
1191
- "path": "src/styles/dragging.styles.ts",
1192
- "declarations": [
1193
- {
1194
- "kind": "variable",
1195
- "name": "globalDraggingStyles",
1196
- "default": "`\n .lm_dragProxy .lm_content {\n box-shadow: 2px 2px 4px rgba(0, 0, 0, 0.9);\n }\n .lm_dropTargetIndicator {\n box-shadow: inset 0 0 30px #000000;\n outline: 1px dashed #cccccc;\n transition: all 200ms ease;\n }\n .lm_dropTargetIndicator .lm_inner {\n background: var(${neutralFillStealthRest.cssCustomProperty});\n opacity: 0.2;\n }\n .lm_dragProxy.lm_left .lm_header,\n .lm_dragProxy.lm_right .lm_header {\n width: 20px;\n float: left;\n vertical-align: top;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs,\n .lm_dragProxy.lm_right .lm_header .lm_tabs {\n transform-origin: left top;\n top: 0;\n width: 1000px;\n }\n .lm_dragProxy.lm_left .lm_header .lm_controls,\n .lm_dragProxy.lm_right .lm_header .lm_controls {\n bottom: 0;\n }\n .lm_dragProxy.lm_left .lm_items,\n .lm_dragProxy.lm_right .lm_items {\n float: left;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs {\n transform: rotate(-90deg) scaleX(-1);\n left: 0;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs .lm_tab {\n transform: scaleX(-1);\n margin-top: 1px;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabdropdown_list {\n top: initial;\n right: initial;\n left: 20px;\n }\n .lm_dragProxy.lm_right .lm_content {\n float: left;\n }\n .lm_dragProxy.lm_right .lm_header .lm_tabs {\n transform: rotate(90deg) scaleX(1);\n left: 100%;\n margin-left: 0;\n }\n .lm_dragProxy.lm_right .lm_header .lm_controls {\n left: 3px;\n }\n .lm_dragProxy.lm_right .lm_header .lm_tabdropdown_list {\n top: initial;\n right: 20px;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_tab {\n margin-top: 0;\n border-top: none;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_controls,\n .lm_stack.lm_bottom .lm_header .lm_controls {\n top: 3px;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_tabdropdown_list,\n .lm_stack.lm_bottom .lm_header .lm_tabdropdown_list {\n top: initial;\n bottom: 20px;\n }\n .lm_dragProxy {\n cursor: move;\n position: absolute;\n top: 0;\n left: 0;\n z-index: 30;\n }\n .lm_dragProxy .lm_header {\n background: transparent;\n }\n .lm_dragProxy .lm_title {\n color: white;\n padding-left: 10px;\n }\n .lm_dragProxy .lm_content {\n border-top: none;\n overflow: hidden;\n }\n .lm_dropTargetIndicator {\n display: none;\n position: absolute;\n z-index: 20;\n }\n .lm_dropTargetIndicator .lm_inner {\n width: 100%;\n height: 100%;\n position: relative;\n top: 0;\n left: 0;\n }\n .lm_transition_indicator {\n display: none;\n width: 20px;\n height: 20px;\n position: absolute;\n top: 0;\n left: 0;\n z-index: 20;\n }\n`",
1197
- "description": "This is defined as a string rather than a css template\nbecause it is applied to a CSSStyleSheet object rather than\nused as a FAST template"
1198
- }
1199
- ],
1200
- "exports": [
1201
- {
1202
- "kind": "js",
1203
- "name": "globalDraggingStyles",
1204
- "declaration": {
1205
- "name": "globalDraggingStyles",
1206
- "module": "src/styles/dragging.styles.ts"
1207
- }
1208
- }
1209
- ]
1210
- },
1211
- {
1212
- "kind": "javascript-module",
1213
- "path": "src/styles/index.ts",
1214
- "declarations": [],
1215
- "exports": [
1216
- {
1217
- "kind": "js",
1218
- "name": "*",
1219
- "declaration": {
1220
- "name": "*",
1221
- "package": "./constants"
1222
- }
1223
- },
1224
- {
1225
- "kind": "js",
1226
- "name": "*",
1227
- "declaration": {
1228
- "name": "*",
1229
- "package": "./dragging.styles"
1230
- }
1231
- },
1232
- {
1233
- "kind": "js",
1234
- "name": "*",
1235
- "declaration": {
1236
- "name": "*",
1237
- "package": "./layout.styles"
1238
- }
1239
- }
1240
- ]
1241
- },
1242
- {
1243
- "kind": "javascript-module",
1244
- "path": "src/styles/layout.styles.ts",
1245
- "declarations": [
1246
- {
1247
- "kind": "variable",
1248
- "name": "layoutStyles",
1249
- "default": "css`\n ${containerStyles}\n ${loadingSpinnerStyles}\n\n .lm_goldenlayout {\n padding: 1px;\n background: ${neutralLayer1};\n border-radius: calc(${controlCornerRadius} * 1.5px);\n }\n\n .lm_stack.lm_item {\n background-color: ${neutralLayer4};\n border-radius: calc(${controlCornerRadius} * 1.5px);\n }\n .lm_maximised .lm_header {\n background-color: ${neutralLayer4};\n border-radius: calc(${controlCornerRadius} * 1.5px);\n position: unset;\n }\n\n .lm_maximised .lm_header .lm_tabs {\n z-index: 3;\n }\n\n .lm_content {\n background-color: ${neutralLayer3};\n border-radius: calc(${controlCornerRadius} * 1.5px);\n border: 1px solid;\n border-color: #2e3339;\n box-sizing: border-box;\n }\n\n .lm-header {\n z-index: 1;\n }\n .lm_header .lm_tabs {\n padding: 0 16px;\n }\n\n .lm_stack > .lm_items {\n z-index: 2;\n box-shadow: 0px -1px 15px rgba(0, 0, 0, 0.35);\n }\n\n .lm_header .lm_tab.lm_active.lm_focused {\n background-color: ${neutralLayer3};\n }\n .lm_header .lm_tab.lm_active {\n background-color: ${neutralLayer3};\n border: 1px solid;\n border-color: #2e3339;\n border-bottom: 0;\n color: ${accentFillRest};\n }\n\n .lm_header .lm_tab {\n align-items: center;\n background-color: ${neutralLayer4};\n border: 1px solid;\n border-bottom-color: #2e3339;\n border-bottom: 0px solid;\n border-color: rgba(0, 0, 0, 0.35);\n border-radius: calc(${controlCornerRadius} * 1.5px) calc(${controlCornerRadius} * 1.5px) 0 0;\n box-shadow: 1px -1px 2px rgba(0, 0, 0, 0.35);\n color: rgba(255, 255, 255, 0.3);\n display: flex;\n font-family: inherit;\n font-size: 13px;\n font-weight: 700;\n height: 30px;\n margin-right: 2px;\n margin-top: 3px;\n padding: 2px 16px;\n }\n\n .lm_header .lm_tab:not(.lm_active):hover {\n background-color: rgba(255, 255, 255, 0.1);\n color: #f1f1f1;\n }\n\n .lm_header .lm_controls {\n top: 4px;\n display: flex;\n }\n .lm_header .lm_controls > * {\n width: 30px;\n height: 30px;\n background-repeat: no-repeat;\n background-position: center;\n background-size: 16px;\n background-color: rgba(255, 255, 255, 0.03);\n border-radius: calc(${controlCornerRadius} * 1.5px);\n margin-right: 4px;\n top: 3px;\n opacity: 1;\n }\n .lm_header .lm_controls > *:hover {\n background-color: rgba(255, 255, 255, 0.1);\n cursor: pointer;\n }\n\n .lm_controls .lm_maximise {\n background-image: url('${LAYOUT_ICONS.maximiseSVG}');\n }\n .lm_maximised .lm_controls .lm_maximise {\n background-image: url('${LAYOUT_ICONS.minimiseSVG}');\n }\n .lm_controls .lm_close {\n background-image: url('${LAYOUT_ICONS.closeSVG}');\n }\n .lm_header .lm_tab .lm_close_tab {\n background-image: url('${LAYOUT_ICONS.closeSVG}');\n background-size: 10px;\n background-repeat: no-repeat;\n margin-left: 12px;\n position: relative;\n top: 0;\n right: 0;\n }\n\n .lm_header .lm_tab.lm_active {\n padding: 4px 25px 3px 10px;\n }\n\n .lm_header .lm_tab:not(.lm_active) .lm_title {\n color: ${accentFillRest};\n opacity: 0.7;\n }\n\n .lm_header .lm_controls .lm_tabdropdown::before {\n content: none;\n }\n .lm_header .lm_controls .lm_tabdropdown {\n background-image: url('${LAYOUT_ICONS.tabDropdownSVG}');\n }\n .lm_header .lm_tabdropdown_list {\n top: 38px;\n right: 108px;\n background-color: ${neutralLayer3};\n border: 1px solid;\n border-color: #2e3339;\n border-radius: calc(${controlCornerRadius} * 1.5px);\n box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.35);\n }\n .lm_header .lm_tabdropdown_list > .lm_tab {\n box-shadow: none;\n padding: 0 16px;\n white-space: nowrap;\n background-color: transparent;\n color: #c9c9c9;\n height: 36px;\n border-radius: 0;\n overflow: visible;\n text-overflow: normal;\n }\n .lm_header .lm_tabdropdown_list > .lm_tab:last-child {\n border-bottom: 0;\n }\n\n /* gl base styles start */\n .lm_root {\n position: relative;\n }\n .lm_row > .lm_item {\n float: left;\n }\n .lm_content {\n overflow: hidden;\n position: relative;\n }\n .lm_dragging,\n .lm_dragging * {\n cursor: move !important;\n user-select: none;\n }\n .lm_maximised {\n left: 0;\n padding: 1px;\n position: absolute;\n top: 0;\n z-index: 40;\n }\n .lm_maximise_placeholder {\n display: none;\n }\n .lm_splitter {\n position: relative;\n z-index: 20;\n }\n .lm_splitter:hover,\n .lm_splitter.lm_dragging {\n background: ${accentFillRest};\n border-radius: calc(${controlCornerRadius} * 4px);\n }\n .lm_splitter.lm_vertical .lm_drag_handle {\n width: 100%;\n height: 15px;\n position: absolute;\n top: -5px;\n cursor: ns-resize !important;\n }\n .lm_splitter.lm_horizontal {\n float: left;\n height: 100%;\n }\n .lm_splitter.lm_horizontal .lm_drag_handle {\n width: 15px;\n height: 100%;\n position: absolute;\n left: -5px;\n cursor: ew-resize !important;\n }\n .lm_header {\n overflow: visible;\n position: relative;\n z-index: 1;\n }\n .lm_header [class^='lm_'] {\n box-sizing: content-box !important;\n }\n .lm_header .lm_controls {\n position: absolute;\n right: 3px;\n }\n .lm_header .lm_controls > li {\n cursor: pointer;\n float: left;\n width: 18px;\n height: 18px;\n text-align: center;\n }\n .lm_header ul {\n margin: 0;\n padding: 0;\n list-style-type: none;\n }\n .lm_header .lm_tabs {\n position: absolute;\n }\n .lm_header .lm_tab {\n cursor: pointer;\n float: left;\n margin-top: 1px;\n padding: 3px 25px 3px 10px;\n position: relative;\n }\n .lm_header .lm_tab i {\n width: 2px;\n height: 19px;\n position: absolute;\n }\n .lm_header .lm_tab i.lm_left {\n top: 0;\n left: -2px;\n }\n .lm_header .lm_tab i.lm_right {\n top: 0;\n right: -2px;\n }\n .lm_header .lm_tab .lm_title {\n display: inline-block;\n overflow: hidden;\n text-overflow: ellipsis;\n user-select: none;\n }\n .lm_header .lm_tab .lm_title:only-child {\n padding-left: 10px;\n }\n .lm_header .lm_tab .lm_close_tab {\n width: 14px;\n height: 14px;\n position: absolute;\n top: 11px;\n right: 0;\n text-align: center;\n }\n .lm_stack.lm_left .lm_header,\n .lm_stack.lm_right .lm_header {\n height: 100%;\n }\n .lm_dragProxy.lm_left .lm_header,\n .lm_dragProxy.lm_right .lm_header,\n .lm_stack.lm_left .lm_header,\n .lm_stack.lm_right .lm_header {\n width: 20px;\n float: left;\n vertical-align: top;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs,\n .lm_dragProxy.lm_right .lm_header .lm_tabs,\n .lm_stack.lm_left .lm_header .lm_tabs,\n .lm_stack.lm_right .lm_header .lm_tabs {\n transform-origin: left top;\n top: 0;\n width: 1000px;\n }\n .lm_dragProxy.lm_left .lm_header .lm_controls,\n .lm_dragProxy.lm_right .lm_header .lm_controls,\n .lm_stack.lm_left .lm_header .lm_controls,\n .lm_stack.lm_right .lm_header .lm_controls {\n bottom: 0;\n }\n .lm_dragProxy.lm_left .lm_items,\n .lm_dragProxy.lm_right .lm_items,\n .lm_stack.lm_left .lm_items,\n .lm_stack.lm_right .lm_items {\n float: left;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs,\n .lm_stack.lm_left .lm_header .lm_tabs {\n transform: rotate(-90deg) scaleX(-1);\n left: 0;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabs .lm_tab,\n .lm_stack.lm_left .lm_header .lm_tabs .lm_tab {\n transform: scaleX(-1);\n margin-top: 1px;\n }\n .lm_dragProxy.lm_left .lm_header .lm_tabdropdown_list,\n .lm_stack.lm_left .lm_header .lm_tabdropdown_list {\n top: initial;\n right: initial;\n left: 20px;\n }\n .lm_dragProxy.lm_right .lm_content {\n float: left;\n }\n .lm_dragProxy.lm_right .lm_header .lm_tabs,\n .lm_stack.lm_right .lm_header .lm_tabs {\n transform: rotate(90deg) scaleX(1);\n left: 100%;\n margin-left: 0;\n }\n .lm_dragProxy.lm_right .lm_header .lm_controls,\n .lm_stack.lm_right .lm_header .lm_controls {\n left: 3px;\n }\n .lm_dragProxy.lm_right .lm_header .lm_tabdropdown_list,\n .lm_stack.lm_right .lm_header .lm_tabdropdown_list {\n top: initial;\n right: 20px;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_tab,\n .lm_stack.lm_bottom .lm_header .lm_tab {\n margin-top: 0;\n border-top: none;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_controls,\n .lm_stack.lm_bottom .lm_header .lm_controls {\n top: 3px;\n }\n .lm_dragProxy.lm_bottom .lm_header .lm_tabdropdown_list,\n .lm_stack.lm_bottom .lm_header .lm_tabdropdown_list {\n top: initial;\n bottom: 20px;\n }\n .lm_drop_tab_placeholder {\n float: left;\n width: 100px;\n height: 10px;\n visibility: hidden;\n }\n .lm_header .lm_tabdropdown_list {\n position: absolute;\n top: 20px;\n right: 0;\n z-index: 5;\n overflow: hidden;\n }\n .lm_header .lm_tabdropdown_list .lm_tab {\n clear: both;\n padding-right: 10px;\n margin: 0;\n }\n .lm_header .lm_tabdropdown_list .lm_tab .lm_title {\n width: 100px;\n }\n .lm_header .lm_tabdropdown_list .lm_close_tab {\n display: none !important;\n }\n .lm_dragProxy {\n position: absolute;\n top: 0;\n left: 0;\n z-index: 30;\n }\n .lm_dragProxy .lm_header {\n background: transparent;\n }\n .lm_dragProxy .lm_content {\n border-top: none;\n overflow: hidden;\n }\n .lm_dropTargetIndicator {\n display: none;\n position: absolute;\n z-index: 20;\n }\n .lm_dropTargetIndicator .lm_inner {\n width: 100%;\n height: 100%;\n position: relative;\n top: 0;\n left: 0;\n }\n .lm_transition_indicator {\n display: none;\n width: 20px;\n height: 20px;\n position: absolute;\n top: 0;\n left: 0;\n z-index: 20;\n }\n .lm_popin {\n width: 20px;\n height: 20px;\n position: absolute;\n bottom: 0;\n right: 0;\n z-index: 9999;\n }\n .lm_popin > * {\n width: 100%;\n height: 100%;\n position: absolute;\n top: 0;\n left: 0;\n }\n .lm_popin > .lm_bg {\n z-index: 10;\n }\n .lm_popin > .lm_icon {\n z-index: 20;\n } /*# sourceMappingURL=goldenlayout-base.css.map */\n`",
1250
- "description": "`ElementStyles` which defines the css for FoundationLayout.",
1251
- "privacy": "public"
1252
- }
1253
- ],
1254
- "exports": [
1255
- {
1256
- "kind": "js",
1257
- "name": "layoutStyles",
1258
- "declaration": {
1259
- "name": "layoutStyles",
1260
- "module": "src/styles/layout.styles.ts"
1261
- }
1262
- }
1263
- ]
1264
- },
1265
- {
1266
- "kind": "javascript-module",
1267
- "path": "src/utils/constants.ts",
1268
- "declarations": [
1269
- {
1270
- "kind": "variable",
1271
- "name": "DEFAULT_RELOAD_BUFFER",
1272
- "type": {
1273
- "text": "number"
1274
- },
1275
- "default": "500",
1276
- "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.",
1277
- "privacy": "public"
1278
- },
1279
- {
1280
- "kind": "variable",
1281
- "name": "LAYOUT_POPOUT_CONTAINER_CLASS",
1282
- "type": {
1283
- "text": "string"
1284
- },
1285
- "default": "'f-layout-popout'",
1286
- "description": "Put this classname on an element which is a DOM parent of the layout, and\nif the layout goes into popout mode then it will place itself as the only child\nfor the popout container you set."
1287
- }
1288
- ],
1289
- "exports": [
1290
- {
1291
- "kind": "js",
1292
- "name": "DEFAULT_RELOAD_BUFFER",
1293
- "declaration": {
1294
- "name": "DEFAULT_RELOAD_BUFFER",
1295
- "module": "src/utils/constants.ts"
1296
- }
1297
- },
1298
- {
1299
- "kind": "js",
1300
- "name": "LAYOUT_POPOUT_CONTAINER_CLASS",
1301
- "declaration": {
1302
- "name": "LAYOUT_POPOUT_CONTAINER_CLASS",
1303
- "module": "src/utils/constants.ts"
1304
- }
1305
- }
1306
- ]
1307
- },
1308
- {
1309
- "kind": "javascript-module",
1310
- "path": "src/utils/error.ts",
1311
- "declarations": [
1312
- {
1313
- "kind": "class",
1314
- "description": "",
1315
- "name": "LayoutUsageError",
1316
- "superclass": {
1317
- "name": "Error",
1318
- "module": "src/utils/error.ts"
1319
- }
1320
- },
1321
- {
1322
- "kind": "class",
1323
- "description": "",
1324
- "name": "LayoutRegistrationError",
1325
- "superclass": {
1326
- "name": "Error",
1327
- "module": "src/utils/error.ts"
1328
- }
1329
- }
1330
- ],
1331
- "exports": [
1332
- {
1333
- "kind": "js",
1334
- "name": "LayoutUsageError",
1335
- "declaration": {
1336
- "name": "LayoutUsageError",
1337
- "module": "src/utils/error.ts"
1338
- }
1339
- },
1340
- {
1341
- "kind": "js",
1342
- "name": "LayoutRegistrationError",
1343
- "declaration": {
1344
- "name": "LayoutRegistrationError",
1345
- "module": "src/utils/error.ts"
1346
- }
1347
- }
1348
- ]
1349
- },
1350
- {
1351
- "kind": "javascript-module",
1352
- "path": "src/utils/events.ts",
1353
- "declarations": [
1354
- {
1355
- "kind": "variable",
1356
- "name": "LayoutEmitEvents",
1357
- "type": {
1358
- "text": "{\n firstLoaded: 'first-loaded',\n itemAdded: 'item-added',\n itemRemoved: 'item-removed',\n itemResized: 'item-resized',\n}"
1359
- },
1360
- "default": "{\n firstLoaded: 'first-loaded',\n itemAdded: 'item-added',\n itemRemoved: 'item-removed',\n itemResized: 'item-resized',\n}",
1361
- "description": "Defines events that the layout system emits\n\n'firstLoaded' - emitted when the layout has finished loading the first time\nusing the declarative API after DEFAULT_RELOAD_BUFFER ms.\n<br/>\n'itemAdded' - emitted when an item is added to the layout'\n<br/>\n'itemRemoved' - emitted when an item is removed from the layout'\n<br/>\n'itemResized' - emitted when the user drags the divider to resize elements",
1362
- "privacy": "public"
1363
- },
1364
- {
1365
- "kind": "variable",
1366
- "name": "LayoutReceiveEvents",
1367
- "type": {
1368
- "text": "{\n changeTitle: 'change-title',\n autosave: 'autosave',\n}"
1369
- },
1370
- "default": "{\n changeTitle: 'change-title',\n autosave: 'autosave',\n}",
1371
- "description": "Defines events that the layout system listens for\n\n'changeTitle' - emit this from a contained item to update the title of the window that contains it.\n'autosave' - emit this from a contained item to hint to the layout system that it should autosave the layout. A contained item should do this if it has just changed some state it would like to persist. See LayoutComponentWithState.",
1372
- "privacy": "public"
1373
- }
1374
- ],
1375
- "exports": [
1376
- {
1377
- "kind": "js",
1378
- "name": "LayoutEmitEvents",
1379
- "declaration": {
1380
- "name": "LayoutEmitEvents",
1381
- "module": "src/utils/events.ts"
1382
- }
1383
- },
1384
- {
1385
- "kind": "js",
1386
- "name": "LayoutReceiveEvents",
1387
- "declaration": {
1388
- "name": "LayoutReceiveEvents",
1389
- "module": "src/utils/events.ts"
1390
- }
1391
- }
1392
- ]
1393
- },
1394
- {
1395
- "kind": "javascript-module",
1396
- "path": "src/utils/index.ts",
1397
- "declarations": [],
1398
- "exports": [
1399
- {
1400
- "kind": "js",
1401
- "name": "*",
1402
- "declaration": {
1403
- "name": "*",
1404
- "package": "./constants"
1405
- }
1406
- },
1407
- {
1408
- "kind": "js",
1409
- "name": "*",
1410
- "declaration": {
1411
- "name": "*",
1412
- "package": "./error"
1413
- }
1414
- },
1415
- {
1416
- "kind": "js",
1417
- "name": "*",
1418
- "declaration": {
1419
- "name": "*",
1420
- "package": "./events"
1421
- }
1238
+ "attributes": [
1239
+ {
1240
+ "name": "reload-buffer",
1241
+ "type": {
1242
+ "text": "number"
1243
+ },
1244
+ "default": "DEFAULT_RELOAD_BUFFER",
1245
+ "description": "Number describing how long to wait in ms before reloading the config when adding items\ndeclaratively by the html API. Default 500 (ms).",
1246
+ "resolveInitializer": {
1247
+ "module": "/src/utils/"
1248
+ },
1249
+ "fieldName": "reloadBuffer"
1250
+ },
1251
+ {
1252
+ "name": "auto-save-key",
1253
+ "type": {
1254
+ "text": "string | undefined"
1255
+ },
1256
+ "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`.",
1257
+ "fieldName": "autoSaveKey"
1258
+ },
1259
+ {
1260
+ "name": "popout-config",
1261
+ "type": {
1262
+ "text": "string | undefined"
1263
+ },
1264
+ "default": "undefined",
1265
+ "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.",
1266
+ "resolveInitializer": {
1267
+ "module": "src/main/layout-main.ts"
1268
+ },
1269
+ "fieldName": "popoutConfig"
1270
+ }
1271
+ ],
1272
+ "superclass": {
1273
+ "name": "FoundationElement",
1274
+ "package": "@microsoft/fast-foundation"
1275
+ },
1276
+ "tagName": "%%prefix%%-layout",
1277
+ "customElement": true
1422
1278
  },
1423
1279
  {
1424
- "kind": "js",
1425
- "name": "*",
1426
- "declaration": {
1427
- "name": "*",
1428
- "package": "./misc"
1429
- }
1430
- },
1280
+ "kind": "variable",
1281
+ "name": "layoutTemplate",
1282
+ "default": "html<FoundationLayout>`\n <template>\n ${when((x) => !x.hasFirstLoaded && x.usingDeclerativeAPI, loadingTemplate)}\n <div class=\"layout-container\" ${ref('layoutElement')}></div>\n </template>\n`",
1283
+ "description": "`ViewTemplate` which defines the html for FoundationLayout.",
1284
+ "privacy": "public"
1285
+ }
1286
+ ],
1287
+ "exports": [
1431
1288
  {
1432
1289
  "kind": "js",
1433
- "name": "*",
1290
+ "name": "layoutStyles",
1434
1291
  "declaration": {
1435
- "name": "*",
1436
- "package": "./templates"
1292
+ "name": "layoutStyles",
1293
+ "module": "../styles"
1437
1294
  }
1438
1295
  },
1439
1296
  {
1440
1297
  "kind": "js",
1441
- "name": "*",
1298
+ "name": "FoundationLayout",
1442
1299
  "declaration": {
1443
- "name": "*",
1444
- "package": "./types"
1300
+ "name": "FoundationLayout",
1301
+ "module": "src/main/layout-main.ts"
1445
1302
  }
1446
1303
  },
1447
1304
  {
1448
1305
  "kind": "js",
1449
- "name": "*",
1306
+ "name": "layoutTemplate",
1450
1307
  "declaration": {
1451
- "name": "*",
1452
- "package": "./error"
1308
+ "name": "layoutTemplate",
1309
+ "module": "src/main/layout-main.ts"
1453
1310
  }
1454
1311
  }
1455
1312
  ]
1456
1313
  },
1457
1314
  {
1458
1315
  "kind": "javascript-module",
1459
- "path": "src/utils/logger.ts",
1316
+ "path": "src/main/layout-region.ts",
1460
1317
  "declarations": [
1461
1318
  {
1462
- "kind": "variable",
1463
- "name": "logger"
1319
+ "kind": "class",
1320
+ "description": "",
1321
+ "name": "FoundationLayoutRegion",
1322
+ "members": [
1323
+ {
1324
+ "kind": "field",
1325
+ "name": "size",
1326
+ "type": {
1327
+ "text": "string"
1328
+ },
1329
+ "description": "optional string describing the size of the new item (see the written documentation for more info)",
1330
+ "privacy": "public"
1331
+ },
1332
+ {
1333
+ "kind": "field",
1334
+ "name": "type",
1335
+ "type": {
1336
+ "text": "LayoutRegionType"
1337
+ },
1338
+ "default": "layoutRegionValue[0]",
1339
+ "description": "Defines the LayoutRegionType| type of the region.\nDefaults to `horizontal`.",
1340
+ "privacy": "public"
1341
+ },
1342
+ {
1343
+ "kind": "field",
1344
+ "name": "_presentation",
1345
+ "type": {
1346
+ "text": "ComponentPresentation | null | undefined"
1347
+ },
1348
+ "privacy": "private",
1349
+ "default": "void 0",
1350
+ "inheritedFrom": {
1351
+ "name": "FoundationElement",
1352
+ "module": "src/foundation-element/foundation-element.ts"
1353
+ }
1354
+ },
1355
+ {
1356
+ "kind": "field",
1357
+ "name": "$presentation",
1358
+ "type": {
1359
+ "text": "ComponentPresentation | null"
1360
+ },
1361
+ "privacy": "public",
1362
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
1363
+ "inheritedFrom": {
1364
+ "name": "FoundationElement",
1365
+ "module": "src/foundation-element/foundation-element.ts"
1366
+ }
1367
+ },
1368
+ {
1369
+ "kind": "field",
1370
+ "name": "template",
1371
+ "type": {
1372
+ "text": "ElementViewTemplate | void | null"
1373
+ },
1374
+ "privacy": "public",
1375
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
1376
+ "inheritedFrom": {
1377
+ "name": "FoundationElement",
1378
+ "module": "src/foundation-element/foundation-element.ts"
1379
+ }
1380
+ },
1381
+ {
1382
+ "kind": "method",
1383
+ "name": "templateChanged",
1384
+ "privacy": "protected",
1385
+ "return": {
1386
+ "type": {
1387
+ "text": "void"
1388
+ }
1389
+ },
1390
+ "inheritedFrom": {
1391
+ "name": "FoundationElement",
1392
+ "module": "src/foundation-element/foundation-element.ts"
1393
+ }
1394
+ },
1395
+ {
1396
+ "kind": "field",
1397
+ "name": "styles",
1398
+ "type": {
1399
+ "text": "ElementStyles | void | null"
1400
+ },
1401
+ "privacy": "public",
1402
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
1403
+ "inheritedFrom": {
1404
+ "name": "FoundationElement",
1405
+ "module": "src/foundation-element/foundation-element.ts"
1406
+ }
1407
+ },
1408
+ {
1409
+ "kind": "method",
1410
+ "name": "stylesChanged",
1411
+ "privacy": "protected",
1412
+ "return": {
1413
+ "type": {
1414
+ "text": "void"
1415
+ }
1416
+ },
1417
+ "inheritedFrom": {
1418
+ "name": "FoundationElement",
1419
+ "module": "src/foundation-element/foundation-element.ts"
1420
+ }
1421
+ },
1422
+ {
1423
+ "kind": "method",
1424
+ "name": "compose",
1425
+ "privacy": "public",
1426
+ "static": true,
1427
+ "return": {
1428
+ "type": {
1429
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
1430
+ }
1431
+ },
1432
+ "parameters": [
1433
+ {
1434
+ "name": "this",
1435
+ "type": {
1436
+ "text": "K"
1437
+ }
1438
+ },
1439
+ {
1440
+ "name": "elementDefinition",
1441
+ "type": {
1442
+ "text": "T"
1443
+ },
1444
+ "description": "The definition of the element to create the registry\nfunction for."
1445
+ }
1446
+ ],
1447
+ "description": "Defines an element registry function with a set of element definition defaults.",
1448
+ "inheritedFrom": {
1449
+ "name": "FoundationElement",
1450
+ "module": "src/foundation-element/foundation-element.ts"
1451
+ }
1452
+ }
1453
+ ],
1454
+ "attributes": [
1455
+ {
1456
+ "name": "size",
1457
+ "type": {
1458
+ "text": "string"
1459
+ },
1460
+ "description": "optional string describing the size of the new item (see the written documentation for more info)",
1461
+ "fieldName": "size"
1462
+ },
1463
+ {
1464
+ "name": "type",
1465
+ "type": {
1466
+ "text": "LayoutRegionType"
1467
+ },
1468
+ "default": "defaultLayoutType",
1469
+ "description": "Defines the LayoutRegionType| type of the region.\nDefaults to `horizontal`.",
1470
+ "resolveInitializer": {
1471
+ "module": "src/main/layout-region.ts"
1472
+ },
1473
+ "fieldName": "type"
1474
+ }
1475
+ ],
1476
+ "superclass": {
1477
+ "name": "FoundationElement",
1478
+ "package": "@microsoft/fast-foundation"
1479
+ },
1480
+ "tagName": "%%prefix%%-layout-region",
1481
+ "customElement": true
1464
1482
  }
1465
1483
  ],
1466
1484
  "exports": [
1467
1485
  {
1468
1486
  "kind": "js",
1469
- "name": "logger",
1487
+ "name": "FoundationLayoutRegion",
1470
1488
  "declaration": {
1471
- "name": "logger",
1472
- "module": "src/utils/logger.ts"
1489
+ "name": "FoundationLayoutRegion",
1490
+ "module": "src/main/layout-region.ts"
1473
1491
  }
1474
1492
  }
1475
1493
  ]
1476
- },
1477
- {
1478
- "kind": "javascript-module",
1479
- "path": "src/utils/misc.ts",
1480
- "declarations": [],
1481
- "exports": []
1482
- },
1483
- {
1484
- "kind": "javascript-module",
1485
- "path": "src/utils/templates.ts",
1486
- "declarations": [],
1487
- "exports": []
1488
- },
1489
- {
1490
- "kind": "javascript-module",
1491
- "path": "src/utils/types.ts",
1492
- "declarations": [],
1493
- "exports": []
1494
1494
  }
1495
1495
  ]
1496
1496
  }