@openmrs/esm-framework 8.0.1-pre.3473 → 8.0.1-pre.3498

package/docs/functions/closeWorkspaceGroup2.md

@@ -4,7 +4,7 @@
 
 > **closeWorkspaceGroup2**(`discardUnsavedChanges?`): `Promise`\<`boolean`\>
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L72)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L75)
 
 **`Experimental`**
 

package/docs/functions/createUseStore.md

@@ -4,7 +4,7 @@
 
 > **createUseStore**\<`T`\>(`store`): \{(): `T`; \<`A`\>(`actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>; \<`A`\>(`actions?`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>; \}
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:95](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L95)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L104)
 
 Whenever possible, use `useStore(yourStore)` instead. This function is for creating a
 custom hook for a specific store.

package/docs/functions/getRegisteredWorkspace2Names.md

@@ -0,0 +1,13 @@
+[O3 Framework](../API.md) / getRegisteredWorkspace2Names
+
+# Function: getRegisteredWorkspace2Names()
+
+> **getRegisteredWorkspace2Names**(): `string`[]
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:561](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L561)
+
+## Returns
+
+`string`[]
+
+a list of registered workspaces.

package/docs/functions/launchWorkspace2.md

@@ -4,7 +4,7 @@
 
 > **launchWorkspace2**\<`WorkspaceProps`, `WindowProps`, `GroupProp`\>(`workspaceName`, `workspaceProps`, `windowProps`, `groupProps`): `Promise`\<`boolean`\>
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:132](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L132)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:135](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L135)
 
 **`Experimental`**
 

package/docs/functions/launchWorkspaceGroup2.md

@@ -4,7 +4,7 @@
 
 > **launchWorkspaceGroup2**\<`GroupProps`\>(`groupName`, `groupProps`): `Promise`\<`boolean`\>
 
-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)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L32)
 
 **`Experimental`**
 

package/docs/functions/useStore.md

@@ -6,7 +6,7 @@
 
 > **useStore**\<`T`\>(`store`): `T`
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L53)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L52)
 
 ### Type Parameters
 
@@ -28,7 +28,7 @@ Defined in: [packages/framework/esm-react-utils/src/useStore.ts:53](https://gith
 
 > **useStore**\<`T`, `U`\>(`store`, `select`): `U`
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L54)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L53)
 
 ### Type Parameters
 
@@ -58,7 +58,7 @@ Defined in: [packages/framework/esm-react-utils/src/useStore.ts:54](https://gith
 
 > **useStore**\<`T`, `U`, `A`\>(`store`, `select`, `actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L55)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L54)
 
 ### Type Parameters
 
@@ -96,7 +96,7 @@ Defined in: [packages/framework/esm-react-utils/src/useStore.ts:55](https://gith
 
 > **useStore**\<`T`, `U`, `A`\>(`store`, `select`, `actions`): `U` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L60)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L59)
 
 ### Type Parameters
 

package/docs/functions/useStoreWithActions.md

