@genesislcap/foundation-layout 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/dist/dts/main/layout-item.d.ts.map +1 -1
  2. package/dist/dts/main/layout-main.d.ts.map +1 -1
  3. package/dist/dts/utils/misc.d.ts.map +1 -1
  4. package/dist/foundation-layout.api.json +1 -1
  5. package/dist/foundation-layout.d.ts +519 -519
  6. package/dist/tsdoc-metadata.json +1 -1
  7. package/docs/api/foundation-layout.foundationlayout.additem.md +4 -49
  8. package/docs/api/foundation-layout.foundationlayout.layoutrequiredregistrations.md +3 -33
  9. package/docs/api/foundation-layout.foundationlayout.loadlayout.md +5 -65
  10. package/docs/api/foundation-layout.foundationlayout.md +23 -357
  11. package/docs/api/foundation-layout.foundationlayout.registeritem.md +4 -49
  12. package/docs/api/foundation-layout.foundationlayout.removeitems.md +4 -49
  13. package/docs/api/foundation-layout.foundationlayoutitem.md +6 -98
  14. package/docs/api/foundation-layout.foundationlayoutregion.md +4 -60
  15. package/docs/api/foundation-layout.layoutcomponentwithstate.applystate.md +3 -31
  16. package/docs/api/foundation-layout.layoutcomponentwithstate.md +4 -34
  17. package/docs/api/foundation-layout.layoutregistrationerror._constructor_.md +3 -31
  18. package/docs/api/foundation-layout.layoutregistrationerror.md +3 -31
  19. package/docs/api/foundation-layout.layoutusageerror._constructor_.md +3 -31
  20. package/docs/api/foundation-layout.layoutusageerror.md +3 -31
  21. package/docs/api/foundation-layout.md +28 -274
  22. package/docs/api/foundation-layout.registeredelementconfig.md +7 -115
  23. package/docs/api/index.md +3 -21
  24. package/package.json +15 -13
  25. package/docs/api-report.md.api.md +0 -235
package/docs/api/foundation-layout.foundationlayoutitem.md CHANGED
@@ -23,102 +23,10 @@ This is a simple component which is only used to define the layout splits; any J
23
23
 
24
24
  ## Properties
25
25
 
26
- <table><thead><tr><th>
27
-
28
- Property
29
-
30
-
31
- </th><th>
32
-
33
- Modifiers
34
-
35
-
36
- </th><th>
37
-
38
- Type
39
-
40
-
41
- </th><th>
42
-
43
- Description
44
-
45
-
46
- </th></tr></thead>
47
- <tbody><tr><td>
48
-
49
- [closable](./foundation-layout.foundationlayoutitem.closable.md)
50
-
51
-
52
- </td><td>
53
-
54
-
55
- </td><td>
56
-
57
- boolean
58
-
59
-
60
- </td><td>
61
-
62
- Boolean attribute controls whether the window can be closed in the GUI. Defaults to `false`<!-- -->.
63
-
64
-
65
- </td></tr>
66
- <tr><td>
67
-
68
- [registration](./foundation-layout.foundationlayoutitem.registration.md)
69
-
70
-
71
- </td><td>
72
-
73
-
74
- </td><td>
75
-
76
- string
77
-
78
-
79
- </td><td>
80
-
81
- Sets the registration name for the item, which can be used later to add the item via the JavaScript API using [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md)<!-- -->.
82
-
83
-
84
- </td></tr>
85
- <tr><td>
86
-
87
- [size](./foundation-layout.foundationlayoutitem.size.md)
88
-
89
-
90
- </td><td>
91
-
92
-
93
- </td><td>
94
-
95
- string
96
-
97
-
98
- </td><td>
99
-
100
- optional string describing the size of the new item (see the written documentation for more info)
101
-
102
-
103
- </td></tr>
104
- <tr><td>
105
-
106
- [title](./foundation-layout.foundationlayoutitem.title.md)
107
-
108
-
109
- </td><td>
110
-
111
-
112
- </td><td>
113
-
114
- string
115
-
116
-
117
- </td><td>
118
-
119
- Sets the title of the item which is displayed on the tab.
120
-
121
-
122
- </td></tr>
123
- </tbody></table>
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [closable](./foundation-layout.foundationlayoutitem.closable.md) | | boolean | Boolean attribute controls whether the window can be closed in the GUI. Defaults to <code>false</code>. |
29
+ | [registration](./foundation-layout.foundationlayoutitem.registration.md) | | string | Sets the registration name for the item, which can be used later to add the item via the JavaScript API using [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md)<!-- -->. |
30
+ | [size](./foundation-layout.foundationlayoutitem.size.md) | | string | optional string describing the size of the new item (see the written documentation for more info) |
31
+ | [title](./foundation-layout.foundationlayoutitem.title.md) | | string | Sets the title of the item which is displayed on the tab. |
124
32
 
