@openmrs/esm-framework 5.6.1-pre.1955 → 5.6.1-pre.1966

package/.turbo/turbo-build.log

@@ -28,4 +28,4 @@ Entrypoints:
   main (1.51 MiB)
       openmrs-esm-framework.js
 
-webpack 5.88.0 compiled with 3 warnings in 28374 ms
+webpack 5.88.0 compiled with 3 warnings in 26879 ms

package/docs/API.md

@@ -180,6 +180,7 @@
 
 ### Other Functions
 
+- [WorkspaceContainer](API.md#workspacecontainer)
 - [isOnline](API.md#isonline)
 
 ### Store Functions
@@ -5295,6 +5296,64 @@ ___
 
 ## Other Functions
 
+### WorkspaceContainer
+
+▸ **WorkspaceContainer**(`__namedParameters`): `Element`
+
+Use this component to render the [workspace window](https://zeroheight.com/23a080e38/p/483a22-workspace)
+in an app such as the patient chart, or a workspace overlay in an app such as the clinic dashboard.
+This allows workspaces to be opened on the page where this component is mounted. This component
+must not be mounted multiple times on the same page. If there are multiple apps on a page, only
+one of those apps should use this component—it "hosts" the workspaces.
+
+Workspaces may be opened with the [launchWorkspace](API.md#launchworkspace) function from `@openmrs/esm-framework`
+(among other options).
+
+The `overlay` prop determines whether the workspace is rendered as an overlay or a window.
+When a workspace window is opened, the other content on the screen will be pushed to the left.
+When an overlay is opened, it will cover other content on the screen.
+
+The context key is a string that appears in the URL, which defines the pages on which workspaces
+are valid. If the URL changes in a way such that it no longer contains the context key, then
+all workspaces will be closed. This ensures that, for example, workspaces on the home page do
+not stay open when the user transitions to the patient dashboard; and also that workspaces do
+not stay open when the user navigates to a different patient. The context key must be a valid
+sub-path of the URL, with no initial or trailing slash. So if the URL is
+`https://example.com/patient/123/foo`, then `patient` and `patient/123` and `123/foo` are valid
+context keys, but `patient/12` and `pati` are not.
+
+An extension slot is provided in the workspace header. Its name is derived from the `featureName` of
+the top-level component in which it is defined (feature names are generally provided in the lifecycle
+functions in an app's `index.ts` file). The slot is named `workspace-header-${featureName}-slot`.
+For the patient chart, this is `workspace-header-patient-chart-slot`.
+
+This component also provides the [Siderail and Bottom Nav](https://zeroheight.com/23a080e38/p/948cf1-siderail-and-bottom-nav/b/86907e).
+To use this, pass the `showSiderailAndBottomNav` prop. The Siderail is rendered on the right side of the screen
+on desktop, and the Bottom Nav is rendered at the bottom of the screen on tablet or mobile. The sidebar/bottom-nav
+menu provides an extension slot, to which buttons are attached as extensions. The slot
+derives its name from the `featureName` of the top-level component in which this `WorkspaceContainer`
+appears (feature names are generally provided in the lifecycle functions in an app's `index.ts` file).
+The slot is named `action-menu-${featureName}-items-slot`. For the patient chart, this is
+`action-menu-patient-chart-items-slot`.
+
+This component also provides everything needed for workspace notifications to be rendered.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | [`WorkspaceContainerProps`](interfaces/WorkspaceContainerProps.md) |
+
+#### Returns
+
+`Element`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L59)
+
+___
+
 ### isOnline
 
 ▸ **isOnline**(`online?`): `boolean`
@@ -6716,25 +6775,17 @@ ___
 
 ### ActionMenu
 
-▸ **ActionMenu**(): ``null`` \| `Element`
+▸ **ActionMenu**(): `Element`
 
-This renders the [Siderail and Bottom Nav](https://zeroheight.com/23a080e38/p/948cf1-siderail-and-bottom-nav/b/86907e),
-collectively known as the Action Menu. The Siderail is rendered on the right side of the screen
-on desktop, and the Bottom Nav is rendered at the bottom of the screen on tablet or mobile.
-
-The action menu provides an extension slot, to which buttons are attached as extensions. The slot
-derives its name from the `featureName` of the top-level component in which this `ActionMenu`
-appears (feature names are generally provided in the lifecycle functions in an app's `index.ts` file).
-The slot is named `action-menu-${featureName}-items-slot`. For the patient chart, this is
-`action-menu-patient-chart-items-slot`.
+**`deprecated`** Use `WorkspaceContainer` instead
 
 #### Returns
 
-``null`` \| `Element`
+`Element`
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/action-menu/action-menu.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu/action-menu.component.tsx#L19)
+[packages/framework/esm-styleguide/src/workspaces/container/action-menu.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/action-menu.component.tsx#L10)
 
 ___
 
@@ -6742,28 +6793,7 @@ ___
 
 ▸ **WorkspaceOverlay**(`__namedParameters`): `Element`
 
-Use this component to render the workspace window as an overlay in an app. An overlay is
-a way of rendering workspaces that will cover other content on the screen, rather than
-pushing it to the left (as with [WorkspaceWindow](API.md#workspacewindow)). As described in the
-[ZeroHeight](https://zeroheight.com/23a080e38/p/483a22-workspace/t/34e1a1) documentation,
-this should be used on "app pages" such as the Clinic Dashboard.
-
-The context key is a string that appears in the URL, which defines the pages on which workspaces
-are valid. If the URL changes in a way such that it no longer contains the context key, then
-all workspaces will be closed. This ensures that, for example, workspaces on the home page do
-not stay open when the user transitions to the patient dashboard; and also that workspaces do
-not stay open when the user navigates to a different patient. The context key must be a valid
-sub-path of the URL, with no initial or trailing slash. So if the URL is
-`https://example.com/patient/123/foo`, then `patient` and `patient/123` and `123/foo` are valid
-context keys, but `patient/12` and `pati` are not.
-
-Workspaces may be opened with the [launchWorkspace](API.md#launchworkspace) function from `@openmrs/esm-framework`
-(among other options).
-
-This component also provides everything needed for workspace notifications to be rendered.
-
-This component does not include the action menu (the right siderail). The [ActionMenu](API.md#actionmenu) component
-is provided separately.
+**`deprecated`** Use `WorkspaceContainer` instead
 
 #### Parameters
 
@@ -6777,7 +6807,7 @@ is provided separately.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/overlay/workspace-overlay.component.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/overlay/workspace-overlay.component.tsx#L45)
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-overlay.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-overlay.component.tsx#L21)
 
 ___
 
@@ -6785,31 +6815,7 @@ ___
 
 ▸ **WorkspaceWindow**(`__namedParameters`): `Element`
 
-Use this component to render the [workspace window](https://zeroheight.com/23a080e38/p/483a22-workspace)
-in an app such as the patient chart.
-When a workspace is opened, the other content on the screen will be pushed to the left.
-
-The context key is a string that appears in the URL, which defines the pages on which workspaces
-are valid. If the URL changes in a way such that it no longer contains the context key, then
-all workspaces will be closed. This ensures that, for example, workspaces on the home page do
-not stay open when the user transitions to the patient dashboard; and also that workspaces do
-not stay open when the user navigates to a different patient. The context key must be a valid
-sub-path of the URL, with no initial or trailing slash. So if the URL is
-`https://example.com/patient/123/foo`, then `patient` and `patient/123` and `123/foo` are valid
-context keys, but `patient/12` and `pati` are not.
-
-Workspaces may be opened with the [launchWorkspace](API.md#launchworkspace) function from `@openmrs/esm-framework`
-(among other options).
-
-This component also provides everything needed for workspace notifications to be rendered.
-
-This component does not include the action menu (the right siderail). The [ActionMenu](API.md#actionmenu) component
-is provided separately.
-
-An extension slot is provided in the workspace header. Its name is derived from the `featureName` of
-the top-level component in which it is defined (feature names are generally provided in the lifecycle
-functions in an app's `index.ts` file). The slot is named `workspace-header-${featureName}-slot`.
-For the patient chart, this is `workspace-header-patient-chart-slot`.
+**`deprecated`** Use `WorkspaceContainer` instead
 
 #### Parameters
 
@@ -6823,7 +6829,7 @@ For the patient chart, this is `workspace-header-patient-chart-slot`.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L48)
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-window.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-window.component.tsx#L22)
 
 ___
 

package/docs/interfaces/WorkspaceContainerProps.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / WorkspaceContainerProps
+
+# Interface: WorkspaceContainerProps
+
+## Table of contents
+
+### Properties
+
+- [additionalWorkspaceProps](WorkspaceContainerProps.md#additionalworkspaceprops)
+- [contextKey](WorkspaceContainerProps.md#contextkey)
+- [overlay](WorkspaceContainerProps.md#overlay)
+- [showSiderailAndBottomNav](WorkspaceContainerProps.md#showsiderailandbottomnav)
+
+## Properties
+
+### additionalWorkspaceProps
+
+• `Optional` **additionalWorkspaceProps**: `object`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L11)
+
+___
+
+### contextKey
+
+• **contextKey**: `string`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L8)
+
+___
+
+### overlay
+
+• `Optional` **overlay**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L9)
+
+___
+
+### showSiderailAndBottomNav
+
+• `Optional` **showSiderailAndBottomNav**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L10)

package/docs/interfaces/WorkspaceOverlayProps.md

@@ -6,14 +6,25 @@
 
 ### Workspace Properties
 
+- [additionalWorkspaceProps](WorkspaceOverlayProps.md#additionalworkspaceprops)
 - [contextKey](WorkspaceOverlayProps.md#contextkey)
 
 ## Workspace Properties
 
+### additionalWorkspaceProps
+
+• `Optional` **additionalWorkspaceProps**: `object`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-overlay.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-overlay.component.tsx#L15)
+
+___
+
 ### contextKey
 
 • **contextKey**: `string`
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/overlay/workspace-overlay.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/overlay/workspace-overlay.component.tsx#L16)
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-overlay.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-overlay.component.tsx#L14)

package/docs/interfaces/WorkspaceWindowProps.md

@@ -17,7 +17,7 @@
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L16)
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-window.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-window.component.tsx#L16)
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/window/workspace-window.component.tsx#L15)
+[packages/framework/esm-styleguide/src/workspaces/container/workspace-window.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-window.component.tsx#L15)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "5.6.1-pre.1955",
+  "version": "5.6.1-pre.1966",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -37,22 +37,22 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "5.6.1-pre.1955",
-    "@openmrs/esm-config": "5.6.1-pre.1955",
-    "@openmrs/esm-context": "5.6.1-pre.1955",
-    "@openmrs/esm-dynamic-loading": "5.6.1-pre.1955",
-    "@openmrs/esm-error-handling": "5.6.1-pre.1955",
-    "@openmrs/esm-extensions": "5.6.1-pre.1955",
-    "@openmrs/esm-feature-flags": "5.6.1-pre.1955",
-    "@openmrs/esm-globals": "5.6.1-pre.1955",
-    "@openmrs/esm-navigation": "5.6.1-pre.1955",
-    "@openmrs/esm-offline": "5.6.1-pre.1955",
-    "@openmrs/esm-react-utils": "5.6.1-pre.1955",
-    "@openmrs/esm-routes": "5.6.1-pre.1955",
-    "@openmrs/esm-state": "5.6.1-pre.1955",
-    "@openmrs/esm-styleguide": "5.6.1-pre.1955",
-    "@openmrs/esm-translations": "5.6.1-pre.1955",
-    "@openmrs/esm-utils": "5.6.1-pre.1955",
+    "@openmrs/esm-api": "5.6.1-pre.1966",
+    "@openmrs/esm-config": "5.6.1-pre.1966",
+    "@openmrs/esm-context": "5.6.1-pre.1966",
+    "@openmrs/esm-dynamic-loading": "5.6.1-pre.1966",
+    "@openmrs/esm-error-handling": "5.6.1-pre.1966",
+    "@openmrs/esm-extensions": "5.6.1-pre.1966",
+    "@openmrs/esm-feature-flags": "5.6.1-pre.1966",
+    "@openmrs/esm-globals": "5.6.1-pre.1966",
+    "@openmrs/esm-navigation": "5.6.1-pre.1966",
+    "@openmrs/esm-offline": "5.6.1-pre.1966",
+    "@openmrs/esm-react-utils": "5.6.1-pre.1966",
+    "@openmrs/esm-routes": "5.6.1-pre.1966",
+    "@openmrs/esm-state": "5.6.1-pre.1966",
+    "@openmrs/esm-styleguide": "5.6.1-pre.1966",
+    "@openmrs/esm-translations": "5.6.1-pre.1966",
+    "@openmrs/esm-utils": "5.6.1-pre.1966",
     "dayjs": "^1.10.7"
   },
   "peerDependencies": {