@openmrs/esm-framework 8.0.1-pre.3349 → 8.0.1-pre.3360

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.
@@ -0,0 +1,19 @@
1
+ [O3 Framework](../API.md) / closeWorkspaceGroup2
2
+
3
+ # Function: closeWorkspaceGroup2()
4
+
5
+ > **closeWorkspaceGroup2**(): `Promise`\<`boolean`\>
6
+
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L69)
8
+
9
+ **`Experimental`**
10
+
11
+ Closes the workspace group that is currently opened. Note that only one workspace group
12
+ may be opened at any given time
13
+
14
+ ## Returns
15
+
16
+ `Promise`\<`boolean`\>
17
+
18
+ a Promise that resolves to true if there is no opened group to begin with or we successfully closed
19
+ the opened group; false otherwise.
@@ -17,7 +17,7 @@ invalid key to this function will result in a type error.
17
17
 
18
18
  ### key
19
19
 
20
- `"error"` | `"delete"` | `"actions"` | `"address"` | `"age"` | `"cancel"` | `"change"` | `"Clinic"` | `"close"` | `"confirm"` | `"contactAdministratorIfIssuePersists"` | `"contactDetails"` | `"edit"` | `"errorCopy"` | `"female"` | `"loading"` | `"male"` | `"other"` | `"patientIdentifierSticker"` | `"patientLists"` | `"print"` | `"printError"` | `"printErrorExplainer"` | `"printIdentifierSticker"` | `"printing"` | `"relationships"` | `"resetOverrides"` | `"save"` | `"scriptLoadingFailed"` | `"scriptLoadingError"` | `"seeMoreLists"` | `"sex"` | `"showLess"` | `"showMore"` | `"toggleDevTools"` | `"unknown"` | `"closeAllOpenedWorkspaces"` | `"closingAllWorkspacesPromptBody"` | `"closingAllWorkspacesPromptTitle"` | `"discard"` | `"hide"` | `"maximize"` | `"minimize"` | `"openAnyway"` | `"unsavedChangesInOpenedWorkspace"` | `"unsavedChangesInWorkspace"` | `"unsavedChangesTitleText"` | `"workspaceHeader"` | `"address1"` | `"address2"` | `"address3"` | `"address4"` | `"address5"` | `"address6"` | `"city"` | `"cityVillage"` | `"country"` | `"countyDistrict"` | `"district"` | `"postalCode"` | `"state"` | `"stateProvince"`
20
+ `"error"` | `"delete"` | `"actions"` | `"address"` | `"age"` | `"cancel"` | `"change"` | `"Clinic"` | `"close"` | `"confirm"` | `"contactAdministratorIfIssuePersists"` | `"contactDetails"` | `"edit"` | `"errorCopy"` | `"female"` | `"loading"` | `"male"` | `"other"` | `"patientIdentifierSticker"` | `"patientLists"` | `"print"` | `"printError"` | `"printErrorExplainer"` | `"printIdentifierSticker"` | `"printing"` | `"relationships"` | `"resetOverrides"` | `"save"` | `"scriptLoadingFailed"` | `"scriptLoadingError"` | `"seeMoreLists"` | `"sex"` | `"showLess"` | `"showMore"` | `"toggleDevTools"` | `"unknown"` | `"closeWorkspaces2PromptTitle"` | `"closeWorkspaces2PromptBody"` | `"closeAllOpenedWorkspaces"` | `"closingAllWorkspacesPromptBody"` | `"closingAllWorkspacesPromptTitle"` | `"discard"` | `"hide"` | `"maximize"` | `"minimize"` | `"openAnyway"` | `"unsavedChangesInOpenedWorkspace"` | `"unsavedChangesInWorkspace"` | `"unsavedChangesTitleText"` | `"workspaceHeader"` | `"address1"` | `"address2"` | `"address3"` | `"address4"` | `"address5"` | `"address6"` | `"city"` | `"cityVillage"` | `"country"` | `"countyDistrict"` | `"district"` | `"postalCode"` | `"state"` | `"stateProvince"`
21
21
 
22
22
  ### defaultText?
23
23
 
