@genesislcap/foundation-layout 14.86.1-alpha-573d24f.0 → 14.88.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/custom-elements.json +9 -0
- package/dist/dts/main/layout-main.d.ts +8 -1
- package/dist/dts/main/layout-main.d.ts.map +1 -1
- package/dist/esm/main/layout-main.js +3 -1
- package/dist/foundation-layout.api.json +31 -0
- package/dist/foundation-layout.d.ts +8 -0
- package/docs/api/foundation-layout.foundationlayout.dimensionsconfig.md +13 -0
- package/docs/api/foundation-layout.foundationlayout.md +1 -0
- package/docs/api-report.md +2 -0
- package/package.json +7 -7
@@ -496,6 +496,15 @@
|
|
496
496
|
"description": "Function which is used to generate the placeholder text when a layout is loaded\nwith a missing item.",
|
497
497
|
"privacy": "public"
|
498
498
|
},
|
499
|
+
{
|
500
|
+
"kind": "field",
|
501
|
+
"name": "dimensionsConfig",
|
502
|
+
"type": {
|
503
|
+
"text": "LayoutConfig.Dimensions | undefined"
|
504
|
+
},
|
505
|
+
"description": "Apply dimensions config to the layout, such as setting the size of the drag handles.",
|
506
|
+
"privacy": "public"
|
507
|
+
},
|
499
508
|
{
|
500
509
|
"kind": "field",
|
501
510
|
"name": "hasFirstLoaded",
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import { RootItemConfig } from '@genesis-community/golden-layout';
|
1
|
+
import { LayoutConfig, RootItemConfig } from '@genesis-community/golden-layout';
|
2
2
|
import { FoundationElement } from '@microsoft/fast-foundation';
|
3
3
|
import { LayoutComponent, Placement, RegisteredElementConfig, RegistrationConfig, SerialisedLayout, componentType, CustomButton } from '../utils/';
|
4
4
|
export { layoutStyles } from '../styles';
|
@@ -42,6 +42,11 @@ export declare class FoundationLayout extends FoundationElement implements Layou
|
|
42
42
|
* @public
|
43
43
|
*/
|
44
44
|
missingItemPlaceholder: (missingItem: string) => string;
|
45
|
+
/**
|
46
|
+
* Apply dimensions config to the layout, such as setting the size of the drag handles.
|
47
|
+
* @public
|
48
|
+
*/
|
49
|
+
dimensionsConfig?: LayoutConfig.Dimensions;
|
45
50
|
/**
|
46
51
|
* Boolean signifies whether the layout has loaded for the first time or not.
|
47
52
|
* @remarks
|
@@ -256,6 +261,8 @@ export declare class FoundationLayout extends FoundationElement implements Layou
|
|
256
261
|
* When loading the layout the visual configuration is loaded
|
257
262
|
* Event listeners are added to the drag handles to emulate resizing events
|
258
263
|
*
|
264
|
+
* Visual config can be overridden by the `dimensions-config` attribute.
|
265
|
+
*
|
259
266
|
* **This is the only function which should call this.layout.loadLayout() directly.**
|
260
267
|
* @internal
|
261
268
|
*/
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"layout-main.d.ts","sourceRoot":"","sources":["../../../src/main/layout-main.ts"],"names":[],"mappings":"AAAA,OAAO,
|
1
|
+
{"version":3,"file":"layout-main.d.ts","sourceRoot":"","sources":["../../../src/main/layout-main.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,YAAY,EAEZ,cAAc,EAGf,MAAM,kCAAkC,CAAC;AAI1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAEL,eAAe,EAGf,SAAS,EACT,uBAAuB,EACvB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EAKb,YAAY,EAIb,MAAM,WAAW,CAAC;AAKnB,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAiBzC;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,iBAAkB,YAAW,eAAe;;IAChF,OAAO,CAAC,MAAM,CAAe;IAC7B,gBAAgB;IAChB,aAAa,EAAE,WAAW,CAAC;IAC3B,OAAO,CAAC,YAAY,CAAqC;IAEzD,gBAAgB;IAChB,CAAC,aAAa,CAAC,SAAmB;IAElC;;;;OAIG;IACmC,YAAY,EAAE,MAAM,CAAyB;IACnF,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,oBAAoB,CAAK;IAEjC,gBAAgB;IACV,OAAO,CAAC,IAAI,CAAO;IAEzB,gBAAgB;IACP,OAAO,CAAC,OAAO,CAAU;IAClC;;;;;OAKG;IACmC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC3D;;;;OAIG;IACS,sBAAsB,gBAAiB,MAAM,YAC2B;IAEpF;;;OAGG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC;IAE3C;;;;;;;;;;OAUG;IACS,cAAc,UAAS;IACnC,gBAAgB;IACJ,mBAAmB,UAAS;IAExC;;;;;OAKG;IACH,aAAa,EAAE,YAAY,EAAE,CAAC;IAE9B;;;OAGG;IACS,QAAQ,EAAE,OAAO,CAAS;IAEtC;;;;;OAKG;IACI,KAAK,yBAAmC;IAE/C;;;;;;;OAOG;IACI,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAa;IAE5D,gBAAgB;;IAWhB,gBAAgB;IAChB,iBAAiB,IAAI,IAAI;IA0BzB,gBAAgB;IAChB,oBAAoB,IAAI,IAAI;IAU5B,gBAAgB;IAChB,OAAO,CAAC,WAAW;IAInB,gBAAgB;IAChB,OAAO,CAAC,UAAU;IAMlB,gBAAgB;IAChB,OAAO,CAAC,eAAe;IAKvB,gBAAgB;IAChB,OAAO,CAAC,gBAAgB;IAIxB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAOzB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAKzB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAIzB;;OAEG;IAEH;;;;;;;;;;OAUG;IACH,MAAM,CAAC,2BAA2B,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,EAAE;IActE;;;;;;;;OAQG;IACH,eAAe,IAAI,MAAM,EAAE;IAI3B;;;;;;OAMG;IACH,SAAS,IAAI,gBAAgB;IAe7B;;;;;;;;;;;;OAYG;IACH,6BAA6B,IAAI,OAAO;IAcxC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,GAAE,aAAa,GAAG,OAAiB;IAsBzF;;;;;;;;;;;OAWG;IACH,OAAO,CACL,MAAM,EAAE,uBAAuB,GAAG,uBAAuB,EAAE,EAC3D,SAAS,GAAE,SAAmC;IA+DhD;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM;IAW/D;;OAEG;IAEH;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;IACH,mBAAmB,IAAI,IAAI;IAmB3B;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC;IAetD;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,kBAAkB,GAAG,MAAM;IAwEtE;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAehC;;;;SAIK;IACL,OAAO,CAAC,kBAAkB;IAY1B;;;;;;;;OAQG;IACH,OAAO,CAAC,kCAAkC;IA4B1C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,oBAAoB;IAW5B;;;;;;;;OAQG;IACH,OAAO,CAAC,mBAAmB;IAU3B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;CAK5B;AAMD;;;;;GAKG;AACH,eAAO,MAAM,cAAc,uEAK1B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;2BAI3B,CAAC"}
|
@@ -545,12 +545,14 @@ export class FoundationLayout extends FoundationElement {
|
|
545
545
|
* When loading the layout the visual configuration is loaded
|
546
546
|
* Event listeners are added to the drag handles to emulate resizing events
|
547
547
|
*
|
548
|
+
* Visual config can be overridden by the `dimensions-config` attribute.
|
549
|
+
*
|
548
550
|
* **This is the only function which should call this.layout.loadLayout() directly.**
|
549
551
|
* @internal
|
550
552
|
*/
|
551
553
|
loadGLConfigAndSetup(config) {
|
552
554
|
this.hasFirstLoaded = true;
|
553
|
-
this.layout.loadLayout(Object.assign(Object.assign({}, config), glVisualConfig));
|
555
|
+
this.layout.loadLayout(Object.assign(Object.assign(Object.assign({}, config), glVisualConfig), { dimensions: Object.assign(Object.assign({}, glVisualConfig.dimensions), this.dimensionsConfig) }));
|
554
556
|
this.attatchResizeEvents();
|
555
557
|
}
|
556
558
|
/**
|
@@ -463,6 +463,37 @@
|
|
463
463
|
"isProtected": false,
|
464
464
|
"isAbstract": false
|
465
465
|
},
|
466
|
+
{
|
467
|
+
"kind": "Property",
|
468
|
+
"canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#dimensionsConfig:member",
|
469
|
+
"docComment": "/**\n * Apply dimensions config to the layout, such as setting the size of the drag handles.\n *\n * @public\n */\n",
|
470
|
+
"excerptTokens": [
|
471
|
+
{
|
472
|
+
"kind": "Content",
|
473
|
+
"text": "dimensionsConfig?: "
|
474
|
+
},
|
475
|
+
{
|
476
|
+
"kind": "Reference",
|
477
|
+
"text": "LayoutConfig.Dimensions",
|
478
|
+
"canonicalReference": "@genesis-community/golden-layout!LayoutConfig.Dimensions:interface"
|
479
|
+
},
|
480
|
+
{
|
481
|
+
"kind": "Content",
|
482
|
+
"text": ";"
|
483
|
+
}
|
484
|
+
],
|
485
|
+
"isReadonly": false,
|
486
|
+
"isOptional": true,
|
487
|
+
"releaseTag": "Public",
|
488
|
+
"name": "dimensionsConfig",
|
489
|
+
"propertyTypeTokenRange": {
|
490
|
+
"startIndex": 1,
|
491
|
+
"endIndex": 2
|
492
|
+
},
|
493
|
+
"isStatic": false,
|
494
|
+
"isProtected": false,
|
495
|
+
"isAbstract": false
|
496
|
+
},
|
466
497
|
{
|
467
498
|
"kind": "Property",
|
468
499
|
"canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#dragging:member",
|
@@ -2,6 +2,7 @@ import type { Container } from '@microsoft/fast-foundation';
|
|
2
2
|
import { ElementStyles } from '@microsoft/fast-element';
|
3
3
|
import { FoundationElement } from '@microsoft/fast-foundation';
|
4
4
|
import { FoundationElementRegistry } from '@microsoft/fast-foundation';
|
5
|
+
import { LayoutConfig } from '@genesis-community/golden-layout';
|
5
6
|
import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
|
6
7
|
import { ResolvedLayoutConfig } from '@genesis-community/golden-layout';
|
7
8
|
import { RootItemConfig } from '@genesis-community/golden-layout';
|
@@ -77,6 +78,11 @@ export declare class FoundationLayout extends FoundationElement implements Layou
|
|
77
78
|
* @public
|
78
79
|
*/
|
79
80
|
missingItemPlaceholder: (missingItem: string) => string;
|
81
|
+
/**
|
82
|
+
* Apply dimensions config to the layout, such as setting the size of the drag handles.
|
83
|
+
* @public
|
84
|
+
*/
|
85
|
+
dimensionsConfig?: LayoutConfig.Dimensions;
|
80
86
|
/**
|
81
87
|
* Boolean signifies whether the layout has loaded for the first time or not.
|
82
88
|
* @remarks
|
@@ -291,6 +297,8 @@ export declare class FoundationLayout extends FoundationElement implements Layou
|
|
291
297
|
* When loading the layout the visual configuration is loaded
|
292
298
|
* Event listeners are added to the drag handles to emulate resizing events
|
293
299
|
*
|
300
|
+
* Visual config can be overridden by the `dimensions-config` attribute.
|
301
|
+
*
|
294
302
|
* **This is the only function which should call this.layout.loadLayout() directly.**
|
295
303
|
* @internal
|
296
304
|
*/
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-layout](./foundation-layout.md) > [FoundationLayout](./foundation-layout.foundationlayout.md) > [dimensionsConfig](./foundation-layout.foundationlayout.dimensionsconfig.md)
|
4
|
+
|
5
|
+
## FoundationLayout.dimensionsConfig property
|
6
|
+
|
7
|
+
Apply dimensions config to the layout, such as setting the size of the drag handles.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
dimensionsConfig?: LayoutConfig.Dimensions;
|
13
|
+
```
|
@@ -28,6 +28,7 @@ The constructor for this class is marked as internal. Third-party code should no
|
|
28
28
|
| [autoSaveKey?](./foundation-layout.foundationlayout.autosavekey.md) | | string | _(Optional)_ Attribute which if set will auto save and load the layout as the user changes it. Omit this attribute to disable this feature. Set attribute using <code>auto-save-key</code>. |
|
29
29
|
| [class](./foundation-layout.foundationlayout.class.md) | | "FoundationLayoutMain" | Identifier constant token. |
|
30
30
|
| [customButtons](./foundation-layout.foundationlayout.custombuttons.md) | | [CustomButton](./foundation-layout.custombutton.md)<!-- -->\[\] | Set custom button definition on this property to add them to the layout header controls |
|
31
|
+
| [dimensionsConfig?](./foundation-layout.foundationlayout.dimensionsconfig.md) | | LayoutConfig.Dimensions | _(Optional)_ Apply dimensions config to the layout, such as setting the size of the drag handles. |
|
31
32
|
| [dragging](./foundation-layout.foundationlayout.dragging.md) | | boolean | Set to true when the user is currently dragging the panes inside of the layout |
|
32
33
|
| [hasFirstLoaded](./foundation-layout.foundationlayout.hasfirstloaded.md) | | boolean | Boolean signifies whether the layout has loaded for the first time or not. |
|
33
34
|
| [lifecycleUpdateToken](./foundation-layout.foundationlayout.lifecycleupdatetoken.md) | | string \| undefined | Used to calculate whether a layout item should run its lifecycle methods or not |
|
package/docs/api-report.md
CHANGED
@@ -8,6 +8,7 @@ import type { Container } from '@microsoft/fast-foundation';
|
|
8
8
|
import { ElementStyles } from '@microsoft/fast-element';
|
9
9
|
import { FoundationElement } from '@microsoft/fast-foundation';
|
10
10
|
import { FoundationElementRegistry } from '@microsoft/fast-foundation';
|
11
|
+
import { LayoutConfig } from '@genesis-community/golden-layout';
|
11
12
|
import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
|
12
13
|
import { ResolvedLayoutConfig } from '@genesis-community/golden-layout';
|
13
14
|
import { RootItemConfig } from '@genesis-community/golden-layout';
|
@@ -40,6 +41,7 @@ export class FoundationLayout extends FoundationElement implements LayoutCompone
|
|
40
41
|
// @internal (undocumented)
|
41
42
|
connectedCallback(): void;
|
42
43
|
customButtons: CustomButton[];
|
44
|
+
dimensionsConfig?: LayoutConfig.Dimensions;
|
43
45
|
// @internal (undocumented)
|
44
46
|
disconnectedCallback(): void;
|
45
47
|
dragging: boolean;
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@genesislcap/foundation-layout",
|
3
3
|
"description": "Genesis Foundation UI App Layout",
|
4
|
-
"version": "14.
|
4
|
+
"version": "14.88.0",
|
5
5
|
"license": "SEE LICENSE IN license.txt",
|
6
6
|
"main": "dist/esm/index.js",
|
7
7
|
"types": "dist/foundation-layout.d.ts",
|
@@ -27,15 +27,15 @@
|
|
27
27
|
"test:debug": "genx test --debug"
|
28
28
|
},
|
29
29
|
"devDependencies": {
|
30
|
-
"@genesislcap/foundation-testing": "14.
|
31
|
-
"@genesislcap/genx": "14.
|
30
|
+
"@genesislcap/foundation-testing": "14.88.0",
|
31
|
+
"@genesislcap/genx": "14.88.0",
|
32
32
|
"rimraf": "^3.0.2"
|
33
33
|
},
|
34
34
|
"dependencies": {
|
35
35
|
"@genesis-community/golden-layout": "^2.10.1",
|
36
|
-
"@genesislcap/foundation-comms": "14.
|
37
|
-
"@genesislcap/foundation-logger": "14.
|
38
|
-
"@genesislcap/foundation-utils": "14.
|
36
|
+
"@genesislcap/foundation-comms": "14.88.0",
|
37
|
+
"@genesislcap/foundation-logger": "14.88.0",
|
38
|
+
"@genesislcap/foundation-utils": "14.88.0",
|
39
39
|
"@microsoft/fast-components": "^2.21.3",
|
40
40
|
"@microsoft/fast-element": "^1.7.0",
|
41
41
|
"@microsoft/fast-foundation": "^2.33.2",
|
@@ -50,5 +50,5 @@
|
|
50
50
|
"access": "public"
|
51
51
|
},
|
52
52
|
"customElements": "dist/custom-elements.json",
|
53
|
-
"gitHead": "
|
53
|
+
"gitHead": "2e0aecfc90fb2ea2b2008b5b5067640d71ef13d8"
|
54
54
|
}
|