@openmrs/esm-framework 10.0.1-pre.5704 → 10.0.1-pre.5709

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 4 files with swc (127.66ms)
+[0] Successfully compiled: 4 files with swc (137.49ms)
 [0] swc --strip-leading-paths src -d dist exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/docs/functions/createGlobalStore.md

@@ -4,7 +4,7 @@
 
 > **createGlobalStore**\<`T`\>(`name`, `initialState`, `storageType`): `StoreApi`\<`T`\>
 
-Defined in: [packages/framework/esm-state/src/state.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L59)
+Defined in: [packages/framework/esm-state/src/state.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L61)
 
 Creates a Zustand store.
 

package/docs/functions/getGlobalStore.md

@@ -4,7 +4,7 @@
 
 > **getGlobalStore**\<`T`\>(`name`, `fallbackState?`, `fallbackStorageType?`): `StoreApi`\<`T`\>
 
-Defined in: [packages/framework/esm-state/src/state.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L126)
+Defined in: [packages/framework/esm-state/src/state.ts:144](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L144)
 
 Returns the existing store named `name`,
 or creates a new store named `name` if none exists.

package/docs/functions/getRegisteredWorkspace2Names.md

@@ -4,7 +4,7 @@
 
 > **getRegisteredWorkspace2Names**(): `string`[]
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:601](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L601)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:682](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L682)
 
 ## Returns
 

package/docs/functions/subscribeTo.md

@@ -6,7 +6,7 @@
 
 > **subscribeTo**\<`T`, `U`\>(`store`, `handle`): () => `void`
 
-Defined in: [packages/framework/esm-state/src/state.ts:161](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L161)
+Defined in: [packages/framework/esm-state/src/state.ts:179](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L179)
 
 Subscribes to a store and invokes a callback when the state changes.
 The callback is also immediately invoked with the current state upon subscription.
@@ -54,7 +54,7 @@ An unsubscribe function to stop listening for changes.
 
 > **subscribeTo**\<`T`, `U`\>(`store`, `select`, `handle`): () => `void`
 
-Defined in: [packages/framework/esm-state/src/state.ts:162](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L162)
+Defined in: [packages/framework/esm-state/src/state.ts:180](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L180)
 
 Subscribes to a store and invokes a callback when the state changes.
 The callback is also immediately invoked with the current state upon subscription.

package/docs/functions/useWorkspace2Context.md