@@ -4,7 +4,7 @@
 
 > **useStoreWithActions**\<`T`, `A`\>(`store`, `actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L87)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L96)
 
 ## Type Parameters
 

package/docs/functions/useWorkspace2Context.md

@@ -0,0 +1,14 @@
+[O3 Framework](../API.md) / useWorkspace2Context
+
+# Function: useWorkspace2Context()
+
+> **useWorkspace2Context**(): [`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`object`, `object`, `object`\>
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:555](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L555)
+
+Returns the react Context containing props passed into a workspace.
+This hook MUST be called inside a child of <Workspace2>
+
+## Returns
+
+[`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`object`, `object`, `object`\>

package/docs/interfaces/FeatureFlagDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: FeatureFlagDefinition
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:320
+Defined in: packages/framework/esm-globals/dist/types.d.ts:328
 
 A definition of a feature flag extracted from the routes.json
 
@@ -12,7 +12,7 @@ A definition of a feature flag extracted from the routes.json
 
 > **description**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:326
+Defined in: packages/framework/esm-globals/dist/types.d.ts:334
 
 An explanation of what the flag does, which will be displayed in the Implementer Tools
 
@@ -22,7 +22,7 @@ An explanation of what the flag does, which will be displayed in the Implementer
 
 > **flagName**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:322
+Defined in: packages/framework/esm-globals/dist/types.d.ts:330
 
 A code-friendly name for the flag, which will be used to reference it in code
 
@@ -32,6 +32,6 @@ A code-friendly name for the flag, which will be used to reference it in code
 
 > **label**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:324
+Defined in: packages/framework/esm-globals/dist/types.d.ts:332
 
 A human-friendly name which will be displayed in the Implementer Tools

package/docs/interfaces/OpenmrsAppRoutes.md

@@ -2,7 +2,7 @@
 
 # Interface: OpenmrsAppRoutes
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:329
+Defined in: packages/framework/esm-globals/dist/types.d.ts:337
 
 This interface describes the format of the routes provided by an app
 
@@ -12,7 +12,7 @@ This interface describes the format of the routes provided by an app
 
 > `optional` **backendDependencies**: `Record`\<`string`, `string`\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:333
+Defined in: packages/framework/esm-globals/dist/types.d.ts:341
 
 A list of backend modules necessary for this frontend module and the corresponding required versions.
 
@@ -22,7 +22,7 @@ A list of backend modules necessary for this frontend module and the correspondi
 
 > `optional` **extensions**: [`ExtensionDefinition`](../type-aliases/ExtensionDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:347
+Defined in: packages/framework/esm-globals/dist/types.d.ts:355
 
 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.
 
@@ -32,7 +32,7 @@ An array of all extensions supported by this frontend module. Extensions can be
 
 > `optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:349
+Defined in: packages/framework/esm-globals/dist/types.d.ts:357
 
 An array of all feature flags for any beta-stage features this module provides.
 
@@ -42,7 +42,7 @@ An array of all feature flags for any beta-stage features this module provides.
 
 > `optional` **modals**: [`ModalDefinition`](../type-aliases/ModalDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:351
+Defined in: packages/framework/esm-globals/dist/types.d.ts:359
 
 An array of all modals supported by this frontend module. Modals can be launched by name.
 
@@ -52,7 +52,7 @@ An array of all modals supported by this frontend module. Modals can be launched
 
 > `optional` **optionalBackendDependencies**: `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:335
+Defined in: packages/framework/esm-globals/dist/types.d.ts:343
 
 A list of backend modules that may enable optional functionality in this frontend module if available and the corresponding required versions.
 
@@ -68,7 +68,7 @@ The name of the backend dependency and either the required version or an object
 
 > `optional` **pages**: [`PageDefinition`](../type-aliases/PageDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:345
+Defined in: packages/framework/esm-globals/dist/types.d.ts:353
 
 An array of all pages supported by this frontend module. Pages are automatically mounted based on a route.
 
@@ -78,7 +78,7 @@ An array of all pages supported by this frontend module. Pages are automatically
 
 > `optional` **version**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:331
+Defined in: packages/framework/esm-globals/dist/types.d.ts:339
 
 The version of this frontend module.
 
@@ -88,7 +88,7 @@ The version of this frontend module.
 
 > `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:355
+Defined in: packages/framework/esm-globals/dist/types.d.ts:363
 
 An array of all workspace groups supported by this frontend module.
 
@@ -98,7 +98,7 @@ An array of all workspace groups supported by this frontend module.
 
 > `optional` **workspaceGroups2**: [`WorkspaceGroupDefinition2`](WorkspaceGroupDefinition2.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:357
+Defined in: packages/framework/esm-globals/dist/types.d.ts:365
 
 An array of all workspace groups (v2) supported by this frontend module.
 
@@ -108,7 +108,7 @@ An array of all workspace groups (v2) supported by this frontend module.
 
 > `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:353
+Defined in: packages/framework/esm-globals/dist/types.d.ts:361
 
 An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
 
@@ -118,7 +118,7 @@ An array of all workspaces supported by this frontend module. Workspaces can be
 
 > `optional` **workspaces2**: [`WorkspaceDefinition2`](WorkspaceDefinition2.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:361
+Defined in: packages/framework/esm-globals/dist/types.d.ts:369
 
 An array of all workspaces (v2) supported by this frontend module.
 
@@ -128,6 +128,6 @@ An array of all workspaces (v2) supported by this frontend module.
 
 > `optional` **workspaceWindows2**: [`WorkspaceWindowDefinition2`](WorkspaceWindowDefinition2.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:359
+Defined in: packages/framework/esm-globals/dist/types.d.ts:367
 
 An array of all workspace windows (v2) supported by this frontend module.

package/docs/interfaces/ResourceLoader.md

@@ -2,7 +2,7 @@
 
 # Interface: ResourceLoader()\<T\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:368
+Defined in: packages/framework/esm-globals/dist/types.d.ts:376
 
 ## Type Parameters
 
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:368
 
 > **ResourceLoader**(): `Promise`\<`T`\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:369
+Defined in: packages/framework/esm-globals/dist/types.d.ts:377
 
 ## Returns
 

package/docs/interfaces/Workspace2DefinitionProps.md

@@ -2,7 +2,7 @@
 
 # Interface: Workspace2DefinitionProps\<WorkspaceProps, WindowProps, GroupProps\>
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L21)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L20)
 
 **`Experimental`**
 
@@ -26,7 +26,27 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **groupProps**: `null` \| `GroupProps`
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L45)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L44)
+
+**`Experimental`**
+
+***
+
+### isRootWorkspace
+
+> **isRootWorkspace**: `boolean`
+
+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)
+
+**`Experimental`**
+
+***
+
+### windowName
+
+> **windowName**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L46)
 
 **`Experimental`**
 
@@ -36,7 +56,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **windowProps**: `null` \| `WindowProps`
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L44)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L43)
 
 **`Experimental`**
 
@@ -46,7 +66,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **workspaceName**: `string`
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L46)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L45)
 
 **`Experimental`**
 
@@ -56,7 +76,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **workspaceProps**: `null` \| `WorkspaceProps`
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L43)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L42)
 
 **`Experimental`**
 
@@ -66,7 +86,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **closeWorkspace**(`options?`): `Promise`\<`boolean`\>
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L41)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L40)
 
 **`Experimental`**
 
@@ -96,7 +116,7 @@ a Promise that resolves to true if the workspace is closed, false otherwise.
 
 > **launchChildWorkspace**\<`Props`\>(`workspaceName`, `workspaceProps?`): `void`
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L33)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L32)
 
 **`Experimental`**
 

package/docs/interfaces/WorkspaceDefinition2.md

@@ -2,7 +2,7 @@
 
 # Interface: WorkspaceDefinition2
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:312
+Defined in: packages/framework/esm-globals/dist/types.d.ts:320
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:312
 
 > **component**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:314
+Defined in: packages/framework/esm-globals/dist/types.d.ts:322
 
 ***
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:314
 
 > **name**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:313
+Defined in: packages/framework/esm-globals/dist/types.d.ts:321
 
 ***
 
@@ -26,4 +26,4 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:313
 
 > **window**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:315
+Defined in: packages/framework/esm-globals/dist/types.d.ts:323

package/docs/interfaces/WorkspaceGroupDefinition2.md

@@ -27,3 +27,19 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:298
 > `optional` **overlay**: `boolean`
 
 Defined in: packages/framework/esm-globals/dist/types.d.ts:300
+
+***
+
+### persistence?
+
+> `optional` **persistence**: `"app-wide"` \| `"closable"`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:310
+
+In app-wide persistence mode, a workspace group renders its
+action menu without a close button. This is for
+workspace groups that are meant to be opened for the entire duration of the app
+
+In closable persistence mode, a workspace group renders its
+action menu with a close button. User may explicitly close the group, along
+with any opened windows / workspaces.

package/docs/interfaces/WorkspaceWindowDefinition2.md

@@ -2,23 +2,15 @@
 
 # Interface: WorkspaceWindowDefinition2
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:302
+Defined in: packages/framework/esm-globals/dist/types.d.ts:312
 
 ## Properties
 
-### canHide
+### canMaximize?
 
-> **canHide**: `boolean`
+> `optional` **canMaximize**: `boolean`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:305
-
-***
-
-### canMaximize
-
-> **canMaximize**: `boolean`
-
-Defined in: packages/framework/esm-globals/dist/types.d.ts:306
+Defined in: packages/framework/esm-globals/dist/types.d.ts:315
 
 ***
 
@@ -26,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:306
 
 > **group**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:308
+Defined in: packages/framework/esm-globals/dist/types.d.ts:316
 
 ***
 
@@ -34,7 +26,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:308
 
 > `optional` **icon**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:304
+Defined in: packages/framework/esm-globals/dist/types.d.ts:314
 
 ***
 
@@ -42,7 +34,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:304
 
 > **name**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:303
+Defined in: packages/framework/esm-globals/dist/types.d.ts:313
 
 ***
 
@@ -50,15 +42,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:303
 
 > `optional` **order**: `number`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:309
-
-***
-
-### overlay
-
-> **overlay**: `boolean`
-
-Defined in: packages/framework/esm-globals/dist/types.d.ts:307
+Defined in: packages/framework/esm-globals/dist/types.d.ts:317
 
 ***
 
@@ -66,4 +50,4 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:307
 
 > `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:310
+Defined in: packages/framework/esm-globals/dist/types.d.ts:318

package/docs/type-aliases/ActionFunction.md

@@ -4,7 +4,7 @@
 
 > **ActionFunction**\<`T`\> = (`state`, ...`args`) => `Partial`\<`T`\>
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L6)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L5)
 
 ## Type Parameters
 

package/docs/type-aliases/Actions.md

@@ -4,7 +4,7 @@
 
 > **Actions**\<`T`\> = (`store`) => `ActionFunctionsRecord`\<`T`\> \| `ActionFunctionsRecord`\<`T`\>
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L10)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L9)
 
 ## Type Parameters
 