@@ -0,0 +1,79 @@
1
+ [O3 Framework](../API.md) / launchWorkspace2
2
+
3
+ # Function: launchWorkspace2()
4
+
5
+ > **launchWorkspace2**\<`WorkspaceProps`, `WindowProps`, `GroupProp`\>(`workspaceName`, `workspaceProps`, `windowProps`, `groupProps`): `Promise`\<`boolean`\>
6
+
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L127)
8
+
9
+ **`Experimental`**
10
+
11
+ Attempts to launch the specified workspace with the given workspace props. This also implicitly opens
12
+ the workspace window to which the workspace belongs (if it's not opened already),
13
+ and the workspace group to which the window belongs (if it's not opened already).
14
+
15
+ When calling `launchWorkspace2`, we need to also pass in the workspace props. While not required,
16
+ we can also pass in the window props (shared by other workspaces in the window) and the group props
17
+ (shared by all windows and their workspaces). Omitting the window props or the group props[^1] means the caller
18
+ explicitly does not care what the current window props and group props are, and that they may be set
19
+ by other actions (like calling `launchWorkspace2` on a different workspace with those props passed in)
20
+ at a later time.
21
+
22
+ If there is already an opened workspace group, and it's not the group the workspace belongs to
23
+ or has incompatible[^2] group props, then we prompt the user to close the group (and its windows and their workspaces).
24
+ On user confirm, the existing opened group is closed and the new workspace, along with its window and its group,
25
+ is opened.
26
+
27
+ If the window is already opened, but with incompatible window props, we prompt the user to close
28
+ the window (and all its opened workspaces), and reopen the window with (only) the newly requested workspace.
29
+
30
+ If the workspace is already opened, but with incompatible workspace props, we also prompt the user to close
31
+ the **window** (and all its opened workspaces), and reopen the window with (only) the newly requested workspace.
32
+ This is true regardless of whether the already opened workspace has any child workspaces.
33
+
34
+ Note that calling this function *never* results in creating a child workspace in the affected window.
35
+ To do so, we need to call `launchChildWorkspace` instead.
36
+
37
+ [^1] Omitting window or group props is useful for workspaces that don't have ties to the window or group "context" (props).
38
+ For example, in the patient chart, the visit notes / clinical forms / order basket action menu button all share
39
+ a "group context" of the current visit. However, the "patient list" action menu button does not need to share that group
40
+ context, so opening that workspace should not need to cause other workspaces / windows / groups to potentially close.
41
+ The "patient search" workspace in the queues and ward apps is another example.
42
+
43
+ [^2] 2 sets of props are compatible if either one is nullish, or if they are shallow equal.
44
+
45
+ ## Type Parameters
46
+
47
+ ### WorkspaceProps
48
+
49
+ `WorkspaceProps` *extends* `object`
50
+
51
+ ### WindowProps
52
+
53
+ `WindowProps` *extends* `object`
54
+
55
+ ### GroupProp
56
+
57
+ `GroupProp` *extends* `object`
58
+
59
+ ## Parameters
60
+
61
+ ### workspaceName
62
+
63
+ `string`
64
+
65
+ ### workspaceProps
66
+
67
+ `null` | `WorkspaceProps`
68
+
69
+ ### windowProps
70
+
71
+ `null` | `WindowProps`
72
+
73
+ ### groupProps
74
+
75
+ `null` | `GroupProp`
76
+
77
+ ## Returns
78
+
79
+ `Promise`\<`boolean`\>
@@ -0,0 +1,40 @@
1
+ [O3 Framework](../API.md) / launchWorkspaceGroup2
2
+
3
+ # Function: launchWorkspaceGroup2()
4
+
5
+ > **launchWorkspaceGroup2**\<`GroupProps`\>(`groupName`, `groupProps`): `Promise`\<`boolean`\>
6
+
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L29)
8
+
9
+ **`Experimental`**
10
+
11
+ Attempts to launch the specified workspace group with the given group props. Note that only one workspace group
12
+ may be opened at any given time. If a workspace group is already opened, calling `launchWorkspaceGroup2` with
13
+ either a different group name, or same group name but different incompatible props**, will result in prompting to
14
+ confirm closing workspaces. If the user confirms, the opened group, along with its windows (and their workspaces), is closed, and
15
+ the requested group is immediately opened.
16
+
17
+ ** 2 sets of props are compatible if either one is nullish, or if they are shallow equal.
18
+
19
+ ## Type Parameters
20
+
21
+ ### GroupProps
22
+
23
+ `GroupProps` *extends* `object`
24
+
25
+ ## Parameters
26
+
27
+ ### groupName
28
+
29
+ `string`
30
+
31
+ ### groupProps
32
+
33
+ `null` | `GroupProps`
34
+
35
+ ## Returns
36
+
37
+ `Promise`\<`boolean`\>
38
+
39
+ a Promise that resolves to true if the specified workspace group with the specified group props
40
+ is successfully opened, or that it already is opened.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: FeatureFlagDefinition
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:296
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:316
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:302
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:322
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:298
25
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:318
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:300
35
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:320
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:305
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:325
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:309
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:329
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:323
25
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:343
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:325
35
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:345
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:327
45
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:347
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:311
55
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:331
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:321
71
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:341
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:307
81
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:327
82
82
 
83
83
  The version of this frontend module.
84
84
 
@@ -88,16 +88,46 @@ 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:331
91
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:351
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
+
97
107
  ### workspaces?
98
108
 
99
109
  > `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
100
110
 
101
- Defined in: packages/framework/esm-globals/dist/types.d.ts:329
111
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:349
102
112
 
103
113
  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:338
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:364
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:338
12
12
 
13
13
  > **ResourceLoader**(): `Promise`\<`T`\>
14
14
 
15
- Defined in: packages/framework/esm-globals/dist/types.d.ts:339
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:365
16
16
 
17
17
  ## Returns
18
18
 
@@ -0,0 +1,29 @@
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
@@ -0,0 +1,29 @@
1
+ [O3 Framework](../API.md) / WorkspaceGroupDefinition2
2
+
3
+ # Interface: WorkspaceGroupDefinition2
4
+
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:293
6
+
7
+ ## Properties
8
+
9
+ ### closeable?
10
+
11
+ > `optional` **closeable**: `boolean`
12
+
13
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:295
14
+
15
+ ***
16
+
17
+ ### name
18
+
19
+ > **name**: `string`
20
+
21
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:294
22
+
23
+ ***
24
+
25
+ ### overlay?
26
+
27
+ > `optional` **overlay**: `boolean`
28
+
29
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:296
@@ -0,0 +1,69 @@
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
@@ -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/dist/types.d.ts:341
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:367
@@ -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:337
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:363
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
@@ -0,0 +1,21 @@
1
+ [O3 Framework](../API.md) / Workspace2Definition
2
+
3
+ # Type Alias: Workspace2Definition\<WorkspaceProps, WindowProps, GroupProps\>
4
+
5
+ > **Workspace2Definition**\<`WorkspaceProps`, `WindowProps`, `GroupProps`\> = `React.FC`\<`Workspace2DefinitionProps`\<`WorkspaceProps`, `WindowProps`, `GroupProps`\>\>
6
+
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L47)
8
+
9
+ ## Type Parameters
10
+
11
+ ### WorkspaceProps
12
+
13
+ `WorkspaceProps` *extends* `object`
14
+
15
+ ### WindowProps
16
+
17
+ `WindowProps` *extends* `object`
18
+
19
+ ### GroupProps
20
+
21
+ `GroupProps` *extends* `object`
@@ -0,0 +1,19 @@
1
+ [O3 Framework](../API.md) / ActionMenuButton2
2
+
3
+ # Variable: ActionMenuButton2
4
+
5
+ > `const` **ActionMenuButton2**: `React.FC`\<`ActionMenuButtonProps2`\>
6
+
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/action-menu2/action-menu-button2.component.tsx:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/action-menu2/action-menu-button2.component.tsx#L65)
8
+
9
+ **`Experimental`**
10
+
11
+ The ActionMenuButton2 component is used to render a button in the action menu of a workspace group.
12
+ The button is associated with a specific workspace window, defined in routes.json of the app with the button.
13
+ When one or more workspaces within the window are opened, the button will be highlighted.
14
+ If the window is hidden, either `tagContent` (if defined) or an exclamation mark will be displayed
15
+ on top of the icon.
16
+
17
+ On clicked, The button either:
18
+ 1. restores the workspace window if it is opened and hidden; or
19
+ 2. launch a workspace from within that window, if the window is not opened.
@@ -0,0 +1,14 @@
1
+ [O3 Framework](../API.md) / Workspace2
2
+
3
+ # Variable: Workspace2
4
+
5
+ > `const` **Workspace2**: `React.FC`\<`Workspace2Props`\>
6
+
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L60)
8
+
9
+ **`Experimental`**
10
+
11
+ The Workspace2 component is used as a top-level container to render
12
+ its children as content within a workspace. When creating a workspace
13
+ component, `<Workspace2>` should be the top-level component returned,
14
+ wrapping all of the workspace content.
package/mock-jest.tsx CHANGED
@@ -93,6 +93,7 @@ export const ActionMenu = jest.fn(() => <div>Action Menu</div>);
93
93
  export const WorkspaceContainer = jest.fn(() => <div>Workspace Container</div>);
94
94
  export const closeWorkspace = jest.fn();
95
95
  export const launchWorkspace = jest.fn();
96
+ export const launchWorkspace2 = jest.fn();
96
97
  export const launchWorkspaceGroup = jest.fn();
97
98
  export const navigateAndLaunchWorkspace = jest.fn();
98
99
  export const useWorkspaces = jest.fn();
package/mock.tsx CHANGED
@@ -94,6 +94,7 @@ export const ActionMenu = vi.fn(() => <div>Action Menu</div>);
94
94
  export const WorkspaceContainer = vi.fn(() => <div>Workspace Container</div>);
95
95
  export const closeWorkspace = vi.fn();
96
96
  export const launchWorkspace = vi.fn();
97
+ export const launchWorkspace2 = vi.fn();
97
98
  export const launchWorkspaceGroup = vi.fn();
98
99
  export const navigateAndLaunchWorkspace = vi.fn();
99
100
  export const useWorkspaces = vi.fn();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "8.0.1-pre.3349",
3
+ "version": "8.0.1-pre.3360",
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": "8.0.1-pre.3349",
63
- "@openmrs/esm-config": "8.0.1-pre.3349",
64
- "@openmrs/esm-context": "8.0.1-pre.3349",
65
- "@openmrs/esm-dynamic-loading": "8.0.1-pre.3349",
66
- "@openmrs/esm-emr-api": "8.0.1-pre.3349",
67
- "@openmrs/esm-error-handling": "8.0.1-pre.3349",
68
- "@openmrs/esm-expression-evaluator": "8.0.1-pre.3349",
69
- "@openmrs/esm-extensions": "8.0.1-pre.3349",
70
- "@openmrs/esm-feature-flags": "8.0.1-pre.3349",
71
- "@openmrs/esm-globals": "8.0.1-pre.3349",
72
- "@openmrs/esm-navigation": "8.0.1-pre.3349",
73
- "@openmrs/esm-offline": "8.0.1-pre.3349",
74
- "@openmrs/esm-react-utils": "8.0.1-pre.3349",
75
- "@openmrs/esm-routes": "8.0.1-pre.3349",
76
- "@openmrs/esm-state": "8.0.1-pre.3349",
77
- "@openmrs/esm-styleguide": "8.0.1-pre.3349",
78
- "@openmrs/esm-translations": "8.0.1-pre.3349",
79
- "@openmrs/esm-utils": "8.0.1-pre.3349"
62
+ "@openmrs/esm-api": "8.0.1-pre.3360",
63
+ "@openmrs/esm-config": "8.0.1-pre.3360",
64
+ "@openmrs/esm-context": "8.0.1-pre.3360",
65
+ "@openmrs/esm-dynamic-loading": "8.0.1-pre.3360",
66
+ "@openmrs/esm-emr-api": "8.0.1-pre.3360",
67
+ "@openmrs/esm-error-handling": "8.0.1-pre.3360",
68
+ "@openmrs/esm-expression-evaluator": "8.0.1-pre.3360",
69
+ "@openmrs/esm-extensions": "8.0.1-pre.3360",
70
+ "@openmrs/esm-feature-flags": "8.0.1-pre.3360",
71
+ "@openmrs/esm-globals": "8.0.1-pre.3360",
72
+ "@openmrs/esm-navigation": "8.0.1-pre.3360",
73
+ "@openmrs/esm-offline": "8.0.1-pre.3360",
74
+ "@openmrs/esm-react-utils": "8.0.1-pre.3360",
75
+ "@openmrs/esm-routes": "8.0.1-pre.3360",
76
+ "@openmrs/esm-state": "8.0.1-pre.3360",
77
+ "@openmrs/esm-styleguide": "8.0.1-pre.3360",
78
+ "@openmrs/esm-translations": "8.0.1-pre.3360",
79
+ "@openmrs/esm-utils": "8.0.1-pre.3360"
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": "8.0.1-pre.3349",
92
+ "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3360",
93
93
  "@rspack/cli": "^1.3.11",
94
94
  "@rspack/core": "^1.3.11",
95
95
  "concurrently": "^9.1.2",