@genesislcap/foundation-layout 14.102.0 → 14.103.0

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 +974 -974
  2. package/package.json +7 -7
package/dist/custom-elements.json CHANGED
@@ -137,47 +137,87 @@
137
137
  },
138
138
  {
139
139
  "kind": "javascript-module",
140
- "path": "src/main/index.ts",
141
- "declarations": [],
140
+ "path": "src/styles/constants.ts",
141
+ "declarations": [
142
+ {
143
+ "kind": "variable",
144
+ "name": "glVisualConfig",
145
+ "type": {
146
+ "text": "Omit<LayoutConfig, 'root'>"
147
+ },
148
+ "default": "{\n dimensions: {\n headerHeight: 38,\n borderWidth: 12,\n },\n header: {\n maximise: 'maximise',\n minimise: 'minimise',\n popout: false,\n },\n}"
149
+ },
150
+ {
151
+ "kind": "variable",
152
+ "name": "LAYOUT_ICONS",
153
+ "type": {
154
+ "text": "{\n renameSVG,\n maximiseSVG,\n minimiseSVG,\n closeSVG,\n tabDropdownSVG,\n}"
155
+ },
156
+ "default": "{\n renameSVG,\n maximiseSVG,\n minimiseSVG,\n closeSVG,\n tabDropdownSVG,\n}",
157
+ "description": "A collection of SVG icons in base64 format.",
158
+ "privacy": "public"
159
+ }
160
+ ],
142
161
  "exports": [
143
162
  {
144
163
  "kind": "js",
145
- "name": "FoundationLayoutItem",
164
+ "name": "glVisualConfig",
146
165
  "declaration": {
147
- "name": "FoundationLayoutItem",
148
- "module": "./layout-item"
166
+ "name": "glVisualConfig",
167
+ "module": "src/styles/constants.ts"
149
168
  }
150
169
  },
151
170
  {
152
171
  "kind": "js",
153
- "name": "FoundationLayoutRegion",
172
+ "name": "LAYOUT_ICONS",
154
173
  "declaration": {
155
- "name": "FoundationLayoutRegion",
156
- "module": "./layout-region"
174
+ "name": "LAYOUT_ICONS",
175
+ "module": "src/styles/constants.ts"
157
176
  }
158
- },
177
+ }
178
+ ]
179
+ },
180
+ {
181
+ "kind": "javascript-module",
182
+ "path": "src/styles/dragging.styles.ts",
183
+ "declarations": [
184
+ {
185
+ "kind": "variable",
186
+ "name": "globalDraggingStyles",
187
+ "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 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`",
188
+ "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"
189
+ }
190
+ ],
191
+ "exports": [
159
192
  {
160
193
  "kind": "js",
161
- "name": "FoundationLayout",
194
+ "name": "globalDraggingStyles",
162
195
  "declaration": {
163
- "name": "FoundationLayout",
164
- "module": "./layout-main"
196
+ "name": "globalDraggingStyles",
197
+ "module": "src/styles/dragging.styles.ts"
165
198
  }
166
- },
199
+ }
200
+ ]
201
+ },
202
+ {
203
+ "kind": "javascript-module",
204
+ "path": "src/styles/index.ts",
205
+ "declarations": [],
206
+ "exports": [
167
207
  {
168
208
  "kind": "js",
169
- "name": "layoutStyles",
209
+ "name": "*",
170
210
  "declaration": {
171
- "name": "layoutStyles",
172
- "module": "./layout-main"
211
+ "name": "*",
212
+ "package": "./constants"
173
213
  }
174
214
  },
175
215
  {
176
216
  "kind": "js",
177
- "name": "layoutTemplate",
217
+ "name": "*",
178
218
  "declaration": {
179
- "name": "layoutTemplate",
180
- "module": "./layout-main"
219
+ "name": "*",
220
+ "package": "./dragging.styles"
181
221
  }
182
222
  },
183
223
  {
@@ -185,1220 +225,1180 @@
185
225
  "name": "*",
186
226
  "declaration": {
187
227
  "name": "*",
188
- "package": "./layout-components"
228
+ "package": "./layout.styles"
189
229
  }
190
230
  }
191
231
  ]
192
232
  },
193
233
  {
194
234
  "kind": "javascript-module",
195
- "path": "src/main/layout-components.ts",
235
+ "path": "src/styles/layout.styles.ts",
196
236
  "declarations": [
197
237
  {
198
238
  "kind": "variable",
199
- "name": "foundationLayoutComponents",
239
+ "name": "layoutStyles",
240
+ "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;\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;\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 }\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`",
241
+ "description": "`ElementStyles` which defines the css for FoundationLayout.",
242
+ "privacy": "public"
243
+ }
244
+ ],
245
+ "exports": [
246
+ {
247
+ "kind": "js",
248
+ "name": "layoutStyles",
249
+ "declaration": {
250
+ "name": "layoutStyles",
251
+ "module": "src/styles/layout.styles.ts"
252
+ }
253
+ }
254
+ ]
255
+ },
256
+ {
257
+ "kind": "javascript-module",
258
+ "path": "src/utils/constants.ts",
259
+ "declarations": [
260
+ {
261
+ "kind": "variable",
262
+ "name": "DEFAULT_RELOAD_BUFFER",
200
263
  "type": {
201
- "text": "object"
264
+ "text": "number"
202
265
  },
203
- "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}",
204
- "description": "Registration object to register the layout with your design system.",
266
+ "default": "500",
267
+ "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.",
205
268
  "privacy": "public"
206
269
  }
207
270
  ],
208
271
  "exports": [
209
272
  {
210
273
  "kind": "js",
211
- "name": "foundationLayoutComponents",
274
+ "name": "DEFAULT_RELOAD_BUFFER",
212
275
  "declaration": {
213
- "name": "foundationLayoutComponents",
214
- "module": "src/main/layout-components.ts"
276
+ "name": "DEFAULT_RELOAD_BUFFER",
277
+ "module": "src/utils/constants.ts"
215
278
  }
216
279
  }
217
280
  ]
218
281
  },