@@ -4,7 +4,7 @@
 
 > **useWorkspace2Context**(): [`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`object`, `object`, `object`\>
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:595](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L595)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:676](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L676)
 
 Returns the react Context containing props passed into a workspace.
 This hook MUST be called inside a child of <Workspace2>

package/docs/interfaces/ExportedWorkspaceProps.md

@@ -0,0 +1,64 @@
+[O3 Framework](../API.md) / ExportedWorkspaceProps
+
+# Interface: ExportedWorkspaceProps
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L26)
+
+## Properties
+
+### groupProps?
+
+> `optional` **groupProps**: `Record`\<`string`, `any`\>
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L40)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L32)
+
+The name of the workspace to open. Changing it (like changing `workspaceProps`, `windowProps` or
+`groupProps`) discards the current workspaces, without prompting for unsaved changes, and opens
+`name` afresh. To force a fresh instance without changing any of these, change the React `key`.
+
+***
+
+### windowProps?
+
+> `optional` **windowProps**: `Record`\<`string`, `any`\>
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L39)
+
+***
+
+### workspaceProps
+
+> **workspaceProps**: `Record`\<`string`, `any`\>
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L38)
+
+The props passed into the workspace. Changing these (compared shallowly), or `windowProps` /
+`groupProps`, discards the current workspaces and opens `name` afresh with the new props.
+
+## Methods
+
+### onWindowChanged()?
+
+> `optional` **onWindowChanged**(`info`): `void`
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L43)
+
+Callback fired when the emulated window's state changes.
+
+#### Parameters
+
+##### info
+
+[`ExportedWorkspaceWindowInfo`](ExportedWorkspaceWindowInfo.md)
+
+#### Returns
+
+`void`

package/docs/interfaces/ExportedWorkspaceWindowInfo.md

@@ -0,0 +1,46 @@
+[O3 Framework](../API.md) / ExportedWorkspaceWindowInfo
+
+# Interface: ExportedWorkspaceWindowInfo
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L12)
+
+## Properties
+
+### hasUnsavedChanges
+
+> **hasUnsavedChanges**: `boolean`
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L23)
+
+The `hasUnsavedChanges` of every workspace in the window, OR'd together.
+
+***
+
+### title
+
+> **title**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L21)
+
+The title of the currently-rendered (leaf) workspace, or `''` when all workspaces are closed.
+
+***
+
+### windowWidth
+
+> **windowWidth**: [`WorkspaceWindow2Width`](../type-aliases/WorkspaceWindow2Width.md)
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L19)
+
+The emulated workspace window's configured width. Note that this is a static property of the
+emulated workspace window, and does not change for the duration of the app.
+
+***
+
+### workspaceName
+
+> **workspaceName**: `null` \| `string`
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L14)
+
+The name of the currently-rendered (leaf) workspace, or `null` when all workspaces are closed.

package/docs/interfaces/FeatureFlagDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: FeatureFlagDefinition
 
-Defined in: [packages/framework/esm-globals/src/types.ts:262](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L262)
+Defined in: [packages/framework/esm-globals/src/types.ts:264](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L264)
 
 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/src/types.ts:268](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L268)
+Defined in: [packages/framework/esm-globals/src/types.ts:270](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L270)
 
 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/src/types.ts:264](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L264)
+Defined in: [packages/framework/esm-globals/src/types.ts:266](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L266)
 
 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/src/types.ts:266](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L266)
+Defined in: [packages/framework/esm-globals/src/types.ts:268](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L268)
 
 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/src/types.ts:272](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L272)
+Defined in: [packages/framework/esm-globals/src/types.ts:274](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L274)
 
 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/src/types.ts:276](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L276)
+Defined in: [packages/framework/esm-globals/src/types.ts:278](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L278)
 
 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/src/types.ts:292](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L292)
+Defined in: [packages/framework/esm-globals/src/types.ts:294](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L294)
 
 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/src/types.ts:294](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L294)
+Defined in: [packages/framework/esm-globals/src/types.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L296)
 
 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/src/types.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L296)
+Defined in: [packages/framework/esm-globals/src/types.ts:298](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L298)
 
 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/src/types.ts:278](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L278)
+Defined in: [packages/framework/esm-globals/src/types.ts:280](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L280)
 
 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/src/types.ts:290](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L290)
+Defined in: [packages/framework/esm-globals/src/types.ts:292](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L292)
 
 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/src/types.ts:274](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L274)
+Defined in: [packages/framework/esm-globals/src/types.ts:276](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L276)
 
 The version of this frontend module.
 
@@ -88,7 +88,7 @@ The version of this frontend module.
 
 > `optional` **workspaceGroups2**: [`WorkspaceGroupDefinition2`](WorkspaceGroupDefinition2.md)[]
 
-Defined in: [packages/framework/esm-globals/src/types.ts:299](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L299)
+Defined in: [packages/framework/esm-globals/src/types.ts:301](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L301)
 
 An array of all workspace groups (v2) supported by this frontend module.
 
@@ -98,7 +98,7 @@ An array of all workspace groups (v2) supported by this frontend module.
 
 > `optional` **workspaces2**: [`WorkspaceDefinition2`](WorkspaceDefinition2.md)[]
 
-Defined in: [packages/framework/esm-globals/src/types.ts:305](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L305)
+Defined in: [packages/framework/esm-globals/src/types.ts:307](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L307)
 
 An array of all workspaces (v2) supported by this frontend module.
 
@@ -108,6 +108,6 @@ An array of all workspaces (v2) supported by this frontend module.
 
 > `optional` **workspaceWindows2**: [`WorkspaceWindowDefinition2`](WorkspaceWindowDefinition2.md)[]
 
-Defined in: [packages/framework/esm-globals/src/types.ts:302](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L302)
+Defined in: [packages/framework/esm-globals/src/types.ts:304](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L304)
 
 An array of all workspace windows (v2) supported by this frontend module.

package/docs/interfaces/OpenmrsRoutes.md

@@ -2,7 +2,7 @@
 
 # Interface: OpenmrsRoutes
 
-Defined in: [packages/framework/esm-globals/src/types.ts:312](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L312)
+Defined in: [packages/framework/esm-globals/src/types.ts:314](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L314)
 
 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
@@ -13,7 +13,7 @@ Basically, this is the same as the app routes, with each routes definition keyed
 
 > **routes**: `Record`\<`Exclude`\<`string`, `"version"`\>, [`OpenmrsAppRoutes`](OpenmrsAppRoutes.md)\>
 
-Defined in: [packages/framework/esm-globals/src/types.ts:316](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L316)
+Defined in: [packages/framework/esm-globals/src/types.ts:318](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L318)
 
 The routes associated with this application keyed by module id
 
@@ -23,6 +23,6 @@ The routes associated with this application keyed by module id
 
 > `optional` **version**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:314](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L314)
+Defined in: [packages/framework/esm-globals/src/types.ts:316](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L316)
 
 The overall version for this application

package/docs/interfaces/ResourceLoader.md

@@ -2,7 +2,7 @@
 
 # Interface: ResourceLoader()\<T\>
 
-Defined in: [packages/framework/esm-globals/src/types.ts:319](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L319)
+Defined in: [packages/framework/esm-globals/src/types.ts:321](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L321)
 
 ## Type Parameters
 
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:319](https://github.com
 
 > **ResourceLoader**(): `Promise`\<`T`\>
 
-Defined in: [packages/framework/esm-globals/src/types.ts:320](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L320)
+Defined in: [packages/framework/esm-globals/src/types.ts:322](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L322)
 
 ## 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:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L18)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L10)
 
 ## Type Parameters
 
@@ -24,7 +24,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **groupProps**: `null` \| `GroupProps`
 
-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:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L35)
 
 ***
 
@@ -32,7 +32,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **isRootWorkspace**: `boolean`
 
-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)
+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)
 
 ***
 
@@ -40,7 +40,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **showActionMenu**: `boolean`
 
-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:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L44)
 
 ***
 
@@ -48,7 +48,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > **windowName**: `string`
 
-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)
+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)
 
 ***
 
@@ -56,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:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L42)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L34)
 
 ***
 
@@ -64,7 +64,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
 
 > `optional` **workspaceMeta**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
 
-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)
+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)
 
 The workspace's `meta` from its registration (the `meta` field of its `workspaces2` entry in
 `routes.json`).
@@ -75,7 +75,7 @@ The workspace's `meta` from its registration (the `meta` field of its `workspace
 
 > **workspaceName**: `string`
 
-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)
+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)
 
 ***
 
