@openmrs/esm-framework 10.0.1-pre.5498 → 10.0.1-pre.5501
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/API.md +1 -0
- package/docs/functions/useExtensionContext.md +17 -0
- package/docs/interfaces/ComponentConfig.md +4 -4
- package/docs/interfaces/ExtensionData.md +12 -4
- package/docs/interfaces/FeatureFlagDefinition.md +4 -4
- package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
- package/docs/interfaces/OpenmrsRoutes.md +3 -3
- package/docs/interfaces/ResourceLoader.md +2 -2
- package/docs/interfaces/Workspace2DefinitionProps.md +15 -4
- package/docs/interfaces/WorkspaceDefinition2.md +15 -0
- package/docs/type-aliases/NameUse.md +1 -1
- package/docs/type-aliases/Workspace2Definition.md +1 -1
- package/docs/variables/Workspace2.md +1 -1
- package/package.json +20 -20
package/.turbo/turbo-build.log
CHANGED
package/docs/API.md
CHANGED
|
@@ -151,6 +151,7 @@
|
|
|
151
151
|
- [ExtensionSlotProps](interfaces/ExtensionSlotProps.md)
|
|
152
152
|
- [~~useAssignedExtensionIds~~](functions/useAssignedExtensionIds.md)
|
|
153
153
|
- [useAssignedExtensions](functions/useAssignedExtensions.md)
|
|
154
|
+
- [useExtensionContext](functions/useExtensionContext.md)
|
|
154
155
|
- [useExtensionSlotMeta](functions/useExtensionSlotMeta.md)
|
|
155
156
|
- [useExtensionSlotStore](functions/useExtensionSlotStore.md)
|
|
156
157
|
- [useRenderableExtensions](functions/useRenderableExtensions.md)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[O3 Framework](../API.md) / useExtensionContext
|
|
2
|
+
|
|
3
|
+
# Function: useExtensionContext()
|
|
4
|
+
|
|
5
|
+
> **useExtensionContext**(): `undefined` \| [`ExtensionData`](../interfaces/ExtensionData.md)
|
|
6
|
+
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useExtensionContext.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionContext.ts#L12)
|
|
8
|
+
|
|
9
|
+
A hook for a component rendered as an extension to access its extension context: the slot and
|
|
10
|
+
slot module it is rendered in, its extension ID, and its `meta` from the extension's registration.
|
|
11
|
+
|
|
12
|
+
## Returns
|
|
13
|
+
|
|
14
|
+
`undefined` \| [`ExtensionData`](../interfaces/ExtensionData.md)
|
|
15
|
+
|
|
16
|
+
The extension context, or `undefined` when the calling component is not being rendered
|
|
17
|
+
as an extension (a page, modal or workspace, say).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ComponentConfig
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L10)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-extensions/src/types.ts:7](https://github.co
|
|
|
10
10
|
|
|
11
11
|
> `optional` **extension**: [`ExtensionData`](ExtensionData.md)
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L13)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-extensions/src/types.ts:10](https://github.c
|
|
|
18
18
|
|
|
19
19
|
> **featureName**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-extensions/src/types.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L12)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,4 +26,4 @@ Defined in: [packages/framework/esm-extensions/src/types.ts:9](https://github.co
|
|
|
26
26
|
|
|
27
27
|
> **moduleName**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-extensions/src/types.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L11)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ExtensionData
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L3)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,15 @@ Defined in: [packages/framework/esm-extensions/src/types.ts:1](https://github.co
|
|
|
10
10
|
|
|
11
11
|
> **extensionId**: `string`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L6)
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### extensionMeta?
|
|
18
|
+
|
|
19
|
+
> `optional` **extensionMeta**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
|
|
20
|
+
|
|
21
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L7)
|
|
14
22
|
|
|
15
23
|
***
|
|
16
24
|
|
|
@@ -18,7 +26,7 @@ Defined in: [packages/framework/esm-extensions/src/types.ts:4](https://github.co
|
|
|
18
26
|
|
|
19
27
|
> **extensionSlotModuleName**: `string`
|
|
20
28
|
|
|
21
|
-
Defined in: [packages/framework/esm-extensions/src/types.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L5)
|
|
22
30
|
|
|
23
31
|
***
|
|
24
32
|
|
|
@@ -26,4 +34,4 @@ Defined in: [packages/framework/esm-extensions/src/types.ts:3](https://github.co
|
|
|
26
34
|
|
|
27
35
|
> **extensionSlotName**: `string`
|
|
28
36
|
|
|
29
|
-
Defined in: [packages/framework/esm-extensions/src/types.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-extensions/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L4)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: FeatureFlagDefinition
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:361](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L361)
|
|
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/src/types.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:367](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L367)
|
|
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/src/types.ts:
|
|
25
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:363](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L363)
|
|
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/src/types.ts:
|
|
35
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:365](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L365)
|
|
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/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:371](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L371)
|
|
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/src/types.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:375](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L375)
|
|
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/src/types.ts:
|
|
25
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:391](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L391)
|
|
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/src/types.ts:
|
|
35
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:393](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L393)
|
|
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/src/types.ts:
|
|
45
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:395](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L395)
|
|
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/src/types.ts:
|
|
55
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:377](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L377)
|
|
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/src/types.ts:
|
|
71
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L389)
|
|
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/src/types.ts:
|
|
81
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:373](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L373)
|
|
82
82
|
|
|
83
83
|
The version of this frontend module.
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ The version of this frontend module.
|
|
|
88
88
|
|
|
89
89
|
> `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
|
|
90
90
|
|
|
91
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
91
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:399](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L399)
|
|
92
92
|
|
|
93
93
|
An array of all workspace groups supported by this frontend module.
|
|
94
94
|
|
|
@@ -98,7 +98,7 @@ An array of all workspace groups supported by this frontend module.
|
|
|
98
98
|
|
|
99
99
|
> `optional` **workspaceGroups2**: [`WorkspaceGroupDefinition2`](WorkspaceGroupDefinition2.md)[]
|
|
100
100
|
|
|
101
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
101
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:402](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L402)
|
|
102
102
|
|
|
103
103
|
An array of all workspace groups (v2) supported by this frontend module.
|
|
104
104
|
|
|
@@ -108,7 +108,7 @@ An array of all workspace groups (v2) supported by this frontend module.
|
|
|
108
108
|
|
|
109
109
|
> `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
|
|
110
110
|
|
|
111
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
111
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:397](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L397)
|
|
112
112
|
|
|
113
113
|
An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
|
|
114
114
|
|
|
@@ -118,7 +118,7 @@ An array of all workspaces supported by this frontend module. Workspaces can be
|
|
|
118
118
|
|
|
119
119
|
> `optional` **workspaces2**: [`WorkspaceDefinition2`](WorkspaceDefinition2.md)[]
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
121
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:408](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L408)
|
|
122
122
|
|
|
123
123
|
An array of all workspaces (v2) supported by this frontend module.
|
|
124
124
|
|
|
@@ -128,6 +128,6 @@ An array of all workspaces (v2) supported by this frontend module.
|
|
|
128
128
|
|
|
129
129
|
> `optional` **workspaceWindows2**: [`WorkspaceWindowDefinition2`](WorkspaceWindowDefinition2.md)[]
|
|
130
130
|
|
|
131
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
131
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:405](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L405)
|
|
132
132
|
|
|
133
133
|
An array of all workspace windows (v2) supported by this frontend module.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: OpenmrsRoutes
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:415](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L415)
|
|
6
6
|
|
|
7
7
|
This interfaces describes the format of the overall routes.json loaded by the app shell.
|
|
8
8
|
Basically, this is the same as the app routes, with each routes definition keyed by the app's name
|
|
@@ -13,7 +13,7 @@ Basically, this is the same as the app routes, with each routes definition keyed
|
|
|
13
13
|
|
|
14
14
|
> **routes**: `Record`\<`Exclude`\<`string`, `"version"`\>, [`OpenmrsAppRoutes`](OpenmrsAppRoutes.md)\>
|
|
15
15
|
|
|
16
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
16
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:419](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L419)
|
|
17
17
|
|
|
18
18
|
The routes associated with this application keyed by module id
|
|
19
19
|
|
|
@@ -23,6 +23,6 @@ The routes associated with this application keyed by module id
|
|
|
23
23
|
|
|
24
24
|
> `optional` **version**: `string`
|
|
25
25
|
|
|
26
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
26
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:417](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L417)
|
|
27
27
|
|
|
28
28
|
The overall version for this application
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ResourceLoader()\<T\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:422](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L422)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:415](https://github.com
|
|
|
12
12
|
|
|
13
13
|
> **ResourceLoader**(): `Promise`\<`T`\>
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:423](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L423)
|
|
16
16
|
|
|
17
17
|
## Returns
|
|
18
18
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
32
32
|
|
|
33
33
|
> **isRootWorkspace**: `boolean`
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
35
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L51)
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
40
40
|
|
|
41
41
|
> **showActionMenu**: `boolean`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
43
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L52)
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
@@ -48,7 +48,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
48
48
|
|
|
49
49
|
> **windowName**: `string`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
51
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L50)
|
|
52
52
|
|
|
53
53
|
***
|
|
54
54
|
|
|
@@ -60,11 +60,22 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
60
60
|
|
|
61
61
|
***
|
|
62
62
|
|
|
63
|
+
### workspaceMeta?
|
|
64
|
+
|
|
65
|
+
> `optional` **workspaceMeta**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
|
|
66
|
+
|
|
67
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L48)
|
|
68
|
+
|
|
69
|
+
The workspace's `meta` from its registration (the `meta` field of its `workspaces2` entry in
|
|
70
|
+
`routes.json`).
|
|
71
|
+
|
|
72
|
+
***
|
|
73
|
+
|
|
63
74
|
### workspaceName
|
|
64
75
|
|
|
65
76
|
> **workspaceName**: `string`
|
|
66
77
|
|
|
67
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
78
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L49)
|
|
68
79
|
|
|
69
80
|
***
|
|
70
81
|
|
|
@@ -14,6 +14,21 @@ Defined in: [packages/framework/esm-globals/src/types.ts:347](https://github.com
|
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
+
### meta?
|
|
18
|
+
|
|
19
|
+
> `optional` **meta**: `object`
|
|
20
|
+
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:353](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L353)
|
|
22
|
+
|
|
23
|
+
Meta describes any properties that are passed down to the workspace when it is loaded. It is
|
|
24
|
+
available to the workspace component via `useWorkspace2Context().workspaceMeta`.
|
|
25
|
+
|
|
26
|
+
#### Index Signature
|
|
27
|
+
|
|
28
|
+
\[`k`: `string`\]: `unknown`
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
17
32
|
### name
|
|
18
33
|
|
|
19
34
|
> **name**: `string`
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:429](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L429)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **Workspace2Definition**\<`WorkspaceProps`, `WindowProps`, `GroupProps`\> = `React.FC`\<[`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`WorkspaceProps`, `WindowProps`, `GroupProps`\>\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L55)
|
|
8
8
|
|
|
9
9
|
## Type Parameters
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **Workspace2**: `React.FC`\<`Workspace2Props`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L67)
|
|
8
8
|
|
|
9
9
|
The Workspace2 component is used as a top-level container to render
|
|
10
10
|
its children as content within a workspace. When creating a workspace
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "10.0.1-pre.
|
|
3
|
+
"version": "10.0.1-pre.5501",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -60,24 +60,24 @@
|
|
|
60
60
|
"access": "public"
|
|
61
61
|
},
|
|
62
62
|
"dependencies": {
|
|
63
|
-
"@openmrs/esm-api": "10.0.1-pre.
|
|
64
|
-
"@openmrs/esm-config": "10.0.1-pre.
|
|
65
|
-
"@openmrs/esm-context": "10.0.1-pre.
|
|
66
|
-
"@openmrs/esm-dynamic-loading": "10.0.1-pre.
|
|
67
|
-
"@openmrs/esm-emr-api": "10.0.1-pre.
|
|
68
|
-
"@openmrs/esm-error-handling": "10.0.1-pre.
|
|
69
|
-
"@openmrs/esm-expression-evaluator": "10.0.1-pre.
|
|
70
|
-
"@openmrs/esm-extensions": "10.0.1-pre.
|
|
71
|
-
"@openmrs/esm-feature-flags": "10.0.1-pre.
|
|
72
|
-
"@openmrs/esm-globals": "10.0.1-pre.
|
|
73
|
-
"@openmrs/esm-navigation": "10.0.1-pre.
|
|
74
|
-
"@openmrs/esm-offline": "10.0.1-pre.
|
|
75
|
-
"@openmrs/esm-react-utils": "10.0.1-pre.
|
|
76
|
-
"@openmrs/esm-routes": "10.0.1-pre.
|
|
77
|
-
"@openmrs/esm-state": "10.0.1-pre.
|
|
78
|
-
"@openmrs/esm-styleguide": "10.0.1-pre.
|
|
79
|
-
"@openmrs/esm-translations": "10.0.1-pre.
|
|
80
|
-
"@openmrs/esm-utils": "10.0.1-pre.
|
|
63
|
+
"@openmrs/esm-api": "10.0.1-pre.5501",
|
|
64
|
+
"@openmrs/esm-config": "10.0.1-pre.5501",
|
|
65
|
+
"@openmrs/esm-context": "10.0.1-pre.5501",
|
|
66
|
+
"@openmrs/esm-dynamic-loading": "10.0.1-pre.5501",
|
|
67
|
+
"@openmrs/esm-emr-api": "10.0.1-pre.5501",
|
|
68
|
+
"@openmrs/esm-error-handling": "10.0.1-pre.5501",
|
|
69
|
+
"@openmrs/esm-expression-evaluator": "10.0.1-pre.5501",
|
|
70
|
+
"@openmrs/esm-extensions": "10.0.1-pre.5501",
|
|
71
|
+
"@openmrs/esm-feature-flags": "10.0.1-pre.5501",
|
|
72
|
+
"@openmrs/esm-globals": "10.0.1-pre.5501",
|
|
73
|
+
"@openmrs/esm-navigation": "10.0.1-pre.5501",
|
|
74
|
+
"@openmrs/esm-offline": "10.0.1-pre.5501",
|
|
75
|
+
"@openmrs/esm-react-utils": "10.0.1-pre.5501",
|
|
76
|
+
"@openmrs/esm-routes": "10.0.1-pre.5501",
|
|
77
|
+
"@openmrs/esm-state": "10.0.1-pre.5501",
|
|
78
|
+
"@openmrs/esm-styleguide": "10.0.1-pre.5501",
|
|
79
|
+
"@openmrs/esm-translations": "10.0.1-pre.5501",
|
|
80
|
+
"@openmrs/esm-utils": "10.0.1-pre.5501"
|
|
81
81
|
},
|
|
82
82
|
"peerDependencies": {
|
|
83
83
|
"dayjs": "1.x",
|
|
@@ -90,7 +90,7 @@
|
|
|
90
90
|
"swr": "2.x"
|
|
91
91
|
},
|
|
92
92
|
"devDependencies": {
|
|
93
|
-
"@openmrs/typedoc-plugin-file-categories": "10.0.1-pre.
|
|
93
|
+
"@openmrs/typedoc-plugin-file-categories": "10.0.1-pre.5501",
|
|
94
94
|
"@swc/cli": "0.8.1",
|
|
95
95
|
"@swc/core": "1.15.21",
|
|
96
96
|
"@vitest/coverage-v8": "^4.1.2",
|