219
282
  {
220
283
  "kind": "javascript-module",
221
- "path": "src/main/layout-item.ts",
284
+ "path": "src/utils/error.ts",
222
285
  "declarations": [
223
286
  {
224
287
  "kind": "class",
225
288
  "description": "",
226
- "name": "FoundationLayoutItem",
227
- "members": [
228
- {
229
- "kind": "field",
230
- "name": "title",
231
- "type": {
232
- "text": "string"
233
- },
234
- "description": "Sets the title of the item which is displayed on the tab.",
235
- "privacy": "public"
236
- },
237
- {
238
- "kind": "field",
239
- "name": "closable",
240
- "type": {
241
- "text": "boolean"
242
- },
243
- "default": "false",
244
- "description": "Boolean attribute controls whether the window can be closed in the GUI.\nDefaults to `false`.",
245
- "privacy": "public"
246
- },
247
- {
248
- "kind": "field",
249
- "name": "size",
250
- "type": {
251
- "text": "string"
252
- },
253
- "description": "optional string describing the size of the new item (see the written documentation for more info)",
254
- "privacy": "public"
255
- },
256
- {
257
- "kind": "field",
258
- "name": "registration",
259
- "type": {
260
- "text": "string"
261
- },
262
- "description": "Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem.",
263
- "privacy": "public"
264
- },
265
- {
266
- "kind": "field",
267
- "name": "_presentation",
268
- "type": {
269
- "text": "ComponentPresentation | null | undefined"
270
- },
271
- "privacy": "private",
272
- "default": "void 0",
273
- "inheritedFrom": {
274
- "name": "FoundationElement",
275
- "module": "src/foundation-element/foundation-element.ts"
276
- }
277
- },
278
- {
279
- "kind": "field",
280
- "name": "$presentation",
281
- "type": {
282
- "text": "ComponentPresentation | null"
283
- },
284
- "privacy": "public",
285
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
286
- "inheritedFrom": {
287
- "name": "FoundationElement",
288
- "module": "src/foundation-element/foundation-element.ts"
289
- }
290
- },
291
- {
292
- "kind": "field",
293
- "name": "template",
294
- "type": {
295
- "text": "ElementViewTemplate | void | null"
296
- },
297
- "privacy": "public",
298
- "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.",
299
- "inheritedFrom": {
300
- "name": "FoundationElement",
301
- "module": "src/foundation-element/foundation-element.ts"
302
- }
303
- },
304
- {
305
- "kind": "method",
306
- "name": "templateChanged",
307
- "privacy": "protected",
308
- "return": {
309
- "type": {
310
- "text": "void"
311
- }
312
- },
313
- "inheritedFrom": {
314
- "name": "FoundationElement",
315
- "module": "src/foundation-element/foundation-element.ts"
316
- }
317
- },
318
- {
319
- "kind": "field",
320
- "name": "styles",
321
- "type": {
322
- "text": "ElementStyles | void | null"
323
- },
324
- "privacy": "public",
325
- "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.",
326
- "inheritedFrom": {
327
- "name": "FoundationElement",
328
- "module": "src/foundation-element/foundation-element.ts"
329
- }
330
- },
331
- {
332
- "kind": "method",
333
- "name": "stylesChanged",
334
- "privacy": "protected",
335
- "return": {
336
- "type": {
337
- "text": "void"
338
- }
339
- },
340
- "inheritedFrom": {
341
- "name": "FoundationElement",
342
- "module": "src/foundation-element/foundation-element.ts"
343
- }
344
- },
345
- {
346
- "kind": "method",
347
- "name": "compose",
348
- "privacy": "public",
349
- "static": true,
350
- "return": {
351
- "type": {
352
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
353
- }
354
- },
355
- "parameters": [
356
- {
357
- "name": "this",
358
- "type": {
359
- "text": "K"
360
- }
361
- },
362
- {
363
- "name": "elementDefinition",
364
- "type": {
365
- "text": "T"
366
- },
367
- "description": "The definition of the element to create the registry\nfunction for."
368
- }
369
- ],
370
- "description": "Defines an element registry function with a set of element definition defaults.",
371
- "inheritedFrom": {
372
- "name": "FoundationElement",
373
- "module": "src/foundation-element/foundation-element.ts"
374
- }
375
- }
376
- ],
377
- "attributes": [
378
- {
379
- "name": "title",
380
- "type": {
381
- "text": "string"
382
- },
383
- "description": "Sets the title of the item which is displayed on the tab.",
384
- "fieldName": "title"
385
- },
386
- {
387
- "type": {
388
- "text": "boolean"
389
- },
390
- "default": "false",
391
- "description": "Boolean attribute controls whether the window can be closed in the GUI.\nDefaults to `false`.",
392
- "fieldName": "closable"
393
- },
394
- {
395
- "name": "size",
396
- "type": {
397
- "text": "string"
398
- },
399
- "description": "optional string describing the size of the new item (see the written documentation for more info)",
400
- "fieldName": "size"
401
- },
402
- {
403
- "name": "registration",
404
- "type": {
405
- "text": "string"
406
- },
407
- "description": "Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem.",
408
- "fieldName": "registration"
409
- }
410
- ],
289
+ "name": "LayoutUsageError",
411
290
  "superclass": {
412
- "name": "FoundationElement",
413
- "package": "@microsoft/fast-foundation"
291
+ "name": "Error",
292
+ "module": "src/utils/error.ts"
293
+ }
294
+ },
295
+ {
296
+ "kind": "class",
297
+ "description": "",
298
+ "name": "LayoutRegistrationError",
299
+ "superclass": {
300
+ "name": "Error",
301
+ "module": "src/utils/error.ts"
302
+ }
303
+ }
304
+ ],
305
+ "exports": [
306
+ {
307
+ "kind": "js",
308
+ "name": "LayoutUsageError",
309
+ "declaration": {
310
+ "name": "LayoutUsageError",
311
+ "module": "src/utils/error.ts"
312
+ }
313
+ },
314
+ {
315
+ "kind": "js",
316
+ "name": "LayoutRegistrationError",
317
+ "declaration": {
318
+ "name": "LayoutRegistrationError",
319
+ "module": "src/utils/error.ts"
320
+ }
321
+ }
322
+ ]
323
+ },
324
+ {
325
+ "kind": "javascript-module",
326
+ "path": "src/utils/events.ts",
327
+ "declarations": [
328
+ {
329
+ "kind": "variable",
330
+ "name": "LayoutEmitEvents",
331
+ "type": {
332
+ "text": "{\n firstLoaded: 'first-loaded',\n itemAdded: 'item-added',\n itemRemoved: 'item-removed',\n itemResized: 'item-resized',\n}"
414
333
  },
415
- "tagName": "%%prefix%%-layout-item",
416
- "customElement": true
334
+ "default": "{\n firstLoaded: 'first-loaded',\n itemAdded: 'item-added',\n itemRemoved: 'item-removed',\n itemResized: 'item-resized',\n}",
335
+ "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",
336
+ "privacy": "public"
337
+ },
338
+ {
339
+ "kind": "variable",
340
+ "name": "LayoutReceiveEvents",
341
+ "type": {
342
+ "text": "{\n changeTitle: 'change-title',\n autosave: 'autosave',\n}"
343
+ },
344
+ "default": "{\n changeTitle: 'change-title',\n autosave: 'autosave',\n}",
345
+ "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.",
346
+ "privacy": "public"
417
347
  }
418
348
  ],
419
349
  "exports": [
420
350
  {
421
351
  "kind": "js",
422
- "name": "FoundationLayoutItem",
352
+ "name": "LayoutEmitEvents",
423
353
  "declaration": {
424
- "name": "FoundationLayoutItem",
425
- "module": "src/main/layout-item.ts"
354
+ "name": "LayoutEmitEvents",
355
+ "module": "src/utils/events.ts"
356
+ }
357
+ },
358
+ {
359
+ "kind": "js",
360
+ "name": "LayoutReceiveEvents",
361
+ "declaration": {
362
+ "name": "LayoutReceiveEvents",
363
+ "module": "src/utils/events.ts"
426
364
  }
427
365
  }
428
366
  ]
429
367
  },