package/docs/api/foundation-layout.foundationlayoutregion.md CHANGED
@@ -23,64 +23,8 @@ This is a simple component which is only used to define the layout splits; any J
23
23
 
24
24
  ## Properties
25
25
 
26
- <table><thead><tr><th>
27
-
28
- Property
29
-
30
-
31
- </th><th>
32
-
33
- Modifiers
34
-
35
-
36
- </th><th>
37
-
38
- Type
39
-
40
-
41
- </th><th>
42
-
43
- Description
44
-
45
-
46
- </th></tr></thead>
47
- <tbody><tr><td>
48
-
49
- [size](./foundation-layout.foundationlayoutregion.size.md)
50
-
51
-
52
- </td><td>
53
-
54
-
55
- </td><td>
56
-
57
- string
58
-
59
-
60
- </td><td>
61
-
62
- optional string describing the size of the new item (see the written documentation for more info)
63
-
64
-
65
- </td></tr>
66
- <tr><td>
67
-
68
- [type](./foundation-layout.foundationlayoutregion.type.md)
69
-
70
-
71
- </td><td>
72
-
73
-
74
- </td><td>
75
-
76
- [LayoutRegionType](./foundation-layout.layoutregiontype.md)
77
-
78
-
79
- </td><td>
80
-
81
- Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to `horizontal`<!-- -->.
82
-
83
-
84
- </td></tr>
85
- </tbody></table>
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [size](./foundation-layout.foundationlayoutregion.size.md) | | string | optional string describing the size of the new item (see the written documentation for more info) |
29
+ | [type](./foundation-layout.foundationlayoutregion.type.md) | | [LayoutRegionType](./foundation-layout.layoutregiontype.md) | Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to <code>horizontal</code>. |
86
30
 
package/docs/api/foundation-layout.layoutcomponentwithstate.applystate.md CHANGED
@@ -14,37 +14,9 @@ applyState(state: T | null): void;
14
14
 
15
15
  ## Parameters
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- state
36
-
37
-
38
- </td><td>
39
-
40
- T \| null
41
-
42
-
43
- </td><td>
44
-
45
-
46
- </td></tr>
47
- </tbody></table>
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | state | T \| null | |
48
20
 
49
21
  **Returns:**
50
22
 
package/docs/api/foundation-layout.layoutcomponentwithstate.md CHANGED
@@ -68,38 +68,8 @@ export class MyComponent extends FASTElement implements LayoutComponentWithState
68
68
 
69
69
  ## Methods
70
70
 
