@openmrs/esm-framework 7.0.1-pre.3274 → 7.0.1-pre.3282
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +1 -1
- package/docs/interfaces/FeatureFlagDefinition.md +4 -4
- package/docs/interfaces/OpenmrsAppRoutes.md +10 -40
- package/docs/interfaces/ResourceLoader.md +2 -2
- package/docs/interfaces/WorkspaceGroupDefinition.md +3 -3
- package/docs/type-aliases/ExtensionDefinition.md +11 -11
- package/docs/type-aliases/ModalDefinition.md +3 -3
- package/docs/type-aliases/NameUse.md +1 -1
- package/docs/type-aliases/OpenmrsRoutes.md +1 -1
- package/docs/type-aliases/PageDefinition.md +6 -6
- package/docs/type-aliases/WorkspaceDefinition.md +10 -10
- package/docs/type-aliases/WorkspaceWindowState.md +1 -1
- package/package.json +20 -20
- package/docs/interfaces/WorkspaceDefinition2.md +0 -29
- package/docs/interfaces/WorkspaceGroupDefinition2.md +0 -13
- package/docs/interfaces/WorkspaceWindowDefinition2.md +0 -69
package/.turbo/turbo-build.log
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: FeatureFlagDefinition
|
|
4
4
|
|
|
5
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
5
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:296
|
|
6
6
|
|
|
7
7
|
A definition of a feature flag extracted from the routes.json
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ A definition of a feature flag extracted from the routes.json
|
|
|
12
12
|
|
|
13
13
|
> **description**: `string`
|
|
14
14
|
|
|
15
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
15
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:302
|
|
16
16
|
|
|
17
17
|
An explanation of what the flag does, which will be displayed in the Implementer Tools
|
|
18
18
|
|
|
@@ -22,7 +22,7 @@ An explanation of what the flag does, which will be displayed in the Implementer
|
|
|
22
22
|
|
|
23
23
|
> **flagName**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
25
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:298
|
|
26
26
|
|
|
27
27
|
A code-friendly name for the flag, which will be used to reference it in code
|
|
28
28
|
|
|
@@ -32,6 +32,6 @@ A code-friendly name for the flag, which will be used to reference it in code
|
|
|
32
32
|
|
|
33
33
|
> **label**: `string`
|
|
34
34
|
|
|
35
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
35
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:300
|
|
36
36
|
|
|
37
37
|
A human-friendly name which will be displayed in the Implementer Tools
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: OpenmrsAppRoutes
|
|
4
4
|
|
|
5
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
5
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:305
|
|
6
6
|
|
|
7
7
|
This interface describes the format of the routes provided by an app
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ This interface describes the format of the routes provided by an app
|
|
|
12
12
|
|
|
13
13
|
> `optional` **backendDependencies**: `Record`\<`string`, `string`\>
|
|
14
14
|
|
|
15
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
15
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:309
|
|
16
16
|
|
|
17
17
|
A list of backend modules necessary for this frontend module and the corresponding required versions.
|
|
18
18
|
|
|
@@ -22,7 +22,7 @@ A list of backend modules necessary for this frontend module and the correspondi
|
|
|
22
22
|
|
|
23
23
|
> `optional` **extensions**: [`ExtensionDefinition`](../type-aliases/ExtensionDefinition.md)[]
|
|
24
24
|
|
|
25
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
25
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:323
|
|
26
26
|
|
|
27
27
|
An array of all extensions supported by this frontend module. Extensions can be mounted in extension slots, either via declarations in this file or configuration.
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ An array of all extensions supported by this frontend module. Extensions can be
|
|
|
32
32
|
|
|
33
33
|
> `optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
|
|
34
34
|
|
|
35
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
35
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:325
|
|
36
36
|
|
|
37
37
|
An array of all feature flags for any beta-stage features this module provides.
|
|
38
38
|
|
|
@@ -42,7 +42,7 @@ An array of all feature flags for any beta-stage features this module provides.
|
|
|
42
42
|
|
|
43
43
|
> `optional` **modals**: [`ModalDefinition`](../type-aliases/ModalDefinition.md)[]
|
|
44
44
|
|
|
45
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
45
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:327
|
|
46
46
|
|
|
47
47
|
An array of all modals supported by this frontend module. Modals can be launched by name.
|
|
48
48
|
|
|
@@ -52,7 +52,7 @@ An array of all modals supported by this frontend module. Modals can be launched
|
|
|
52
52
|
|
|
53
53
|
> `optional` **optionalBackendDependencies**: `object`
|
|
54
54
|
|
|
55
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
55
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:311
|
|
56
56
|
|
|
57
57
|
A list of backend modules that may enable optional functionality in this frontend module if available and the corresponding required versions.
|
|
58
58
|
|
|
@@ -68,7 +68,7 @@ The name of the backend dependency and either the required version or an object
|
|
|
68
68
|
|
|
69
69
|
> `optional` **pages**: [`PageDefinition`](../type-aliases/PageDefinition.md)[]
|
|
70
70
|
|
|
71
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
71
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:321
|
|
72
72
|
|
|
73
73
|
An array of all pages supported by this frontend module. Pages are automatically mounted based on a route.
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ An array of all pages supported by this frontend module. Pages are automatically
|
|
|
78
78
|
|
|
79
79
|
> `optional` **version**: `string`
|
|
80
80
|
|
|
81
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
81
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:307
|
|
82
82
|
|
|
83
83
|
The version of this frontend module.
|
|
84
84
|
|
|
@@ -88,46 +88,16 @@ The version of this frontend module.
|
|
|
88
88
|
|
|
89
89
|
> `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
|
|
90
90
|
|
|
91
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
91
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:331
|
|
92
92
|
|
|
93
93
|
An array of all workspace groups supported by this frontend module.
|
|
94
94
|
|
|
95
95
|
***
|
|
96
96
|
|
|
97
|
-
### workspaceGroups2?
|
|
98
|
-
|
|
99
|
-
> `optional` **workspaceGroups2**: [`WorkspaceGroupDefinition2`](WorkspaceGroupDefinition2.md)[]
|
|
100
|
-
|
|
101
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:353
|
|
102
|
-
|
|
103
|
-
An array of all workspace groups (v2) supported by this frontend module.
|
|
104
|
-
|
|
105
|
-
***
|
|
106
|
-
|
|
107
97
|
### workspaces?
|
|
108
98
|
|
|
109
99
|
> `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
|
|
110
100
|
|
|
111
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
101
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:329
|
|
112
102
|
|
|
113
103
|
An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
|
|
114
|
-
|
|
115
|
-
***
|
|
116
|
-
|
|
117
|
-
### workspaces2?
|
|
118
|
-
|
|
119
|
-
> `optional` **workspaces2**: [`WorkspaceDefinition2`](WorkspaceDefinition2.md)[]
|
|
120
|
-
|
|
121
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:357
|
|
122
|
-
|
|
123
|
-
An array of all workspaces (v2) supported by this frontend module.
|
|
124
|
-
|
|
125
|
-
***
|
|
126
|
-
|
|
127
|
-
### workspaceWindows2?
|
|
128
|
-
|
|
129
|
-
> `optional` **workspaceWindows2**: [`WorkspaceWindowDefinition2`](WorkspaceWindowDefinition2.md)[]
|
|
130
|
-
|
|
131
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:355
|
|
132
|
-
|
|
133
|
-
An array of all workspace windows (v2) supported by this frontend module.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ResourceLoader()\<T\>
|
|
4
4
|
|
|
5
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
5
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:338
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:364
|
|
|
12
12
|
|
|
13
13
|
> **ResourceLoader**(): `Promise`\<`T`\>
|
|
14
14
|
|
|
15
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
15
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:339
|
|
16
16
|
|
|
17
17
|
## Returns
|
|
18
18
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WorkspaceGroupDefinition
|
|
4
4
|
|
|
5
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
5
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:283
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:285
|
|
|
10
10
|
|
|
11
11
|
> `optional` **members**: `string`[]
|
|
12
12
|
|
|
13
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
13
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:291
|
|
14
14
|
|
|
15
15
|
List of workspace names which are part of the workspace group.
|
|
16
16
|
|
|
@@ -20,6 +20,6 @@ List of workspace names which are part of the workspace group.
|
|
|
20
20
|
|
|
21
21
|
> **name**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
23
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:287
|
|
24
24
|
|
|
25
25
|
Name of the workspace group. This is used to launch the workspace group
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ExtensionDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
7
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:168
|
|
8
8
|
|
|
9
9
|
A definition of an extension as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of an extension as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> **component**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
17
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:210
|
|
18
18
|
|
|
19
19
|
The name of the component exported by this frontend module.
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ The name of the component exported by this frontend module.
|
|
|
24
24
|
|
|
25
25
|
> `optional` **featureFlag**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
27
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:200
|
|
28
28
|
|
|
29
29
|
If supplied, the extension will only be rendered when this feature flag is enabled.
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ If supplied, the extension will only be rendered when this feature flag is enabl
|
|
|
34
34
|
|
|
35
35
|
> `optional` **meta**: `object`
|
|
36
36
|
|
|
37
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
37
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:204
|
|
38
38
|
|
|
39
39
|
Meta describes any properties that are passed down to the extension when it is loaded
|
|
40
40
|
|
|
@@ -48,7 +48,7 @@ Meta describes any properties that are passed down to the extension when it is l
|
|
|
48
48
|
|
|
49
49
|
> **name**: `string`
|
|
50
50
|
|
|
51
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
51
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:172
|
|
52
52
|
|
|
53
53
|
The name of this extension. This is used to refer to the extension in configuration.
|
|
54
54
|
|
|
@@ -58,7 +58,7 @@ The name of this extension. This is used to refer to the extension in configurat
|
|
|
58
58
|
|
|
59
59
|
> `optional` **offline**: `boolean`
|
|
60
60
|
|
|
61
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
61
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:188
|
|
62
62
|
|
|
63
63
|
Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
|
|
64
64
|
|
|
@@ -68,7 +68,7 @@ Determines whether the component renders while the browser is not connected to t
|
|
|
68
68
|
|
|
69
69
|
> `optional` **online**: `boolean`
|
|
70
70
|
|
|
71
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
71
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:184
|
|
72
72
|
|
|
73
73
|
Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ Determines whether the component renders while the browser is connected to the i
|
|
|
78
78
|
|
|
79
79
|
> `optional` **order**: `number`
|
|
80
80
|
|
|
81
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
81
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:192
|
|
82
82
|
|
|
83
83
|
Determines the order in which this component renders in its default extension slot. Note that this can be overridden by configuration.
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ Determines the order in which this component renders in its default extension sl
|
|
|
88
88
|
|
|
89
89
|
> `optional` **privileges**: `string` \| `string`[]
|
|
90
90
|
|
|
91
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
91
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:196
|
|
92
92
|
|
|
93
93
|
The user must have ANY of these privileges to see this extension.
|
|
94
94
|
|
|
@@ -98,7 +98,7 @@ The user must have ANY of these privileges to see this extension.
|
|
|
98
98
|
|
|
99
99
|
> `optional` **slot**: `string`
|
|
100
100
|
|
|
101
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
101
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:176
|
|
102
102
|
|
|
103
103
|
If supplied, the slot that this extension is rendered into by default.
|
|
104
104
|
|
|
@@ -108,6 +108,6 @@ If supplied, the slot that this extension is rendered into by default.
|
|
|
108
108
|
|
|
109
109
|
> `optional` **slots**: `string`[]
|
|
110
110
|
|
|
111
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
111
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:180
|
|
112
112
|
|
|
113
113
|
If supplied, the slots that this extension is rendered into by default.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ModalDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
7
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:215
|
|
8
8
|
|
|
9
9
|
A definition of a modal as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of a modal as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> **component**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
17
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:223
|
|
18
18
|
|
|
19
19
|
The name of the component exported by this frontend module.
|
|
20
20
|
|
|
@@ -24,6 +24,6 @@ The name of the component exported by this frontend module.
|
|
|
24
24
|
|
|
25
25
|
> **name**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
27
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:219
|
|
28
28
|
|
|
29
29
|
The name of this modal. This is used to launch the modal.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **OpenmrsRoutes** = `Record`\<`string`, [`OpenmrsAppRoutes`](../interfaces/OpenmrsAppRoutes.md)\>
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
7
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:337
|
|
8
8
|
|
|
9
9
|
This interfaces describes the format of the overall routes.json loaded by the app shell.
|
|
10
10
|
Basically, this is the same as the app routes, with each routes definition keyed by the app's name
|
|
@@ -16,6 +16,12 @@ A definition of a page extracted from an app's routes.json
|
|
|
16
16
|
|
|
17
17
|
The name of the component exported by this frontend module.
|
|
18
18
|
|
|
19
|
+
### containerDomId?
|
|
20
|
+
|
|
21
|
+
> `optional` **containerDomId**: `string`
|
|
22
|
+
|
|
23
|
+
If supplied, the page will be rendered within the DOM element with the specified ID. Defaults to "omrs-apps-container" if not supplied.
|
|
24
|
+
|
|
19
25
|
### featureFlag?
|
|
20
26
|
|
|
21
27
|
> `optional` **featureFlag**: `string`
|
|
@@ -33,9 +39,3 @@ Determines whether the component renders while the browser is not connected to t
|
|
|
33
39
|
> `optional` **online**: `boolean`
|
|
34
40
|
|
|
35
41
|
Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
|
|
36
|
-
|
|
37
|
-
### order?
|
|
38
|
-
|
|
39
|
-
> `optional` **order**: `number`
|
|
40
|
-
|
|
41
|
-
Determines the order in which this page is rendered in the app-shell, which is useful for situations where DOM ordering matters.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **WorkspaceDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
7
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:229
|
|
8
8
|
|
|
9
9
|
A definition of a workspace as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of a workspace as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> `optional` **canHide**: `boolean`
|
|
16
16
|
|
|
17
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
17
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:245
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:247
|
|
|
22
22
|
|
|
23
23
|
> `optional` **canMaximize**: `boolean`
|
|
24
24
|
|
|
25
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
25
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:246
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:248
|
|
|
30
30
|
|
|
31
31
|
> **component**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
33
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:281
|
|
34
34
|
|
|
35
35
|
The name of the component exported by this frontend module.
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ The name of the component exported by this frontend module.
|
|
|
40
40
|
|
|
41
41
|
> **groups**: `string`[]
|
|
42
42
|
|
|
43
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
43
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:277
|
|
44
44
|
|
|
45
45
|
Workspaces can open either independently or as part of a "workspace group". A
|
|
46
46
|
"workspace group" groups related workspaces together, so that only one is visible
|
|
@@ -68,7 +68,7 @@ name, the entire workspace group will close, and the new workspace will launch i
|
|
|
68
68
|
|
|
69
69
|
> **name**: `string`
|
|
70
70
|
|
|
71
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
71
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:233
|
|
72
72
|
|
|
73
73
|
The name of this workspace. This is used to launch the workspace.
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ The name of this workspace. This is used to launch the workspace.
|
|
|
78
78
|
|
|
79
79
|
> `optional` **preferredWindowSize**: [`WorkspaceWindowState`](WorkspaceWindowState.md)
|
|
80
80
|
|
|
81
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
81
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:256
|
|
82
82
|
|
|
83
83
|
Launches the workspace in the preferred size, it defaults to the 'narrow' width
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ Launches the workspace in the preferred size, it defaults to the 'narrow' width
|
|
|
88
88
|
|
|
89
89
|
> **title**: `string`
|
|
90
90
|
|
|
91
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
91
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:238
|
|
92
92
|
|
|
93
93
|
The title of the workspace. This will be looked up as a key in the translations of the module
|
|
94
94
|
defining the workspace.
|
|
@@ -99,7 +99,7 @@ defining the workspace.
|
|
|
99
99
|
|
|
100
100
|
> **type**: `string`
|
|
101
101
|
|
|
102
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
102
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:244
|
|
103
103
|
|
|
104
104
|
The type of the workspace. Only one of each "type" of workspace is allowed to be open at a
|
|
105
105
|
time. The default is "form". If the right sidebar is in use, then the type determines which
|
|
@@ -111,7 +111,7 @@ right sidebar icon corresponds to the workspace.
|
|
|
111
111
|
|
|
112
112
|
> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
|
|
113
113
|
|
|
114
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:
|
|
114
|
+
Defined in: packages/framework/esm-globals/dist/types.d.ts:252
|
|
115
115
|
|
|
116
116
|
Controls the width of the workspace. The default is "narrow" and this should only be
|
|
117
117
|
changed to "wider" if the workspace itself has internal navigation, like the form editor.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "7.0.1-pre.
|
|
3
|
+
"version": "7.0.1-pre.3282",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "dist/openmrs-esm-framework.js",
|
|
@@ -59,24 +59,24 @@
|
|
|
59
59
|
"access": "public"
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
|
-
"@openmrs/esm-api": "7.0.1-pre.
|
|
63
|
-
"@openmrs/esm-config": "7.0.1-pre.
|
|
64
|
-
"@openmrs/esm-context": "7.0.1-pre.
|
|
65
|
-
"@openmrs/esm-dynamic-loading": "7.0.1-pre.
|
|
66
|
-
"@openmrs/esm-emr-api": "7.0.1-pre.
|
|
67
|
-
"@openmrs/esm-error-handling": "7.0.1-pre.
|
|
68
|
-
"@openmrs/esm-expression-evaluator": "7.0.1-pre.
|
|
69
|
-
"@openmrs/esm-extensions": "7.0.1-pre.
|
|
70
|
-
"@openmrs/esm-feature-flags": "7.0.1-pre.
|
|
71
|
-
"@openmrs/esm-globals": "7.0.1-pre.
|
|
72
|
-
"@openmrs/esm-navigation": "7.0.1-pre.
|
|
73
|
-
"@openmrs/esm-offline": "7.0.1-pre.
|
|
74
|
-
"@openmrs/esm-react-utils": "7.0.1-pre.
|
|
75
|
-
"@openmrs/esm-routes": "7.0.1-pre.
|
|
76
|
-
"@openmrs/esm-state": "7.0.1-pre.
|
|
77
|
-
"@openmrs/esm-styleguide": "7.0.1-pre.
|
|
78
|
-
"@openmrs/esm-translations": "7.0.1-pre.
|
|
79
|
-
"@openmrs/esm-utils": "7.0.1-pre.
|
|
62
|
+
"@openmrs/esm-api": "7.0.1-pre.3282",
|
|
63
|
+
"@openmrs/esm-config": "7.0.1-pre.3282",
|
|
64
|
+
"@openmrs/esm-context": "7.0.1-pre.3282",
|
|
65
|
+
"@openmrs/esm-dynamic-loading": "7.0.1-pre.3282",
|
|
66
|
+
"@openmrs/esm-emr-api": "7.0.1-pre.3282",
|
|
67
|
+
"@openmrs/esm-error-handling": "7.0.1-pre.3282",
|
|
68
|
+
"@openmrs/esm-expression-evaluator": "7.0.1-pre.3282",
|
|
69
|
+
"@openmrs/esm-extensions": "7.0.1-pre.3282",
|
|
70
|
+
"@openmrs/esm-feature-flags": "7.0.1-pre.3282",
|
|
71
|
+
"@openmrs/esm-globals": "7.0.1-pre.3282",
|
|
72
|
+
"@openmrs/esm-navigation": "7.0.1-pre.3282",
|
|
73
|
+
"@openmrs/esm-offline": "7.0.1-pre.3282",
|
|
74
|
+
"@openmrs/esm-react-utils": "7.0.1-pre.3282",
|
|
75
|
+
"@openmrs/esm-routes": "7.0.1-pre.3282",
|
|
76
|
+
"@openmrs/esm-state": "7.0.1-pre.3282",
|
|
77
|
+
"@openmrs/esm-styleguide": "7.0.1-pre.3282",
|
|
78
|
+
"@openmrs/esm-translations": "7.0.1-pre.3282",
|
|
79
|
+
"@openmrs/esm-utils": "7.0.1-pre.3282"
|
|
80
80
|
},
|
|
81
81
|
"peerDependencies": {
|
|
82
82
|
"dayjs": "1.x",
|
|
@@ -89,7 +89,7 @@
|
|
|
89
89
|
"swr": "2.x"
|
|
90
90
|
},
|
|
91
91
|
"devDependencies": {
|
|
92
|
-
"@openmrs/typedoc-plugin-file-categories": "7.0.1-pre.
|
|
92
|
+
"@openmrs/typedoc-plugin-file-categories": "7.0.1-pre.3282",
|
|
93
93
|
"@rspack/cli": "^1.3.11",
|
|
94
94
|
"@rspack/core": "^1.3.11",
|
|
95
95
|
"concurrently": "^9.1.2",
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[O3 Framework](../API.md) / WorkspaceDefinition2
|
|
2
|
-
|
|
3
|
-
# Interface: WorkspaceDefinition2
|
|
4
|
-
|
|
5
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:308
|
|
6
|
-
|
|
7
|
-
## Properties
|
|
8
|
-
|
|
9
|
-
### component
|
|
10
|
-
|
|
11
|
-
> **component**: `string`
|
|
12
|
-
|
|
13
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:310
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### name
|
|
18
|
-
|
|
19
|
-
> **name**: `string`
|
|
20
|
-
|
|
21
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:309
|
|
22
|
-
|
|
23
|
-
***
|
|
24
|
-
|
|
25
|
-
### window
|
|
26
|
-
|
|
27
|
-
> **window**: `string`
|
|
28
|
-
|
|
29
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:311
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
[O3 Framework](../API.md) / WorkspaceGroupDefinition2
|
|
2
|
-
|
|
3
|
-
# Interface: WorkspaceGroupDefinition2
|
|
4
|
-
|
|
5
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:295
|
|
6
|
-
|
|
7
|
-
## Properties
|
|
8
|
-
|
|
9
|
-
### name
|
|
10
|
-
|
|
11
|
-
> **name**: `string`
|
|
12
|
-
|
|
13
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:296
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
[O3 Framework](../API.md) / WorkspaceWindowDefinition2
|
|
2
|
-
|
|
3
|
-
# Interface: WorkspaceWindowDefinition2
|
|
4
|
-
|
|
5
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:298
|
|
6
|
-
|
|
7
|
-
## Properties
|
|
8
|
-
|
|
9
|
-
### canHide
|
|
10
|
-
|
|
11
|
-
> **canHide**: `boolean`
|
|
12
|
-
|
|
13
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:301
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### canMaximize
|
|
18
|
-
|
|
19
|
-
> **canMaximize**: `boolean`
|
|
20
|
-
|
|
21
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:302
|
|
22
|
-
|
|
23
|
-
***
|
|
24
|
-
|
|
25
|
-
### group
|
|
26
|
-
|
|
27
|
-
> **group**: `string`
|
|
28
|
-
|
|
29
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:304
|
|
30
|
-
|
|
31
|
-
***
|
|
32
|
-
|
|
33
|
-
### icon?
|
|
34
|
-
|
|
35
|
-
> `optional` **icon**: `string`
|
|
36
|
-
|
|
37
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:300
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### name
|
|
42
|
-
|
|
43
|
-
> **name**: `string`
|
|
44
|
-
|
|
45
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:299
|
|
46
|
-
|
|
47
|
-
***
|
|
48
|
-
|
|
49
|
-
### order?
|
|
50
|
-
|
|
51
|
-
> `optional` **order**: `number`
|
|
52
|
-
|
|
53
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:305
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### overlay
|
|
58
|
-
|
|
59
|
-
> **overlay**: `boolean`
|
|
60
|
-
|
|
61
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:303
|
|
62
|
-
|
|
63
|
-
***
|
|
64
|
-
|
|
65
|
-
### width?
|
|
66
|
-
|
|
67
|
-
> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
|
|
68
|
-
|
|
69
|
-
Defined in: packages/framework/esm-globals/dist/types.d.ts:306
|