430
368
  {
431
369
  "kind": "javascript-module",
432
- "path": "src/main/layout-main.ts",
370
+ "path": "src/utils/index.ts",
371
+ "declarations": [],
372
+ "exports": [
373
+ {
374
+ "kind": "js",
375
+ "name": "*",
376
+ "declaration": {
377
+ "name": "*",
378
+ "package": "./constants"
379
+ }
380
+ },
381
+ {
382
+ "kind": "js",
383
+ "name": "*",
384
+ "declaration": {
385
+ "name": "*",
386
+ "package": "./error"
387
+ }
388
+ },
389
+ {
390
+ "kind": "js",
391
+ "name": "*",
392
+ "declaration": {
393
+ "name": "*",
394
+ "package": "./events"
395
+ }
396
+ },
397
+ {
398
+ "kind": "js",
399
+ "name": "*",
400
+ "declaration": {
401
+ "name": "*",
402
+ "package": "./misc"
403
+ }
404
+ },
405
+ {
406
+ "kind": "js",
407
+ "name": "*",
408
+ "declaration": {
409
+ "name": "*",
410
+ "package": "./templates"
411
+ }
412
+ },
413
+ {
414
+ "kind": "js",
415
+ "name": "*",
416
+ "declaration": {
417
+ "name": "*",
418
+ "package": "./types"
419
+ }
420
+ },
421
+ {
422
+ "kind": "js",
423
+ "name": "*",
424
+ "declaration": {
425
+ "name": "*",
426
+ "package": "./error"
427
+ }
428
+ }
429
+ ]
430
+ },
431
+ {
432
+ "kind": "javascript-module",
433
+ "path": "src/utils/logger.ts",
433
434
  "declarations": [
434
435
  {
435
- "kind": "class",
436
- "description": "",
436
+ "kind": "variable",
437
+ "name": "logger"
438
+ }
439
+ ],
440
+ "exports": [
441
+ {
442
+ "kind": "js",
443
+ "name": "logger",
444
+ "declaration": {
445
+ "name": "logger",
446
+ "module": "src/utils/logger.ts"
447
+ }
448
+ }
449
+ ]
450
+ },
451
+ {
452
+ "kind": "javascript-module",
453
+ "path": "src/utils/misc.ts",
454
+ "declarations": [],
455
+ "exports": []
456
+ },
457
+ {
458
+ "kind": "javascript-module",
459
+ "path": "src/utils/templates.ts",
460
+ "declarations": [],
461
+ "exports": []
462
+ },
463
+ {
464
+ "kind": "javascript-module",
465
+ "path": "src/utils/types.ts",
466
+ "declarations": [],
467
+ "exports": []
468
+ },
469
+ {
470
+ "kind": "javascript-module",
471
+ "path": "src/main/index.ts",
472
+ "declarations": [],
473
+ "exports": [
474
+ {
475
+ "kind": "js",
476
+ "name": "FoundationLayoutItem",
477
+ "declaration": {
478
+ "name": "FoundationLayoutItem",
479
+ "module": "./layout-item"
480
+ }
481
+ },
482
+ {
483
+ "kind": "js",
484
+ "name": "FoundationLayoutRegion",
485
+ "declaration": {
486
+ "name": "FoundationLayoutRegion",
487
+ "module": "./layout-region"
488
+ }
489
+ },
490
+ {
491
+ "kind": "js",
437
492
  "name": "FoundationLayout",
438
- "members": [
439
- {
440
- "kind": "field",
441
- "name": "layout",
442
- "type": {
443
- "text": "GoldenLayout"
444
- },
445
- "privacy": "private"
446
- },
447
- {
448
- "kind": "field",
449
- "name": "layoutConfig",
450
- "type": {
451
- "text": "LayoutConfig"
452
- },
453
- "privacy": "private",
454
- "default": "{ root: undefined }"
455
- },
493
+ "declaration": {
494
+ "name": "FoundationLayout",
495
+ "module": "./layout-main"
496
+ }
497
+ },
498
+ {
499
+ "kind": "js",
500
+ "name": "layoutStyles",
501
+ "declaration": {
502
+ "name": "layoutStyles",
503
+ "module": "./layout-main"
504
+ }
505
+ },
506
+ {
507
+ "kind": "js",
508
+ "name": "layoutTemplate",
509
+ "declaration": {
510
+ "name": "layoutTemplate",
511
+ "module": "./layout-main"
512
+ }
513
+ },
514
+ {
515
+ "kind": "js",
516
+ "name": "*",
517
+ "declaration": {
518
+ "name": "*",
519
+ "package": "./layout-components"
520
+ }
521
+ }
522
+ ]
523
+ },
524
+ {
525
+ "kind": "javascript-module",
526
+ "path": "src/main/layout-components.ts",
527
+ "declarations": [
528
+ {
529
+ "kind": "variable",
530
+ "name": "foundationLayoutComponents",
531
+ "type": {
532
+ "text": "object"
533
+ },
534
+ "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}",
535
+ "description": "Registration object to register the layout with your design system.",
536
+ "privacy": "public"
537
+ }
538
+ ],
539
+ "exports": [
540
+ {
541
+ "kind": "js",
542
+ "name": "foundationLayoutComponents",
543
+ "declaration": {
544
+ "name": "foundationLayoutComponents",
545
+ "module": "src/main/layout-components.ts"
546
+ }
547
+ }
548
+ ]
549
+ },
550
+ {
551
+ "kind": "javascript-module",
552
+ "path": "src/main/layout-item.ts",
553
+ "declarations": [
554
+ {
555
+ "kind": "class",
556
+ "description": "",
557
+ "name": "FoundationLayoutItem",
558
+ "members": [
456
559
  {
457
560
  "kind": "field",
458
- "name": "reloadBuffer",
561
+ "name": "title",
459
562
  "type": {
460
- "text": "number"
563
+ "text": "string"
461
564
  },
462
- "default": "DEFAULT_RELOAD_BUFFER",
463
- "description": "Number describing how long to wait in ms before reloading the config when adding items\ndeclaratively by the html API. Default 500 (ms).",
565
+ "description": "Sets the title of the item which is displayed on the tab.",
464
566
  "privacy": "public"
465
567
  },
466
568
  {
467
569
  "kind": "field",
468
- "name": "reloadPending",
570
+ "name": "closable",
469
571
  "type": {
470
572
  "text": "boolean"
471
573
  },
472
- "privacy": "private",
473
- "default": "false"
474
- },
475
- {
476
- "kind": "field",
477
- "name": "registeredComponents",
478
- "type": {
479
- "text": "number"
480
- },
481
- "privacy": "private",
482
- "default": "0"
483
- },
484
- {
485
- "kind": "field",
486
- "name": "autoSaveKey",
487
- "type": {
488
- "text": "string | undefined"
489
- },
490
- "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`.",
491
- "privacy": "public"
492
- },
493
- {
494
- "kind": "field",
495
- "name": "missingItemPlaceholder",
496
- "description": "Function which is used to generate the placeholder text when a layout is loaded\nwith a missing item.",
574
+ "default": "false",
575
+ "description": "Boolean attribute controls whether the window can be closed in the GUI.\nDefaults to `false`.",
497
576
  "privacy": "public"
498
577
  },
499
578
  {
500
579
  "kind": "field",
501
- "name": "dimensionsConfig",
580
+ "name": "size",
502
581
  "type": {
503
- "text": "LayoutConfig.Dimensions | undefined"
582
+ "text": "string"
504
583
  },
505
- "description": "Apply dimensions config to the layout, such as setting the size of the drag handles.",
584
+ "description": "optional string describing the size of the new item (see the written documentation for more info)",
506
585
  "privacy": "public"
507
586
  },
508
587
  {
509
588
  "kind": "field",
510
- "name": "hasFirstLoaded",
589
+ "name": "registration",
511
590
  "type": {
512
- "text": "boolean"
591
+ "text": "string"
513
592
  },
514
- "default": "false",
515
- "description": "Boolean signifies whether the layout has loaded for the first time or not.",
593
+ "description": "Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem.",
516
594
  "privacy": "public"
517
595
  },
518
596
  {
519
597
  "kind": "field",
520
- "name": "customButtons",
598
+ "name": "_presentation",
521
599
  "type": {
522
- "text": "CustomButton[]"
600
+ "text": "ComponentPresentation | null | undefined"
523
601
  },
524
- "description": "Set custom button definition on this property to add them to the layout header controls",
525
- "privacy": "public"
602
+ "privacy": "private",
603
+ "default": "void 0",
604
+ "inheritedFrom": {
605
+ "name": "FoundationElement",
606
+ "module": "src/foundation-element/foundation-element.ts"
607
+ }
526
608
  },
527
609
  {
528
610
  "kind": "field",
529
- "name": "dragging",
611
+ "name": "$presentation",
530
612
  "type": {
531
- "text": "boolean"
613
+ "text": "ComponentPresentation | null"
532
614
  },
533
- "default": "false",
534
- "privacy": "public"
535
- },
536
- {
537
- "kind": "field",
538
- "name": "class",
539
615
  "privacy": "public",
540
- "default": "'FoundationLayoutMain'",
541
- "type": {
542
- "text": "'FoundationLayoutMain'"
616
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
617
+ "inheritedFrom": {
618
+ "name": "FoundationElement",
619
+ "module": "src/foundation-element/foundation-element.ts"
543
620
  }
544
621
  },
545
622
  {
546
623
  "kind": "field",
547
- "name": "lifecycleUpdateToken",
624
+ "name": "template",
548
625
  "type": {
549
- "text": "string | undefined"
626
+ "text": "ElementViewTemplate | void | null"
550
627
  },
551
628
  "privacy": "public",
552
- "default": "undefined",
553
- "description": "Used to calculate whether a layout item should run its lifecycle methods or not"
629
+ "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.",
630
+ "inheritedFrom": {
631
+ "name": "FoundationElement",
632
+ "module": "src/foundation-element/foundation-element.ts"
633
+ }
554
634
  },
555
635
  {
556
636
  "kind": "method",
557
- "name": "layoutRequiredRegistrations",
558
- "static": true,
637
+ "name": "templateChanged",
638
+ "privacy": "protected",
559
639
  "return": {
560
640
  "type": {
561
- "text": ""
641
+ "text": "void"
562
642
  }
563
643
  },
564
- "parameters": [
565
- {
566
- "name": "layout",
567
- "type": {
568
- "text": "SerialisedLayout"
569
- },
570
- "description": "any version of {@link SerialisedLayout}object describing the layout\n * "
571
- }
572
- ],
573
- "description": "JS API, public",
574
- "privacy": "public"
644
+ "inheritedFrom": {
645
+ "name": "FoundationElement",
646
+ "module": "src/foundation-element/foundation-element.ts"
647
+ }
575
648
  },
576
649
  {
577
- "kind": "method",
578
- "name": "registeredItems",
579
- "return": {
580
- "type": {
581
- "text": ""
582
- }
650
+ "kind": "field",
651
+ "name": "styles",
652
+ "type": {
653
+ "text": "ElementStyles | void | null"
583
654
  },
584
- "privacy": "public"
655
+ "privacy": "public",
656
+ "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.",
657
+ "inheritedFrom": {
658
+ "name": "FoundationElement",
659
+ "module": "src/foundation-element/foundation-element.ts"
660
+ }
585
661
  },
586
662
  {
587
663
  "kind": "method",
588
- "name": "getLayout",
664
+ "name": "stylesChanged",
665
+ "privacy": "protected",
589
666
  "return": {
590
667
  "type": {
591
- "text": ""
668
+ "text": "void"
592
669
  }
593
670
  },
594
- "privacy": "public"
671
+ "inheritedFrom": {
672
+ "name": "FoundationElement",
673
+ "module": "src/foundation-element/foundation-element.ts"
674
+ }
595
675
  },
596
676
  {
597
677
  "kind": "method",
598
- "name": "tryLoadLayoutFromLocalStorage",
678
+ "name": "compose",
679
+ "privacy": "public",
680
+ "static": true,
599
681
  "return": {
600
682
  "type": {
601
- "text": ""
683
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
602
684
  }
603
685
  },
604
- "description": "Try to load a layout from local storage, or return false. Only required if manually calling FoundationLayout.registerItem",
605
- "privacy": "public"
606
- },
607
- {
608
- "kind": "method",
609
- "name": "loadLayout",
610
686
  "parameters": [
611
687
  {
612
- "name": "layout",
613
- "type": {
614
- "text": "SerialisedLayout"
615
- },
616
- "description": "any version of {@link SerialisedLayout}object describing the layout\n * "
617
- },
618
- {
619
- "name": "handleMissingItem",
620
- "default": "'error'",
688
+ "name": "this",
621
689
  "type": {
622
- "text": "'placeholder' | 'error'"
623
- },
624
- "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 * "
690
+ "text": "K"
691
+ }
625
692
  },
626
693
  {
627
- "name": "disableCache",
628
- "default": "false",
694
+ "name": "elementDefinition",
629
695
  "type": {
630
- "text": "boolean"
696
+ "text": "T"
631
697
  },
632
- "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 * "
698
+ "description": "The definition of the element to create the registry\nfunction for."
633
699
  }
634
700
  ],
635
- "privacy": "public"
636
- },
701
+ "description": "Defines an element registry function with a set of element definition defaults.",
702
+ "inheritedFrom": {
703
+ "name": "FoundationElement",
704
+ "module": "src/foundation-element/foundation-element.ts"
705
+ }
706
+ }
707
+ ],
708
+ "attributes": [
637
709
  {
638
- "kind": "method",
639
- "name": "addItem",
640
- "parameters": [
641
- {
642
- "name": "config",
643
- "type": {
644
- "text": "RegisteredElementConfig | RegisteredElementConfig[]"
645
- },
646
- "description": "{@link RegisteredElementConfig}configuration items for the new items(s). Pass an array of {@link RegisteredElementConfig}to add multiple items at once.\n * "
647
- },
648
- {
649
- "name": "placement",
650
- "default": "defaultAddItemPlacement",
651
- "type": {
652
- "text": "Placement"
653
- },
654
- "description": "where and how to add the new items to the layout. For more info and defaults see {@link Placement}.\n * "
655
- }
656
- ],
657
- "privacy": "public"
658
- },
659
- {
660
- "kind": "method",
661
- "name": "registerItem",
662
- "return": {
663
- "type": {
664
- "text": ""
665
- }
666
- },
667
- "parameters": [
668
- {
669
- "name": "registration",
670
- "type": {
671
- "text": "string"
672
- },
673
- "description": "string of the registration ID"
674
- },
675
- {
676
- "name": "elements",
677
- "type": {
678
- "text": "Element[]"
679
- },
680
- "description": "Elements[] containing the reference to the elements to register for later usage"
681
- }
682
- ],
683
- "privacy": "public"
684
- },
685
- {
686
- "kind": "method",
687
- "name": "updateLifecycleToken",
688
- "privacy": "private",
689
- "return": {
690
- "type": {
691
- "text": "void"
692
- }
693
- },
694
- "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"
695
- },
696
- {
697
- "kind": "method",
698
- "name": "removeConfigCacheInformation",
699
- "privacy": "private",
700
- "return": {
701
- "type": {
702
- "text": "LayoutConfig"
703
- }
704
- },
705
- "parameters": [
706
- {
707
- "name": "config",
708
- "type": {
709
- "text": "LayoutConfig"
710
- }
711
- }
712
- ],
713
- "description": "Recursively remove the instance key from the config which will mean that when the config is loaded it will instantiate a new instance for every item, even if they're in the cache."
714
- },
715
- {
716
- "kind": "field",
717
- "name": "_presentation",
718
- "type": {
719
- "text": "ComponentPresentation | null | undefined"
720
- },
721
- "privacy": "private",
722
- "default": "void 0",
723
- "inheritedFrom": {
724
- "name": "FoundationElement",
725
- "module": "src/foundation-element/foundation-element.ts"
726
- }
727
- },
728
- {
729
- "kind": "field",
730
- "name": "$presentation",
731
- "type": {
732
- "text": "ComponentPresentation | null"
733
- },
734
- "privacy": "public",
735
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
736
- "inheritedFrom": {
737
- "name": "FoundationElement",
738
- "module": "src/foundation-element/foundation-element.ts"
739
- }
740
- },
741
- {
742
- "kind": "field",
743
- "name": "template",
710
+ "name": "title",
744
711
  "type": {
745
- "text": "ElementViewTemplate | void | null"
746
- },
747
- "privacy": "public",
748
- "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.",
749
- "inheritedFrom": {
750
- "name": "FoundationElement",
751
- "module": "src/foundation-element/foundation-element.ts"
752
- }
753
- },
754
- {
755
- "kind": "method",
756
- "name": "templateChanged",
757
- "privacy": "protected",
758
- "return": {
759
- "type": {
760
- "text": "void"
761
- }
712
+ "text": "string"
762
713
  },
763
- "inheritedFrom": {
764
- "name": "FoundationElement",
765
- "module": "src/foundation-element/foundation-element.ts"
766
- }
714
+ "description": "Sets the title of the item which is displayed on the tab.",
715
+ "fieldName": "title"
767
716
  },
768
717
  {
769
- "kind": "field",
770
- "name": "styles",
771
718
  "type": {
772
- "text": "ElementStyles | void | null"
773
- },
774
- "privacy": "public",
775
- "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.",
776
- "inheritedFrom": {
777
- "name": "FoundationElement",
778
- "module": "src/foundation-element/foundation-element.ts"
779
- }
780
- },
781
- {
782
- "kind": "method",
783
- "name": "stylesChanged",
784
- "privacy": "protected",
785
- "return": {
786
- "type": {
787
- "text": "void"
788
- }
719
+ "text": "boolean"
789
720
  },
790
- "inheritedFrom": {
791
- "name": "FoundationElement",
792
- "module": "src/foundation-element/foundation-element.ts"
793
- }
721
+ "default": "false",
722
+ "description": "Boolean attribute controls whether the window can be closed in the GUI.\nDefaults to `false`.",
723
+ "fieldName": "closable"
794
724
  },
795
725
  {
796
- "kind": "method",
797
- "name": "compose",
798
- "privacy": "public",
799
- "static": true,
800
- "return": {
801
- "type": {
802
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
803
- }
804
- },
805
- "parameters": [
806
- {
807
- "name": "this",
808
- "type": {
809
- "text": "K"
810
- }
811
- },
812
- {
813
- "name": "elementDefinition",
814
- "type": {
815
- "text": "T"
816
- },
817
- "description": "The definition of the element to create the registry\nfunction for."
818
- }
819
- ],
820
- "description": "Defines an element registry function with a set of element definition defaults.",
821
- "inheritedFrom": {
822
- "name": "FoundationElement",
823
- "module": "src/foundation-element/foundation-element.ts"
824
- }
825
- }
826
- ],
827
- "attributes": [
828
- {
829
- "name": "reload-buffer",
726
+ "name": "size",
830
727
  "type": {
831
- "text": "number"
832
- },
833
- "default": "DEFAULT_RELOAD_BUFFER",
834
- "description": "Number describing how long to wait in ms before reloading the config when adding items\ndeclaratively by the html API. Default 500 (ms).",
835
- "resolveInitializer": {
836
- "module": "/src/utils/"
728
+ "text": "string"
837
729
  },
838
- "fieldName": "reloadBuffer"
730
+ "description": "optional string describing the size of the new item (see the written documentation for more info)",
731
+ "fieldName": "size"
839
732
  },
840
733
  {
841
- "name": "auto-save-key",
734
+ "name": "registration",
842
735
  "type": {
843
- "text": "string | undefined"
736
+ "text": "string"
844
737
  },
845
- "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`.",
846
- "fieldName": "autoSaveKey"
738
+ "description": "Sets the registration name for the item, which can be used later to add the item via the JavaScript API using FoundationLayout.addItem.",
739
+ "fieldName": "registration"
847
740
  }
848
741
  ],
849
742
  "superclass": {
850
743
  "name": "FoundationElement",
851
744
  "package": "@microsoft/fast-foundation"
852
745
  },
853
- "tagName": "%%prefix%%-layout",
746
+ "tagName": "%%prefix%%-layout-item",
854
747
  "customElement": true
855
- },
856
- {
857
- "kind": "variable",
858
- "name": "layoutTemplate",
859
- "default": "html<FoundationLayout>`\n <template>\n ${when((x) => !x.hasFirstLoaded && x.usingDeclerativeAPI, loadingTemplate)}\n <div class=\"layout-container\" ${ref('layoutElement')}></div>\n </template>\n`",
860
- "description": "`ViewTemplate` which defines the html for FoundationLayout.",
861
- "privacy": "public"
862
748
  }
863
749
  ],
864
750
  "exports": [
865
751
  {
866
752
  "kind": "js",
867
- "name": "layoutStyles",
868
- "declaration": {
869
- "name": "layoutStyles",
870
- "module": "../styles"
871
- }
872
- },
873
- {
874
- "kind": "js",
875
- "name": "FoundationLayout",
876
- "declaration": {
877
- "name": "FoundationLayout",
878
- "module": "src/main/layout-main.ts"
879
- }
880
- },
881
- {
882
- "kind": "js",
883
- "name": "layoutTemplate",
753
+ "name": "FoundationLayoutItem",
884
754
  "declaration": {
885
- "name": "layoutTemplate",
886
- "module": "src/main/layout-main.ts"
755
+ "name": "FoundationLayoutItem",
756
+ "module": "src/main/layout-item.ts"
887
757
  }
888
758
  }
889
759
  ]
890
760
  },
891
761
  {
892
762
  "kind": "javascript-module",
893
- "path": "src/main/layout-region.ts",
763
+ "path": "src/main/layout-main.ts",
894
764
  "declarations": [
895
765
  {
896
766
  "kind": "class",
897
767
  "description": "",
898
- "name": "FoundationLayoutRegion",
768
+ "name": "FoundationLayout",
899
769
  "members": [
900
770
  {
901
771
  "kind": "field",
902
- "name": "size",
772
+ "name": "layout",
903
773
  "type": {
904
- "text": "string"
774
+ "text": "GoldenLayout"
905
775
  },
906
- "description": "optional string describing the size of the new item (see the written documentation for more info)",
907
- "privacy": "public"
776
+ "privacy": "private"
908
777
  },
909
778
  {
910
779
  "kind": "field",
911
- "name": "type",
780
+ "name": "layoutConfig",
912
781
  "type": {
913
- "text": "LayoutRegionType"
782
+ "text": "LayoutConfig"
914
783
  },
915
- "default": "layoutRegionValue[0]",
916
- "description": "Defines the LayoutRegionType| type of the region.\nDefaults to `horizontal`.",
784
+ "privacy": "private",
785
+ "default": "{ root: undefined }"
786
+ },
787
+ {
788
+ "kind": "field",
789
+ "name": "reloadBuffer",
790
+ "type": {
791
+ "text": "number"
792
+ },
793
+ "default": "DEFAULT_RELOAD_BUFFER",
794
+ "description": "Number describing how long to wait in ms before reloading the config when adding items\ndeclaratively by the html API. Default 500 (ms).",
917
795
  "privacy": "public"
918
796
  },
919
797
  {
920
798
  "kind": "field",
921
- "name": "_presentation",
799
+ "name": "reloadPending",
922
800
  "type": {
923
- "text": "ComponentPresentation | null | undefined"
801
+ "text": "boolean"
924
802
  },
925
803
  "privacy": "private",
926
- "default": "void 0",
927
- "inheritedFrom": {
928
- "name": "FoundationElement",
929
- "module": "src/foundation-element/foundation-element.ts"
930
- }
804
+ "default": "false"
931
805
  },
932
806
  {
933
807
  "kind": "field",
934
- "name": "$presentation",
808
+ "name": "registeredComponents",
935
809
  "type": {
936
- "text": "ComponentPresentation | null"
810
+ "text": "number"
811
+ },
812
+ "privacy": "private",
813
+ "default": "0"
814
+ },
815
+ {
816
+ "kind": "field",
817
+ "name": "autoSaveKey",
818
+ "type": {
819
+ "text": "string | undefined"
820
+ },
821
+ "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`.",
822
+ "privacy": "public"
823
+ },
824
+ {
825
+ "kind": "field",
826
+ "name": "missingItemPlaceholder",
827
+ "description": "Function which is used to generate the placeholder text when a layout is loaded\nwith a missing item.",
828
+ "privacy": "public"
829
+ },
830
+ {
831
+ "kind": "field",
832
+ "name": "dimensionsConfig",
833
+ "type": {
834
+ "text": "LayoutConfig.Dimensions | undefined"
835
+ },
836
+ "description": "Apply dimensions config to the layout, such as setting the size of the drag handles.",
837
+ "privacy": "public"
838
+ },
839
+ {
840
+ "kind": "field",
841
+ "name": "hasFirstLoaded",
842
+ "type": {
843
+ "text": "boolean"
844
+ },
845
+ "default": "false",
846
+ "description": "Boolean signifies whether the layout has loaded for the first time or not.",
847
+ "privacy": "public"
848
+ },
849
+ {
850
+ "kind": "field",
851
+ "name": "customButtons",
852
+ "type": {
853
+ "text": "CustomButton[]"
854
+ },
855
+ "description": "Set custom button definition on this property to add them to the layout header controls",
856
+ "privacy": "public"
857
+ },
858
+ {
859
+ "kind": "field",
860
+ "name": "dragging",
861
+ "type": {
862
+ "text": "boolean"
937
863
  },
864
+ "default": "false",
865
+ "privacy": "public"
866
+ },
867
+ {
868
+ "kind": "field",
869
+ "name": "class",
938
870
  "privacy": "public",
939
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
940
- "inheritedFrom": {
941
- "name": "FoundationElement",
942
- "module": "src/foundation-element/foundation-element.ts"
871
+ "default": "'FoundationLayoutMain'",
872
+ "type": {
873
+ "text": "'FoundationLayoutMain'"
943
874
  }
944
875
  },
945
876
  {
946
877
  "kind": "field",
947
- "name": "template",
878
+ "name": "lifecycleUpdateToken",
948
879
  "type": {
949
- "text": "ElementViewTemplate | void | null"
880
+ "text": "string | undefined"
950
881
  },
951
882
  "privacy": "public",
952
- "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.",
953
- "inheritedFrom": {
954
- "name": "FoundationElement",
955
- "module": "src/foundation-element/foundation-element.ts"
956
- }
883
+ "default": "undefined",
884
+ "description": "Used to calculate whether a layout item should run its lifecycle methods or not"
957
885
  },
958
886
  {
959
887
  "kind": "method",
960
- "name": "templateChanged",
961
- "privacy": "protected",
888
+ "name": "layoutRequiredRegistrations",
889
+ "static": true,
962
890
  "return": {
963
891
  "type": {
964
- "text": "void"
892
+ "text": ""
965
893
  }
966
894
  },
967
- "inheritedFrom": {
968
- "name": "FoundationElement",
969
- "module": "src/foundation-element/foundation-element.ts"
970
- }
895
+ "parameters": [
896
+ {
897
+ "name": "layout",
898
+ "type": {
899
+ "text": "SerialisedLayout"
900
+ },
901
+ "description": "any version of {@link SerialisedLayout}object describing the layout\n * "
902
+ }
903
+ ],
904
+ "description": "JS API, public",
905
+ "privacy": "public"
971
906
  },
972
907
  {
973
- "kind": "field",
974
- "name": "styles",
975
- "type": {
976
- "text": "ElementStyles | void | null"
908
+ "kind": "method",
909
+ "name": "registeredItems",
910
+ "return": {
911
+ "type": {
912
+ "text": ""
913
+ }
977
914
  },
978
- "privacy": "public",
979
- "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.",
980
- "inheritedFrom": {
981
- "name": "FoundationElement",
982
- "module": "src/foundation-element/foundation-element.ts"
983
- }
915
+ "privacy": "public"
984
916
  },
985
917
  {
986
918
  "kind": "method",
987
- "name": "stylesChanged",
988
- "privacy": "protected",
919
+ "name": "getLayout",
989
920
  "return": {
990
921
  "type": {
991
- "text": "void"
922
+ "text": ""
992
923
  }
993
924
  },
994
- "inheritedFrom": {
995
- "name": "FoundationElement",
996
- "module": "src/foundation-element/foundation-element.ts"
997
- }
925
+ "privacy": "public"
998
926
  },
999
927
  {
1000
928
  "kind": "method",
1001
- "name": "compose",
1002
- "privacy": "public",
1003
- "static": true,
929
+ "name": "tryLoadLayoutFromLocalStorage",
1004
930
  "return": {
1005
931
  "type": {
1006
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
932
+ "text": ""
1007
933
  }
1008
934
  },
935
+ "description": "Try to load a layout from local storage, or return false. Only required if manually calling FoundationLayout.registerItem",
936
+ "privacy": "public"
937
+ },
938
+ {
939
+ "kind": "method",
940
+ "name": "loadLayout",
1009
941
  "parameters": [
1010
942
  {
1011
- "name": "this",
943
+ "name": "layout",
1012
944
  "type": {
1013
- "text": "K"
1014
- }
945
+ "text": "SerialisedLayout"
946
+ },
947
+ "description": "any version of {@link SerialisedLayout}object describing the layout\n * "
1015
948
  },
1016
949
  {
1017
- "name": "elementDefinition",
950
+ "name": "handleMissingItem",
951
+ "default": "'error'",
1018
952
  "type": {
1019
- "text": "T"
953
+ "text": "'placeholder' | 'error'"
1020
954
  },
1021
- "description": "The definition of the element to create the registry\nfunction for."
955
+ "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 * "
956
+ },
957
+ {
958
+ "name": "disableCache",
959
+ "default": "false",
960
+ "type": {
961
+ "text": "boolean"
962
+ },
963
+ "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 * "
1022
964
  }
1023
965
  ],
1024
- "description": "Defines an element registry function with a set of element definition defaults.",
1025
- "inheritedFrom": {
1026
- "name": "FoundationElement",
1027
- "module": "src/foundation-element/foundation-element.ts"
1028
- }
1029
- }
1030
- ],
1031
- "attributes": [
966
+ "privacy": "public"
967
+ },
1032
968
  {
1033
- "name": "size",
1034
- "type": {
1035
- "text": "string"
969
+ "kind": "method",
970
+ "name": "addItem",
971
+ "parameters": [
972
+ {
973
+ "name": "config",
974
+ "type": {
975
+ "text": "RegisteredElementConfig | RegisteredElementConfig[]"
976
+ },
977
+ "description": "{@link RegisteredElementConfig}configuration items for the new items(s). Pass an array of {@link RegisteredElementConfig}to add multiple items at once.\n * "
978
+ },
979
+ {
980
+ "name": "placement",
981
+ "default": "defaultAddItemPlacement",
982
+ "type": {
983
+ "text": "Placement"
984
+ },
985
+ "description": "where and how to add the new items to the layout. For more info and defaults see {@link Placement}.\n * "
986
+ }
987
+ ],
988
+ "privacy": "public"
989
+ },
990
+ {
991
+ "kind": "method",
992
+ "name": "registerItem",
993
+ "return": {
994
+ "type": {
995
+ "text": ""
996
+ }
1036
997
  },
1037
- "description": "optional string describing the size of the new item (see the written documentation for more info)",
1038
- "fieldName": "size"
998
+ "parameters": [
999
+ {
1000
+ "name": "registration",
1001
+ "type": {
1002
+ "text": "string"
1003
+ },
1004
+ "description": "string of the registration ID"
1005
+ },
1006
+ {
1007
+ "name": "elements",
1008
+ "type": {
1009
+ "text": "Element[]"
1010
+ },
1011
+ "description": "Elements[] containing the reference to the elements to register for later usage"
1012
+ }
1013
+ ],
1014
+ "privacy": "public"
1039
1015
  },
1040
1016
  {
1041
- "name": "type",
1042
- "type": {
1043
- "text": "LayoutRegionType"
1017
+ "kind": "method",
1018
+ "name": "updateLifecycleToken",
1019
+ "privacy": "private",
1020
+ "return": {
1021
+ "type": {
1022
+ "text": "void"
1023
+ }
1044
1024
  },
1045
- "default": "defaultLayoutType",
1046
- "description": "Defines the LayoutRegionType| type of the region.\nDefaults to `horizontal`.",
1047
- "resolveInitializer": {
1048
- "module": "src/main/layout-region.ts"
1025
+ "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"
1026
+ },
1027
+ {
1028
+ "kind": "method",
1029
+ "name": "removeConfigCacheInformation",
1030
+ "privacy": "private",
1031
+ "return": {
1032
+ "type": {
1033
+ "text": "LayoutConfig"
1034
+ }
1049
1035
  },
1050
- "fieldName": "type"
1051
- }
1052
- ],
1053
- "superclass": {
1054
- "name": "FoundationElement",
1055
- "package": "@microsoft/fast-foundation"
1056
- },
1057
- "tagName": "%%prefix%%-layout-region",
1058
- "customElement": true
1059
- }
1060
- ],
1061
- "exports": [
1062
- {
1063
- "kind": "js",
1064
- "name": "FoundationLayoutRegion",
1065
- "declaration": {
1066
- "name": "FoundationLayoutRegion",
1067
- "module": "src/main/layout-region.ts"
1068
- }
1069
- }
1070
- ]
1071
- },
1072
- {
1073
- "kind": "javascript-module",
1074
- "path": "src/styles/constants.ts",
1075
- "declarations": [
1076
- {
1077
- "kind": "variable",
1078
- "name": "glVisualConfig",
1079
- "type": {
1080
- "text": "Omit<LayoutConfig, 'root'>"
1081
- },
1082
- "default": "{\n dimensions: {\n headerHeight: 38,\n borderWidth: 12,\n },\n header: {\n maximise: 'maximise',\n minimise: 'minimise',\n popout: false,\n },\n}"
1083
- },
1084
- {
1085
- "kind": "variable",
1086
- "name": "LAYOUT_ICONS",
1087
- "type": {
1088
- "text": "{\n renameSVG,\n maximiseSVG,\n minimiseSVG,\n closeSVG,\n tabDropdownSVG,\n}"
1089
- },
1090
- "default": "{\n renameSVG,\n maximiseSVG,\n minimiseSVG,\n closeSVG,\n tabDropdownSVG,\n}",
1091
- "description": "A collection of SVG icons in base64 format.",
1092
- "privacy": "public"
1093
- }
1094
- ],
1095
- "exports": [
1096
- {
1097
- "kind": "js",
1098
- "name": "glVisualConfig",
1099
- "declaration": {
1100
- "name": "glVisualConfig",
1101
- "module": "src/styles/constants.ts"
1102
- }
1103
- },
1104
- {
1105
- "kind": "js",
1106
- "name": "LAYOUT_ICONS",
1107
- "declaration": {
1108
- "name": "LAYOUT_ICONS",
1109
- "module": "src/styles/constants.ts"
1110
- }
1111
- }
1112
- ]
1113
- },
1114
- {
1115
- "kind": "javascript-module",
1116
- "path": "src/styles/dragging.styles.ts",
1117
- "declarations": [
1118
- {
1119
- "kind": "variable",
1120
- "name": "globalDraggingStyles",
1121
- "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 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`",
1122
- "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"
1123
- }
1124
- ],
1125
- "exports": [
1126
- {
1127
- "kind": "js",
1128
- "name": "globalDraggingStyles",
1129
- "declaration": {
1130
- "name": "globalDraggingStyles",
1131
- "module": "src/styles/dragging.styles.ts"
1132
- }
1133
- }
1134
- ]
1135
- },
1136
- {
1137
- "kind": "javascript-module",
1138
- "path": "src/styles/index.ts",
1139
- "declarations": [],
1140
- "exports": [
1141
- {
1142
- "kind": "js",
1143
- "name": "*",
1144
- "declaration": {
1145
- "name": "*",
1146
- "package": "./constants"
1147
- }
1148
- },
1149
- {
1150
- "kind": "js",
1151
- "name": "*",
1152
- "declaration": {
1153
- "name": "*",
1154
- "package": "./dragging.styles"
1155
- }
1156
- },
1157
- {
1158
- "kind": "js",
1159
- "name": "*",
1160
- "declaration": {
1161
- "name": "*",
1162
- "package": "./layout.styles"
1163
- }
1164
- }
1165
- ]
1166
- },
1167
- {
1168
- "kind": "javascript-module",
1169
- "path": "src/styles/layout.styles.ts",
1170
- "declarations": [
1171
- {
1172
- "kind": "variable",
1173
- "name": "layoutStyles",
1174
- "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;\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;\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 }\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`",
1175
- "description": "`ElementStyles` which defines the css for FoundationLayout.",
1176
- "privacy": "public"
1177
- }
1178
- ],
1179
- "exports": [
1180
- {
1181
- "kind": "js",
1182
- "name": "layoutStyles",
1183
- "declaration": {
1184
- "name": "layoutStyles",
1185
- "module": "src/styles/layout.styles.ts"
1186
- }
1187
- }
1188
- ]
1189
- },
1190
- {
1191
- "kind": "javascript-module",
1192
- "path": "src/utils/constants.ts",
1193
- "declarations": [
1194
- {
1195
- "kind": "variable",
1196
- "name": "DEFAULT_RELOAD_BUFFER",
1197
- "type": {
1198
- "text": "number"
1199
- },
1200
- "default": "500",
1201
- "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.",
1202
- "privacy": "public"
1203
- }
1204
- ],
1205
- "exports": [
1206
- {
1207
- "kind": "js",
1208
- "name": "DEFAULT_RELOAD_BUFFER",
1209
- "declaration": {
1210
- "name": "DEFAULT_RELOAD_BUFFER",
1211
- "module": "src/utils/constants.ts"
1212
- }
1213
- }
1214
- ]
1215
- },
1216
- {
1217
- "kind": "javascript-module",
1218
- "path": "src/utils/error.ts",
1219
- "declarations": [
1220
- {
1221
- "kind": "class",
1222
- "description": "",
1223
- "name": "LayoutUsageError",
1224
- "superclass": {
1225
- "name": "Error",
1226
- "module": "src/utils/error.ts"
1227
- }
1228
- },
1229
- {
1230
- "kind": "class",
1231
- "description": "",
1232
- "name": "LayoutRegistrationError",
1233
- "superclass": {
1234
- "name": "Error",
1235
- "module": "src/utils/error.ts"
1236
- }
1237
- }
1238
- ],
1239
- "exports": [
1240
- {
1241
- "kind": "js",
1242
- "name": "LayoutUsageError",
1243
- "declaration": {
1244
- "name": "LayoutUsageError",
1245
- "module": "src/utils/error.ts"
1246
- }
1247
- },
1248
- {
1249
- "kind": "js",
1250
- "name": "LayoutRegistrationError",
1251
- "declaration": {
1252
- "name": "LayoutRegistrationError",
1253
- "module": "src/utils/error.ts"
1254
- }
1255
- }
1256
- ]
1257
- },
1258
- {
1259
- "kind": "javascript-module",
1260
- "path": "src/utils/events.ts",
1261
- "declarations": [
1262
- {
1263
- "kind": "variable",
1264
- "name": "LayoutEmitEvents",
1265
- "type": {
1266
- "text": "{\n firstLoaded: 'first-loaded',\n itemAdded: 'item-added',\n itemRemoved: 'item-removed',\n itemResized: 'item-resized',\n}"
1267
- },
1268
- "default": "{\n firstLoaded: 'first-loaded',\n itemAdded: 'item-added',\n itemRemoved: 'item-removed',\n itemResized: 'item-resized',\n}",
1269
- "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",
1270
- "privacy": "public"
1271
- },
1272
- {
1273
- "kind": "variable",
1274
- "name": "LayoutReceiveEvents",
1275
- "type": {
1276
- "text": "{\n changeTitle: 'change-title',\n autosave: 'autosave',\n}"
1277
- },
1278
- "default": "{\n changeTitle: 'change-title',\n autosave: 'autosave',\n}",
1279
- "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.",
1280
- "privacy": "public"
1281
- }
1282
- ],
1283
- "exports": [
1284
- {
1285
- "kind": "js",
1286
- "name": "LayoutEmitEvents",
1287
- "declaration": {
1288
- "name": "LayoutEmitEvents",
1289
- "module": "src/utils/events.ts"
1290
- }
1291
- },
1292
- {
1293
- "kind": "js",
1294
- "name": "LayoutReceiveEvents",
1295
- "declaration": {
1296
- "name": "LayoutReceiveEvents",
1297
- "module": "src/utils/events.ts"
1298
- }
1299
- }
1300
- ]
1301
- },
1302
- {
1303
- "kind": "javascript-module",
1304
- "path": "src/utils/index.ts",
1305
- "declarations": [],
1306
- "exports": [
1307
- {
1308
- "kind": "js",
1309
- "name": "*",
1310
- "declaration": {
1311
- "name": "*",
1312
- "package": "./constants"
1313
- }
1314
- },
1315
- {
1316
- "kind": "js",
1317
- "name": "*",
1318
- "declaration": {
1319
- "name": "*",
1320
- "package": "./error"
1321
- }
1322
- },
1323
- {
1324
- "kind": "js",
1325
- "name": "*",
1326
- "declaration": {
1327
- "name": "*",
1328
- "package": "./events"
1329
- }
1036
+ "parameters": [
1037
+ {
1038
+ "name": "config",
1039
+ "type": {
1040
+ "text": "LayoutConfig"
1041
+ }
1042
+ }
1043
+ ],
1044
+ "description": "Recursively remove the instance key from the config which will mean that when the config is loaded it will instantiate a new instance for every item, even if they're in the cache."
1045
+ },
1046
+ {
1047
+ "kind": "field",
1048
+ "name": "_presentation",
1049
+ "type": {
1050
+ "text": "ComponentPresentation | null | undefined"
1051
+ },
1052
+ "privacy": "private",
1053
+ "default": "void 0",
1054
+ "inheritedFrom": {
1055
+ "name": "FoundationElement",
1056
+ "module": "src/foundation-element/foundation-element.ts"
1057
+ }
1058
+ },
1059
+ {
1060
+ "kind": "field",
1061
+ "name": "$presentation",
1062
+ "type": {
1063
+ "text": "ComponentPresentation | null"
1064
+ },
1065
+ "privacy": "public",
1066
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
1067
+ "inheritedFrom": {
1068
+ "name": "FoundationElement",
1069
+ "module": "src/foundation-element/foundation-element.ts"
1070
+ }
1071
+ },
1072
+ {
1073
+ "kind": "field",
1074
+ "name": "template",
1075
+ "type": {
1076
+ "text": "ElementViewTemplate | void | null"
1077
+ },
1078
+ "privacy": "public",
1079
+ "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.",
1080
+ "inheritedFrom": {
1081
+ "name": "FoundationElement",
1082
+ "module": "src/foundation-element/foundation-element.ts"
1083
+ }
1084
+ },
1085
+ {
1086
+ "kind": "method",
1087
+ "name": "templateChanged",
1088
+ "privacy": "protected",
1089
+ "return": {
1090
+ "type": {
1091
+ "text": "void"
1092
+ }
1093
+ },
1094
+ "inheritedFrom": {
1095
+ "name": "FoundationElement",
1096
+ "module": "src/foundation-element/foundation-element.ts"
1097
+ }
1098
+ },
1099
+ {
1100
+ "kind": "field",
1101
+ "name": "styles",
1102
+ "type": {
1103
+ "text": "ElementStyles | void | null"
1104
+ },
1105
+ "privacy": "public",
1106
+ "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.",
1107
+ "inheritedFrom": {
1108
+ "name": "FoundationElement",
1109
+ "module": "src/foundation-element/foundation-element.ts"
1110
+ }
1111
+ },
1112
+ {
1113
+ "kind": "method",
1114
+ "name": "stylesChanged",
1115
+ "privacy": "protected",
1116
+ "return": {
1117
+ "type": {
1118
+ "text": "void"
1119
+ }
1120
+ },
1121
+ "inheritedFrom": {
1122
+ "name": "FoundationElement",
1123
+ "module": "src/foundation-element/foundation-element.ts"
1124
+ }
1125
+ },
1126
+ {
1127
+ "kind": "method",
1128
+ "name": "compose",
1129
+ "privacy": "public",
1130
+ "static": true,
1131
+ "return": {
1132
+ "type": {
1133
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
1134
+ }
1135
+ },
1136
+ "parameters": [
1137
+ {
1138
+ "name": "this",
1139
+ "type": {
1140
+ "text": "K"
1141
+ }
1142
+ },
1143
+ {
1144
+ "name": "elementDefinition",
1145
+ "type": {
1146
+ "text": "T"
1147
+ },
1148
+ "description": "The definition of the element to create the registry\nfunction for."
1149
+ }
1150
+ ],
1151
+ "description": "Defines an element registry function with a set of element definition defaults.",
1152
+ "inheritedFrom": {
1153
+ "name": "FoundationElement",
1154
+ "module": "src/foundation-element/foundation-element.ts"
1155
+ }
1156
+ }
1157
+ ],
1158
+ "attributes": [
1159
+ {
1160
+ "name": "reload-buffer",
1161
+ "type": {
1162
+ "text": "number"
1163
+ },
1164
+ "default": "DEFAULT_RELOAD_BUFFER",
1165
+ "description": "Number describing how long to wait in ms before reloading the config when adding items\ndeclaratively by the html API. Default 500 (ms).",
1166
+ "resolveInitializer": {
1167
+ "module": "/src/utils/"
1168
+ },
1169
+ "fieldName": "reloadBuffer"
1170
+ },
1171
+ {
1172
+ "name": "auto-save-key",
1173
+ "type": {
1174
+ "text": "string | undefined"
1175
+ },
1176
+ "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`.",
1177
+ "fieldName": "autoSaveKey"
1178
+ }
1179
+ ],
1180
+ "superclass": {
1181
+ "name": "FoundationElement",
1182
+ "package": "@microsoft/fast-foundation"
1183
+ },
1184
+ "tagName": "%%prefix%%-layout",
1185
+ "customElement": true
1330
1186
  },
1331
1187
  {
1332
- "kind": "js",
1333
- "name": "*",
1334
- "declaration": {
1335
- "name": "*",
1336
- "package": "./misc"
1337
- }
1338
- },
1188
+ "kind": "variable",
1189
+ "name": "layoutTemplate",
1190
+ "default": "html<FoundationLayout>`\n <template>\n ${when((x) => !x.hasFirstLoaded && x.usingDeclerativeAPI, loadingTemplate)}\n <div class=\"layout-container\" ${ref('layoutElement')}></div>\n </template>\n`",
1191
+ "description": "`ViewTemplate` which defines the html for FoundationLayout.",
1192
+ "privacy": "public"
1193
+ }
1194
+ ],
1195
+ "exports": [
1339
1196
  {
1340
1197
  "kind": "js",
1341
- "name": "*",
1198
+ "name": "layoutStyles",
1342
1199
  "declaration": {
1343
- "name": "*",
1344
- "package": "./templates"
1200
+ "name": "layoutStyles",
1201
+ "module": "../styles"
1345
1202
  }
1346
1203
  },
1347
1204
  {
1348
1205
  "kind": "js",
1349
- "name": "*",
1206
+ "name": "FoundationLayout",
1350
1207
  "declaration": {
1351
- "name": "*",
1352
- "package": "./types"
1208
+ "name": "FoundationLayout",
1209
+ "module": "src/main/layout-main.ts"
1353
1210
  }
1354
1211
  },
1355
1212
  {
1356
1213
  "kind": "js",
1357
- "name": "*",
1214
+ "name": "layoutTemplate",
1358
1215
  "declaration": {
1359
- "name": "*",
1360
- "package": "./error"
1216
+ "name": "layoutTemplate",
1217
+ "module": "src/main/layout-main.ts"
1361
1218
  }
1362
1219
  }
1363
1220
  ]
1364
1221
  },
1365
1222
  {
1366
1223
  "kind": "javascript-module",
1367
- "path": "src/utils/logger.ts",
1224
+ "path": "src/main/layout-region.ts",
1368
1225
  "declarations": [
1369
1226
  {
1370
- "kind": "variable",
1371
- "name": "logger"
1227
+ "kind": "class",
1228
+ "description": "",
1229
+ "name": "FoundationLayoutRegion",
1230
+ "members": [
1231
+ {
1232
+ "kind": "field",
1233
+ "name": "size",
1234
+ "type": {
1235
+ "text": "string"
1236
+ },
1237
+ "description": "optional string describing the size of the new item (see the written documentation for more info)",
1238
+ "privacy": "public"
1239
+ },
1240
+ {
1241
+ "kind": "field",
1242
+ "name": "type",
1243
+ "type": {
1244
+ "text": "LayoutRegionType"
1245
+ },
1246
+ "default": "layoutRegionValue[0]",
1247
+ "description": "Defines the LayoutRegionType| type of the region.\nDefaults to `horizontal`.",
1248
+ "privacy": "public"
1249
+ },
1250
+ {
1251
+ "kind": "field",
1252
+ "name": "_presentation",
1253
+ "type": {
1254
+ "text": "ComponentPresentation | null | undefined"
1255
+ },
1256
+ "privacy": "private",
1257
+ "default": "void 0",
1258
+ "inheritedFrom": {
1259
+ "name": "FoundationElement",
1260
+ "module": "src/foundation-element/foundation-element.ts"
1261
+ }
1262
+ },
1263
+ {
1264
+ "kind": "field",
1265
+ "name": "$presentation",
1266
+ "type": {
1267
+ "text": "ComponentPresentation | null"
1268
+ },
1269
+ "privacy": "public",
1270
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
1271
+ "inheritedFrom": {
1272
+ "name": "FoundationElement",
1273
+ "module": "src/foundation-element/foundation-element.ts"
1274
+ }
1275
+ },
1276
+ {
1277
+ "kind": "field",
1278
+ "name": "template",
1279
+ "type": {
1280
+ "text": "ElementViewTemplate | void | null"
1281
+ },
1282
+ "privacy": "public",
1283
+ "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.",
1284
+ "inheritedFrom": {
1285
+ "name": "FoundationElement",
1286
+ "module": "src/foundation-element/foundation-element.ts"
1287
+ }
1288
+ },
1289
+ {
1290
+ "kind": "method",
1291
+ "name": "templateChanged",
1292
+ "privacy": "protected",
1293
+ "return": {
1294
+ "type": {
1295
+ "text": "void"
1296
+ }
1297
+ },
1298
+ "inheritedFrom": {
1299
+ "name": "FoundationElement",
1300
+ "module": "src/foundation-element/foundation-element.ts"
1301
+ }
1302
+ },
1303
+ {
1304
+ "kind": "field",
1305
+ "name": "styles",
1306
+ "type": {
1307
+ "text": "ElementStyles | void | null"
1308
+ },
1309
+ "privacy": "public",
1310
+ "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.",
1311
+ "inheritedFrom": {
1312
+ "name": "FoundationElement",
1313
+ "module": "src/foundation-element/foundation-element.ts"
1314
+ }
1315
+ },
1316
+ {
1317
+ "kind": "method",
1318
+ "name": "stylesChanged",
1319
+ "privacy": "protected",
1320
+ "return": {
1321
+ "type": {
1322
+ "text": "void"
1323
+ }
1324
+ },
1325
+ "inheritedFrom": {
1326
+ "name": "FoundationElement",
1327
+ "module": "src/foundation-element/foundation-element.ts"
1328
+ }
1329
+ },
1330
+ {
1331
+ "kind": "method",
1332
+ "name": "compose",
1333
+ "privacy": "public",
1334
+ "static": true,
1335
+ "return": {
1336
+ "type": {
1337
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
1338
+ }
1339
+ },
1340
+ "parameters": [
1341
+ {
1342
+ "name": "this",
1343
+ "type": {
1344
+ "text": "K"
1345
+ }
1346
+ },
1347
+ {
1348
+ "name": "elementDefinition",
1349
+ "type": {
1350
+ "text": "T"
1351
+ },
1352
+ "description": "The definition of the element to create the registry\nfunction for."
1353
+ }
1354
+ ],
1355
+ "description": "Defines an element registry function with a set of element definition defaults.",
1356
+ "inheritedFrom": {
1357
+ "name": "FoundationElement",
1358
+ "module": "src/foundation-element/foundation-element.ts"
1359
+ }
1360
+ }
1361
+ ],
1362
+ "attributes": [
1363
+ {
1364
+ "name": "size",
1365
+ "type": {
1366
+ "text": "string"
1367
+ },
1368
+ "description": "optional string describing the size of the new item (see the written documentation for more info)",
1369
+ "fieldName": "size"
1370
+ },
1371
+ {
1372
+ "name": "type",
1373
+ "type": {
1374
+ "text": "LayoutRegionType"
1375
+ },
1376
+ "default": "defaultLayoutType",
1377
+ "description": "Defines the LayoutRegionType| type of the region.\nDefaults to `horizontal`.",
1378
+ "resolveInitializer": {
1379
+ "module": "src/main/layout-region.ts"
1380
+ },
1381
+ "fieldName": "type"
1382
+ }
1383
+ ],
1384
+ "superclass": {
1385
+ "name": "FoundationElement",
1386
+ "package": "@microsoft/fast-foundation"
1387
+ },
1388
+ "tagName": "%%prefix%%-layout-region",
1389
+ "customElement": true
1372
1390
  }
1373
1391
  ],
1374
1392
  "exports": [
1375
1393
  {
1376
1394
  "kind": "js",
1377
- "name": "logger",
1395
+ "name": "FoundationLayoutRegion",
1378
1396
  "declaration": {
1379
- "name": "logger",
1380
- "module": "src/utils/logger.ts"
1397
+ "name": "FoundationLayoutRegion",
1398
+ "module": "src/main/layout-region.ts"
1381
1399
  }
1382
1400
  }
1383
1401
  ]
1384
- },
1385
- {
1386
- "kind": "javascript-module",
1387
- "path": "src/utils/misc.ts",
1388
- "declarations": [],
1389
- "exports": []
1390
- },
1391
- {
1392
- "kind": "javascript-module",
1393
- "path": "src/utils/templates.ts",
1394
- "declarations": [],
1395
- "exports": []
1396
- },
1397
- {
1398
- "kind": "javascript-module",
1399
- "path": "src/utils/types.ts",
1400
- "declarations": [],
1401
- "exports": []
1402
1402
  }
1403
1403
  ]
1404
1404
  }