@@ -83,7 +83,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: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:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L33)
 
 ## Methods
 
@@ -91,7 +91,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:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L39)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L31)
 
 closes the current workspace, along with its children.
 
@@ -125,7 +125,7 @@ a Promise that resolves to true if the workspace is closed, false otherwise.
 
 > **launchChildWorkspace**\<`Props`\>(`workspaceName`, `workspaceProps?`): `Promise`\<`void`\>
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L30)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L22)
 
 This function launches a child workspace. Unlike `launchWorkspace()`, this function is meant
 to be called from the a workspace, and it does not allow passing (or changing)

package/docs/interfaces/WorkspaceDefinition2.md

@@ -2,7 +2,7 @@
 
 # Interface: WorkspaceDefinition2
 
-Defined in: [packages/framework/esm-globals/src/types.ts:246](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L246)
+Defined in: [packages/framework/esm-globals/src/types.ts:248](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L248)
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:246](https://github.com
 
 > **component**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:248](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L248)
+Defined in: [packages/framework/esm-globals/src/types.ts:250](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L250)
 
 ***
 
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:248](https://github.com
 
 > `optional` **meta**: `object`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L254)
+Defined in: [packages/framework/esm-globals/src/types.ts:256](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L256)
 
 Meta describes any properties that are passed down to the workspace when it is loaded. It is
 available to the workspace component via `useWorkspace2Context().workspaceMeta`.