package/docs/type-aliases/BoundActions.md

@@ -4,7 +4,7 @@
 
 > **BoundActions**\<`T`, `A`\> = `A` *extends* `ActionFunctionsRecord`\<`T`\> ? `BindFunctionsIn`\<`A`\> : `A` *extends* (`store`) => `ActionFunctionsRecord`\<`T`\> ? `BindFunctionsIn`\<`ActionFunctionsRecord`\<`T`\>\> : `never`
 
-Defined in: [packages/framework/esm-react-utils/src/useStore.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L12)
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L11)
 
 ## Type Parameters
 

package/docs/type-aliases/NameUse.md

@@ -4,4 +4,4 @@
 
 > **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:371
+Defined in: packages/framework/esm-globals/dist/types.d.ts:379

package/docs/type-aliases/OpenmrsRoutes.md

@@ -4,7 +4,7 @@
 
 > **OpenmrsRoutes** = `Record`\<`string`, [`OpenmrsAppRoutes`](../interfaces/OpenmrsAppRoutes.md)\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:367
+Defined in: packages/framework/esm-globals/dist/types.d.ts:375
 
 This interfaces describes the format of the overall routes.json loaded by the app shell.
 Basically, this is the same as the app routes, with each routes definition keyed by the app's name

package/docs/type-aliases/Workspace2Definition.md

