@openmrs/esm-framework 7.0.1-pre.3258 → 7.0.1-pre.3273

package/docs/type-aliases/WorkspaceDefinition.md

@@ -4,7 +4,7 @@
 
 > **WorkspaceDefinition** = `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:231
+Defined in: packages/framework/esm-globals/dist/types.d.ts:229
 
 A definition of a workspace as extracted from an app's routes.json
 
@@ -14,7 +14,7 @@ A definition of a workspace as extracted from an app's routes.json
 
 > `optional` **canHide**: `boolean`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:247
+Defined in: packages/framework/esm-globals/dist/types.d.ts:245
 
 ***
 
@@ -22,7 +22,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:247
 
 > `optional` **canMaximize**: `boolean`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:248
+Defined in: packages/framework/esm-globals/dist/types.d.ts:246
 
 ***
 
@@ -30,7 +30,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:248
 
 > **component**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:283
+Defined in: packages/framework/esm-globals/dist/types.d.ts:281
 
 The name of the component exported by this frontend module.
 
@@ -40,7 +40,7 @@ The name of the component exported by this frontend module.
 
 > **groups**: `string`[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:279
+Defined in: packages/framework/esm-globals/dist/types.d.ts:277
 
 Workspaces can open either independently or as part of a "workspace group". A
 "workspace group" groups related workspaces together, so that only one is visible
@@ -68,7 +68,7 @@ name, the entire workspace group will close, and the new workspace will launch i
 
 > **name**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:235
+Defined in: packages/framework/esm-globals/dist/types.d.ts:233
 
 The name of this workspace. This is used to launch the workspace.
 
@@ -78,7 +78,7 @@ The name of this workspace. This is used to launch the workspace.
 
 > `optional` **preferredWindowSize**: [`WorkspaceWindowState`](WorkspaceWindowState.md)
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:258
+Defined in: packages/framework/esm-globals/dist/types.d.ts:256
 
 Launches the workspace in the preferred size, it defaults to the 'narrow' width
 
@@ -88,7 +88,7 @@ Launches the workspace in the preferred size, it defaults to the 'narrow' width
 
 > **title**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:240
+Defined in: packages/framework/esm-globals/dist/types.d.ts:238
 
 The title of the workspace. This will be looked up as a key in the translations of the module
 defining the workspace.
@@ -99,7 +99,7 @@ defining the workspace.
 
 > **type**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:246
+Defined in: packages/framework/esm-globals/dist/types.d.ts:244
 
 The type of the workspace. Only one of each "type" of workspace is allowed to be open at a
 time. The default is "form". If the right sidebar is in use, then the type determines which
@@ -111,7 +111,7 @@ right sidebar icon corresponds to the workspace.
 
 > `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:254
+Defined in: packages/framework/esm-globals/dist/types.d.ts:252
 
 Controls the width of the workspace. The default is "narrow" and this should only be
 changed to "wider" if the workspace itself has internal navigation, like the form editor.

package/docs/type-aliases/WorkspaceWindowState.md

@@ -4,4 +4,4 @@
 
 > **WorkspaceWindowState** = `"maximized"` \| `"hidden"` \| `"normal"`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:227
+Defined in: packages/framework/esm-globals/dist/types.d.ts:225

package/docs/variables/ActionMenuButton2.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / ActionMenuButton2
+
+# Variable: ActionMenuButton2
+
+> `const` **ActionMenuButton2**: `React.FC`\<`ActionMenuButtonProps2`\>
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces2/action-menu2/action-menu-button2.component.tsx:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/action-menu2/action-menu-button2.component.tsx#L64)
+
+The ActionMenuButton2 component is used to render a button in the action menu of a workspace group.
+The button is associated with a specific workspace window, defined in routes.json of the app with the button.
+When one or more workspaces within the window are opened, the button will be highlighted.
+If the window is hidden, either `tagContent` (if defined) or an exclamation mark will be displayed
+on top of the icon.
+
+On clicked, The button either:
+1. restores the workspace window if it is opened and hidden; or
+2. launch a workspace from within that window, if the window is not opened.

package/docs/variables/Workspace2.md

@@ -0,0 +1,12 @@
+[O3 Framework](../API.md) / Workspace2
+
+# Variable: Workspace2
+
+> `const` **Workspace2**: `React.FC`\<`Workspace2Props`\>
+
+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)
+
+The Workspace2 component is used as a top-level container to render
+its children as content within a workspace. When creating a workspace
+component, `<Workspace2>` should be the top-level component returned,
+wrapping all of the workspace content.

