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

package/docs/functions/closeWorkspaceGroup2.md

@@ -0,0 +1,19 @@
+[O3 Framework](../API.md) / closeWorkspaceGroup2
+
+# Function: closeWorkspaceGroup2()
+
+> **closeWorkspaceGroup2**(): `Promise`\<`boolean`\>
+
+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)
+
+**`Experimental`**
+
+Closes the workspace group that is currently opened. Note that only one workspace group
+may be opened at any given time
+
+## Returns
+
+`Promise`\<`boolean`\>
+
+a Promise that resolves to true if there is no opened group to begin with or we successfully closed
+the opened group; false otherwise.

package/docs/functions/getCoreTranslation.md

@@ -17,7 +17,7 @@ invalid key to this function will result in a type error.
 
 ### key
 
-`"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"`
+`"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"`
 
 ### defaultText?
 

package/docs/functions/launchWorkspace2.md

@@ -0,0 +1,79 @@
+[O3 Framework](../API.md) / launchWorkspace2
+
+# Function: launchWorkspace2()
+
+> **launchWorkspace2**\<`WorkspaceProps`, `WindowProps`, `GroupProp`\>(`workspaceName`, `workspaceProps`, `windowProps`, `groupProps`): `Promise`\<`boolean`\>
+
+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)
+
+**`Experimental`**
+
+Attempts to launch the specified workspace with the given workspace props. This also implicitly opens
+the workspace window to which the workspace belongs (if it's not opened already),
+and the workspace group to which the window belongs (if it's not opened already).
+
+When calling `launchWorkspace2`, we need to also pass in the workspace props. While not required,
+we can also pass in the window props (shared by other workspaces in the window) and the group props
+(shared by all windows and their workspaces). Omitting the window props or the group props[^1] means the caller
+explicitly does not care what the current window props and group props are, and that they may be set
+by other actions (like calling `launchWorkspace2` on a different workspace with those props passed in)
+at a later time.
+
+If there is already an opened workspace group, and it's not the group the workspace belongs to
+or has incompatible[^2] group props, then we prompt the user to close the group (and its windows and their workspaces).
+On user confirm, the existing opened group is closed and the new workspace, along with its window and its group,
+is opened.
+
+If the window is already opened, but with incompatible window props, we prompt the user to close
+the window (and all its opened workspaces), and reopen the window with (only) the newly requested workspace.
+
+If the workspace is already opened, but with incompatible workspace props, we also prompt the user to close
+the **window** (and all its opened workspaces), and reopen the window with (only) the newly requested workspace.
+This is true regardless of whether the already opened workspace has any child workspaces.
+
+Note that calling this function *never* results in creating a child workspace in the affected window.
+To do so, we need to call `launchChildWorkspace` instead.
+
+[^1] Omitting window or group props is useful for workspaces that don't have ties to the window or group "context" (props).
+For example, in the patient chart, the visit notes / clinical forms / order basket action menu button all share
+a "group context" of the current visit. However, the "patient list" action menu button does not need to share that group
+context, so opening that workspace should not need to cause other workspaces / windows / groups to potentially close.
+The "patient search" workspace in the queues and ward apps is another example.
+
+[^2] 2 sets of props are compatible if either one is nullish, or if they are shallow equal.
+
+## Type Parameters
+
+### WorkspaceProps
+
+`WorkspaceProps` *extends* `object`
+
+### WindowProps
+
+`WindowProps` *extends* `object`
+
+### GroupProp
+
+`GroupProp` *extends* `object`
+
+## Parameters
+
+### workspaceName
+
+`string`
+
+### workspaceProps
+
+`null` | `WorkspaceProps`
+
+### windowProps
+
+`null` | `WindowProps`
+
+### groupProps
+
+`null` | `GroupProp`
+
+## Returns
+
+`Promise`\<`boolean`\>

package/docs/functions/launchWorkspaceGroup2.md

@@ -0,0 +1,40 @@
+[O3 Framework](../API.md) / launchWorkspaceGroup2
+
+# Function: launchWorkspaceGroup2()
+
+> **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)
+
+**`Experimental`**
+
+Attempts to launch the specified workspace group with the given group props. Note that only one workspace group
+may be opened at any given time. If a workspace group is already opened, calling `launchWorkspaceGroup2` with
+either a different group name, or same group name but different incompatible props**, will result in prompting to
+confirm closing workspaces. If the user confirms, the opened group, along with its windows (and their workspaces), is closed, and
+the requested group is immediately opened.
+
+** 2 sets of props are compatible if either one is nullish, or if they are shallow equal.
+
+## Type Parameters
+
+### GroupProps
+
+`GroupProps` *extends* `object`
+
+## Parameters
+
+### groupName
+
+`string`
+
+### groupProps
+
+`null` | `GroupProps`
+
+## Returns
+
+`Promise`\<`boolean`\>
+
+a Promise that resolves to true if the specified workspace group with the specified group props
+ is successfully opened, or that it already is opened.

package/docs/interfaces/FeatureFlagDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: FeatureFlagDefinition
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:300
+Defined in: packages/framework/esm-globals/dist/types.d.ts:316
 
 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:306
+Defined in: packages/framework/esm-globals/dist/types.d.ts:322
 
 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:302
+Defined in: packages/framework/esm-globals/dist/types.d.ts:318
 
 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:304
+Defined in: packages/framework/esm-globals/dist/types.d.ts:320
 
 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:309
+Defined in: packages/framework/esm-globals/dist/types.d.ts:325
 
 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:313
+Defined in: packages/framework/esm-globals/dist/types.d.ts:329
 
 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:327
+Defined in: packages/framework/esm-globals/dist/types.d.ts:343
 
 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:329
+Defined in: packages/framework/esm-globals/dist/types.d.ts:345
 
 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:331
+Defined in: packages/framework/esm-globals/dist/types.d.ts:347
 
 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:315
+Defined in: packages/framework/esm-globals/dist/types.d.ts:331
 
 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:325
+Defined in: packages/framework/esm-globals/dist/types.d.ts:341
 
 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:311
+Defined in: packages/framework/esm-globals/dist/types.d.ts:327
 
 The version of this frontend module.
 
@@ -88,16 +88,46 @@ The version of this frontend module.
 
 > `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:335
+Defined in: packages/framework/esm-globals/dist/types.d.ts:351
 
 An array of all workspace groups supported by this frontend module.
 
 ***
 
+### workspaceGroups2?
+
+> `optional` **workspaceGroups2**: [`WorkspaceGroupDefinition2`](WorkspaceGroupDefinition2.md)[]
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:353
+
+An array of all workspace groups (v2) supported by this frontend module.
+
+***
+
 ### workspaces?
 
 > `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:333
+Defined in: packages/framework/esm-globals/dist/types.d.ts:349
 
 An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
+
+***
+
+### workspaces2?
+
+> `optional` **workspaces2**: [`WorkspaceDefinition2`](WorkspaceDefinition2.md)[]
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:357
+
+An array of all workspaces (v2) supported by this frontend module.
+
+***
+
+### workspaceWindows2?
+
+> `optional` **workspaceWindows2**: [`WorkspaceWindowDefinition2`](WorkspaceWindowDefinition2.md)[]
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:355
+
+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:342
+Defined in: packages/framework/esm-globals/dist/types.d.ts:364
 
 ## Type Parameters
 
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:342
 
 > **ResourceLoader**(): `Promise`\<`T`\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:343
+Defined in: packages/framework/esm-globals/dist/types.d.ts:365
 
 ## Returns
 

package/docs/interfaces/WorkspaceDefinition2.md

@@ -0,0 +1,29 @@
+[O3 Framework](../API.md) / WorkspaceDefinition2
+
+# Interface: WorkspaceDefinition2
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:308
+
+## Properties
+
+### component
+
+> **component**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:310
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:309
+
+***
+
+### window
+
+> **window**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:311

package/docs/interfaces/WorkspaceGroupDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: WorkspaceGroupDefinition
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:287
+Defined in: packages/framework/esm-globals/dist/types.d.ts:283
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:287
 
 > `optional` **members**: `string`[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:295
+Defined in: packages/framework/esm-globals/dist/types.d.ts:291
 
 List of workspace names which are part of the workspace group.
 
@@ -20,6 +20,6 @@ List of workspace names which are part of the workspace group.
 
 > **name**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:291
+Defined in: packages/framework/esm-globals/dist/types.d.ts:287
 
 Name of the workspace group. This is used to launch the workspace group

package/docs/interfaces/WorkspaceGroupDefinition2.md

@@ -0,0 +1,29 @@
+[O3 Framework](../API.md) / WorkspaceGroupDefinition2
+
+# Interface: WorkspaceGroupDefinition2
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:293
+
+## Properties
+
+### closeable?
+
+> `optional` **closeable**: `boolean`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:295
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:294
+
+***
+
+### overlay?
+
+> `optional` **overlay**: `boolean`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:296

package/docs/interfaces/WorkspaceWindowDefinition2.md

@@ -0,0 +1,69 @@
+[O3 Framework](../API.md) / WorkspaceWindowDefinition2
+
+# Interface: WorkspaceWindowDefinition2
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:298
+
+## Properties
+
+### canHide
+
+> **canHide**: `boolean`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:301
+
+***
+
+### canMaximize
+
+> **canMaximize**: `boolean`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:302
+
+***
+
+### group
+
+> **group**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:304
+
+***
+
+### icon?
+
+> `optional` **icon**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:300
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:299
+
+***
+
+### order?
+
+> `optional` **order**: `number`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:305
+
+***
+
+### overlay
+
+> **overlay**: `boolean`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:303
+
+***
+
+### width?
+
+> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:306

package/docs/type-aliases/ExtensionDefinition.md

@@ -14,27 +14,17 @@ A definition of an extension as extracted from an app's routes.json
 
 > **component**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:214
+Defined in: packages/framework/esm-globals/dist/types.d.ts:210
 
 The name of the component exported by this frontend module.
 
 ***
 
-### displayExpression?
-
-> `optional` **displayExpression**: `string`
-
-Defined in: packages/framework/esm-globals/dist/types.d.ts:200
-
-The expression that determines whether the extension is displayed.
-
-***
-
 ### featureFlag?
 
 > `optional` **featureFlag**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:204
+Defined in: packages/framework/esm-globals/dist/types.d.ts:200
 
 If supplied, the extension will only be rendered when this feature flag is enabled.
 
@@ -44,7 +34,7 @@ If supplied, the extension will only be rendered when this feature flag is enabl
 
 > `optional` **meta**: `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:208
+Defined in: packages/framework/esm-globals/dist/types.d.ts:204
 
 Meta describes any properties that are passed down to the extension when it is loaded
 

package/docs/type-aliases/ModalDefinition.md

@@ -4,7 +4,7 @@
 
 > **ModalDefinition** = `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:219
+Defined in: packages/framework/esm-globals/dist/types.d.ts:215
 
 A definition of a modal as extracted from an app's routes.json
 
@@ -14,7 +14,7 @@ A definition of a modal as extracted from an app's routes.json
 
 > **component**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:227
+Defined in: packages/framework/esm-globals/dist/types.d.ts:223
 
 The name of the component exported by this frontend module.
 
@@ -24,6 +24,6 @@ The name of the component exported by this frontend module.
 
 > **name**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:223
+Defined in: packages/framework/esm-globals/dist/types.d.ts:219
 
 The name of this modal. This is used to launch the modal.

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:345
+Defined in: packages/framework/esm-globals/dist/types.d.ts:367

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:341
+Defined in: packages/framework/esm-globals/dist/types.d.ts:363
 
 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

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / Workspace2Definition
+
+# Type Alias: Workspace2Definition\<WorkspaceProps, WindowProps, GroupProps\>
+
+> **Workspace2Definition**\<`WorkspaceProps`, `WindowProps`, `GroupProps`\> = `React.FC`\<`Workspace2DefinitionProps`\<`WorkspaceProps`, `WindowProps`, `GroupProps`\>\>
+
+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)
+
+## Type Parameters
+
+### WorkspaceProps
+
+`WorkspaceProps` *extends* `object`
+
+### WindowProps
+
+`WindowProps` *extends* `object`
+
+### GroupProps
+
+`GroupProps` *extends* `object`

package/docs/type-aliases/WorkspaceDefinition.md

@@ -4,7 +4,7 @@
 
 > **WorkspaceDefinition** = `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:233
+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:249
+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:249
 
 > `optional` **canMaximize**: `boolean`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:250
+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:250
 
 > **component**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:285
+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:281
+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:237
+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:260
+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:242
+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:248
+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:256
+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.