@@ -4,7 +4,7 @@
 
 > **Workspace2Definition**\<`WorkspaceProps`, `WindowProps`, `GroupProps`\> = `React.FC`\<[`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`WorkspaceProps`, `WindowProps`, `GroupProps`\>\>
 
-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)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L53)
 
 **`Experimental`**
 

package/docs/variables/Workspace2.md

@@ -4,7 +4,7 @@
 
 > `const` **Workspace2**: `React.FC`\<`Workspace2Props`\>
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L65)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L66)
 
 **`Experimental`**
 

package/mock-jest.tsx

@@ -100,6 +100,7 @@ export const closeWorkspace = jest.fn();
 export const launchWorkspace = jest.fn();
 export const launchWorkspace2 = jest.fn();
 export const launchWorkspaceGroup = jest.fn();
+export const closeWorkspaceGroup2 = jest.fn();
 export const navigateAndLaunchWorkspace = jest.fn();
 export const useWorkspaces = jest.fn();
 

package/mock.tsx

@@ -101,6 +101,7 @@ export const closeWorkspace = vi.fn();
 export const launchWorkspace = vi.fn();
 export const launchWorkspace2 = vi.fn();
 export const launchWorkspaceGroup = vi.fn();
+export const closeWorkspaceGroup2 = vi.fn();
 export const navigateAndLaunchWorkspace = vi.fn();
 export const useWorkspaces = vi.fn();