@@ -33,7 +33,7 @@ available to the workspace component via `useWorkspace2Context().workspaceMeta`.
 
 > **name**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:247](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L247)
+Defined in: [packages/framework/esm-globals/src/types.ts:249](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L249)
 
 ***
 
@@ -41,4 +41,4 @@ Defined in: [packages/framework/esm-globals/src/types.ts:247](https://github.com
 
 > **window**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:249](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L249)
+Defined in: [packages/framework/esm-globals/src/types.ts:251](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L251)

package/docs/interfaces/WorkspaceWindowDefinition2.md

@@ -2,7 +2,7 @@
 
 # Interface: WorkspaceWindowDefinition2
 
-Defined in: [packages/framework/esm-globals/src/types.ts:237](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L237)
+Defined in: [packages/framework/esm-globals/src/types.ts:239](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L239)
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:237](https://github.com
 
 > `optional` **canMaximize**: `boolean`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:240](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L240)
+Defined in: [packages/framework/esm-globals/src/types.ts:242](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L242)
 
 ***
 
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:240](https://github.com
 
 > **group**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L241)
+Defined in: [packages/framework/esm-globals/src/types.ts:243](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L243)
 
 ***
 
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:241](https://github.com
 
 > `optional` **icon**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:239](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L239)
+Defined in: [packages/framework/esm-globals/src/types.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L241)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:239](https://github.com
 
 > **name**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:238](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L238)
+Defined in: [packages/framework/esm-globals/src/types.ts:240](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L240)
 
 ***
 
@@ -42,12 +42,12 @@ Defined in: [packages/framework/esm-globals/src/types.ts:238](https://github.com
 
 > `optional` **order**: `number`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:242](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L242)
+Defined in: [packages/framework/esm-globals/src/types.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L244)
 
 ***
 
 ### width?
 
-> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
+> `optional` **width**: [`WorkspaceWindow2Width`](../type-aliases/WorkspaceWindow2Width.md)
 
-Defined in: [packages/framework/esm-globals/src/types.ts:243](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L243)
+Defined in: [packages/framework/esm-globals/src/types.ts:245](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L245)

package/docs/type-aliases/NameUse.md

@@ -4,4 +4,4 @@
 
 > **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:326](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L326)
+Defined in: [packages/framework/esm-globals/src/types.ts:328](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L328)

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:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L55)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L59)
 
 ## Type Parameters
 

package/docs/type-aliases/WorkspaceWindow2Width.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / WorkspaceWindow2Width
+
+# Type Alias: WorkspaceWindow2Width
+
+> **WorkspaceWindow2Width** = `"narrow"` \| `"wider"` \| `"extra-wide"`
+
+Defined in: [packages/framework/esm-globals/src/types.ts:237](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L237)

package/docs/variables/ExportedWorkspace.md

@@ -0,0 +1,14 @@
+[O3 Framework](../API.md) / ExportedWorkspace
+
+# Variable: ExportedWorkspace
+
+> `const` **ExportedWorkspace**: `React.FC`\<[`ExportedWorkspaceProps`](../interfaces/ExportedWorkspaceProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/exported-workspace.component.tsx#L59)
+
+Renders the content of a registered workspace (the `children` of its `<Workspace2>`) within its own
+DOM subtree, independent of the real global workspace window system. It emulates the workspace
+window that contains `name`: opening/closing child workspaces (via `launchChildWorkspace()` /
+`closeWorkspace()` from within the workspace) navigates within this component, in a window held in
+its own local store. It renders no chrome (no title bar, maximize, hide, close, or icon); callers can
+render their own around it.

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:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L67)
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L71)
 
 The Workspace2 component is used as a top-level container to render
 its children as content within a workspace. When creating a workspace

package/mock-jest.tsx