71
- <table><thead><tr><th>
72
-
73
- Method
74
-
75
-
76
- </th><th>
77
-
78
- Description
79
-
80
-
81
- </th></tr></thead>
82
- <tbody><tr><td>
83
-
84
- [applyState(state)](./foundation-layout.layoutcomponentwithstate.applystate.md)
85
-
86
-
87
- </td><td>
88
-
89
- Handle any state that has been saved previously for this instance of this component. It is not deterministic to know whether this is called before the component is appended to the DOM.
90
-
91
-
92
- </td></tr>
93
- <tr><td>
94
-
95
- [getCurrentState()](./foundation-layout.layoutcomponentwithstate.getcurrentstate.md)
96
-
97
-
98
- </td><td>
99
-
100
- Provide the state you wish to save. It is recommended if the component which implements this interface has not fully initialised at the point this is called that you return `null` as the state, following the pattern of `null` being set as the initial state.
101
-
102
-
103
- </td></tr>
104
- </tbody></table>
71
+ | Method | Description |
72
+ | --- | --- |
73
+ | [applyState(state)](./foundation-layout.layoutcomponentwithstate.applystate.md) | Handle any state that has been saved previously for this instance of this component. It is not deterministic to know whether this is called before the component is appended to the DOM. |
74
+ | [getCurrentState()](./foundation-layout.layoutcomponentwithstate.getcurrentstate.md) | Provide the state you wish to save. It is recommended if the component which implements this interface has not fully initialised at the point this is called that you return <code>null</code> as the state, following the pattern of <code>null</code> being set as the initial state. |
105
75
 
package/docs/api/foundation-layout.layoutregistrationerror._constructor_.md CHANGED
@@ -14,35 +14,7 @@ constructor(message: string);
14
14
 
15
15
  ## Parameters
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- message
36
-
37
-
38
- </td><td>
39
-
40
- string
41
-
42
-
43
- </td><td>
44
-
45
-
46
- </td></tr>
47
- </tbody></table>
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | message | string | |
48
20
 
package/docs/api/foundation-layout.layoutregistrationerror.md CHANGED
@@ -14,35 +14,7 @@ export declare class LayoutRegistrationError extends Error
14
14
 
15
15
  ## Constructors
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Constructor
20
-
21
-
22
- </th><th>
23
-
24
- Modifiers
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- [(constructor)(message)](./foundation-layout.layoutregistrationerror._constructor_.md)
36
-
37
-
38
- </td><td>
39
-
40
-
41
- </td><td>
42
-
43
- Constructs a new instance of the `LayoutRegistrationError` class
44
-
45
-
46
- </td></tr>
47
- </tbody></table>
17
+ | Constructor | Modifiers | Description |
18
+ | --- | --- | --- |
19
+ | [(constructor)(message)](./foundation-layout.layoutregistrationerror._constructor_.md) | | Constructs a new instance of the <code>LayoutRegistrationError</code> class |
48
20
 
package/docs/api/foundation-layout.layoutusageerror._constructor_.md CHANGED
@@ -14,35 +14,7 @@ constructor(message: string);
14
14
 
15
15
  ## Parameters
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- message
36
-
37
-
38
- </td><td>
39
-
40
- string
41
-
42
-
43
- </td><td>
44
-
45
-
46
- </td></tr>
47
- </tbody></table>
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | message | string | |
48
20
 
package/docs/api/foundation-layout.layoutusageerror.md CHANGED
@@ -14,35 +14,7 @@ export declare class LayoutUsageError extends Error
14
14
 
15
15
  ## Constructors
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Constructor
20
-
21
-
22
- </th><th>
23
-
24
- Modifiers
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- [(constructor)(message)](./foundation-layout.layoutusageerror._constructor_.md)
36
-
37
-
38
- </td><td>
39
-
40
-
41
- </td><td>
42
-
43
- Constructs a new instance of the `LayoutUsageError` class
44
-
45
-
46
- </td></tr>
47
- </tbody></table>
17
+ | Constructor | Modifiers | Description |
18
+ | --- | --- | --- |
19
+ | [(constructor)(message)](./foundation-layout.layoutusageerror._constructor_.md) | | Constructs a new instance of the <code>LayoutUsageError</code> class |
48
20