package/mock-jest.tsx

@@ -93,6 +93,7 @@ export const ActionMenu = jest.fn(() => <div>Action Menu</div>);
 export const WorkspaceContainer = jest.fn(() => <div>Workspace Container</div>);
 export const closeWorkspace = jest.fn();
 export const launchWorkspace = jest.fn();
+export const launchWorkspace2 = jest.fn();
 export const launchWorkspaceGroup = jest.fn();
 export const navigateAndLaunchWorkspace = jest.fn();
 export const useWorkspaces = jest.fn();

package/mock.tsx

@@ -94,6 +94,7 @@ export const ActionMenu = vi.fn(() => <div>Action Menu</div>);
 export const WorkspaceContainer = vi.fn(() => <div>Workspace Container</div>);
 export const closeWorkspace = vi.fn();
 export const launchWorkspace = vi.fn();
+export const launchWorkspace2 = vi.fn();
 export const launchWorkspaceGroup = vi.fn();
 export const navigateAndLaunchWorkspace = vi.fn();
 export const useWorkspaces = vi.fn();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "7.0.1-pre.3258",
+  "version": "7.0.1-pre.3273",
   "license": "MPL-2.0",
   "type": "module",
   "module": "dist/openmrs-esm-framework.js",
@@ -59,24 +59,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "7.0.1-pre.3258",
-    "@openmrs/esm-config": "7.0.1-pre.3258",
-    "@openmrs/esm-context": "7.0.1-pre.3258",
-    "@openmrs/esm-dynamic-loading": "7.0.1-pre.3258",
-    "@openmrs/esm-emr-api": "7.0.1-pre.3258",
-    "@openmrs/esm-error-handling": "7.0.1-pre.3258",
-    "@openmrs/esm-expression-evaluator": "7.0.1-pre.3258",
-    "@openmrs/esm-extensions": "7.0.1-pre.3258",
-    "@openmrs/esm-feature-flags": "7.0.1-pre.3258",
-    "@openmrs/esm-globals": "7.0.1-pre.3258",
-    "@openmrs/esm-navigation": "7.0.1-pre.3258",
-    "@openmrs/esm-offline": "7.0.1-pre.3258",
-    "@openmrs/esm-react-utils": "7.0.1-pre.3258",
-    "@openmrs/esm-routes": "7.0.1-pre.3258",
-    "@openmrs/esm-state": "7.0.1-pre.3258",
-    "@openmrs/esm-styleguide": "7.0.1-pre.3258",
-    "@openmrs/esm-translations": "7.0.1-pre.3258",
-    "@openmrs/esm-utils": "7.0.1-pre.3258"
+    "@openmrs/esm-api": "7.0.1-pre.3273",
+    "@openmrs/esm-config": "7.0.1-pre.3273",
+    "@openmrs/esm-context": "7.0.1-pre.3273",
+    "@openmrs/esm-dynamic-loading": "7.0.1-pre.3273",
+    "@openmrs/esm-emr-api": "7.0.1-pre.3273",
+    "@openmrs/esm-error-handling": "7.0.1-pre.3273",
+    "@openmrs/esm-expression-evaluator": "7.0.1-pre.3273",
+    "@openmrs/esm-extensions": "7.0.1-pre.3273",
+    "@openmrs/esm-feature-flags": "7.0.1-pre.3273",
+    "@openmrs/esm-globals": "7.0.1-pre.3273",
+    "@openmrs/esm-navigation": "7.0.1-pre.3273",
+    "@openmrs/esm-offline": "7.0.1-pre.3273",
+    "@openmrs/esm-react-utils": "7.0.1-pre.3273",
+    "@openmrs/esm-routes": "7.0.1-pre.3273",
+    "@openmrs/esm-state": "7.0.1-pre.3273",
+    "@openmrs/esm-styleguide": "7.0.1-pre.3273",
+    "@openmrs/esm-translations": "7.0.1-pre.3273",
+    "@openmrs/esm-utils": "7.0.1-pre.3273"
   },
   "peerDependencies": {
     "dayjs": "1.x",
@@ -89,7 +89,7 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/typedoc-plugin-file-categories": "7.0.1-pre.3258",
+    "@openmrs/typedoc-plugin-file-categories": "7.0.1-pre.3273",
     "@rspack/cli": "^1.3.11",
     "@rspack/core": "^1.3.11",
     "concurrently": "^9.1.2",