@@ -121,6 +121,7 @@ export const ActionMenuButton2 = jest.fn(({ label, tagContent, icon }) => (
   </button>
 ));
 export const ActionMenu = jest.fn(() => <div>Action Menu</div>);
+export const ExportedWorkspace = jest.fn(() => <div>Exported Workspace</div>);
 export const launchWorkspace2 = jest.fn();
 export const launchWorkspaceGroup2 = jest.fn();
 export const closeWorkspaceGroup2 = jest.fn();

package/mock.tsx

@@ -122,6 +122,7 @@ export const ActionMenuButton2 = vi.fn(({ label, tagContent, icon }) => (
   </button>
 ));
 export const ActionMenu = vi.fn(() => <div>Action Menu</div>);
+export const ExportedWorkspace = vi.fn(() => <div>Exported Workspace</div>);
 export const launchWorkspace2 = vi.fn();
 export const launchWorkspaceGroup2 = vi.fn();
 export const closeWorkspaceGroup2 = vi.fn();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "10.0.1-pre.5704",
+  "version": "10.0.1-pre.5709",
   "license": "MPL-2.0",
   "type": "module",
   "module": "dist/index.js",
@@ -60,23 +60,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "10.0.1-pre.5704",
-    "@openmrs/esm-config": "10.0.1-pre.5704",
-    "@openmrs/esm-context": "10.0.1-pre.5704",
-    "@openmrs/esm-dynamic-loading": "10.0.1-pre.5704",
-    "@openmrs/esm-emr-api": "10.0.1-pre.5704",
-    "@openmrs/esm-error-handling": "10.0.1-pre.5704",
-    "@openmrs/esm-expression-evaluator": "10.0.1-pre.5704",
-    "@openmrs/esm-extensions": "10.0.1-pre.5704",
-    "@openmrs/esm-feature-flags": "10.0.1-pre.5704",
-    "@openmrs/esm-globals": "10.0.1-pre.5704",
-    "@openmrs/esm-navigation": "10.0.1-pre.5704",
-    "@openmrs/esm-react-utils": "10.0.1-pre.5704",
-    "@openmrs/esm-routes": "10.0.1-pre.5704",
-    "@openmrs/esm-state": "10.0.1-pre.5704",
-    "@openmrs/esm-styleguide": "10.0.1-pre.5704",
-    "@openmrs/esm-translations": "10.0.1-pre.5704",
-    "@openmrs/esm-utils": "10.0.1-pre.5704"
+    "@openmrs/esm-api": "10.0.1-pre.5709",
+    "@openmrs/esm-config": "10.0.1-pre.5709",
+    "@openmrs/esm-context": "10.0.1-pre.5709",
+    "@openmrs/esm-dynamic-loading": "10.0.1-pre.5709",
+    "@openmrs/esm-emr-api": "10.0.1-pre.5709",
+    "@openmrs/esm-error-handling": "10.0.1-pre.5709",
+    "@openmrs/esm-expression-evaluator": "10.0.1-pre.5709",
+    "@openmrs/esm-extensions": "10.0.1-pre.5709",
+    "@openmrs/esm-feature-flags": "10.0.1-pre.5709",
+    "@openmrs/esm-globals": "10.0.1-pre.5709",
+    "@openmrs/esm-navigation": "10.0.1-pre.5709",
+    "@openmrs/esm-react-utils": "10.0.1-pre.5709",
+    "@openmrs/esm-routes": "10.0.1-pre.5709",
+    "@openmrs/esm-state": "10.0.1-pre.5709",
+    "@openmrs/esm-styleguide": "10.0.1-pre.5709",
+    "@openmrs/esm-translations": "10.0.1-pre.5709",
+    "@openmrs/esm-utils": "10.0.1-pre.5709"
   },
   "peerDependencies": {
     "dayjs": "1.x",
@@ -88,7 +88,7 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/typedoc-plugin-file-categories": "10.0.1-pre.5704",
+    "@openmrs/typedoc-plugin-file-categories": "10.0.1-pre.5709",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@vitest/coverage-v8": "^4.1.2",