@openmrs/esm-framework 10.0.1-pre.5652 → 10.0.1-pre.5670

package/docs/interfaces/WorkspaceRegistration.md

@@ -1,103 +0,0 @@
-[O3 Framework](../API.md) / WorkspaceRegistration
-
-# Interface: WorkspaceRegistration
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L9)
-
-See [[WorkspaceDefinition]] for more information about these properties
-
-## Extended by
-
-- [`OpenWorkspace`](OpenWorkspace.md)
-
-## Properties
-
-### canHide
-
-> **canHide**: `boolean`
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L14)
-
-***
-
-### canMaximize
-
-> **canMaximize**: `boolean`
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L15)
-
-***
-
-### groups
-
-> **groups**: `string`[]
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L20)
-
-***
-
-### moduleName
-
-> **moduleName**: `string`
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L19)
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L10)
-
-***
-
-### preferredWindowSize
-
-> **preferredWindowSize**: [`WorkspaceWindowState`](../type-aliases/WorkspaceWindowState.md)
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L17)
-
-***
-
-### title
-
-> **title**: `string`
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L11)
-
-***
-
-### titleNode?
-
-> `optional` **titleNode**: `ReactNode`
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L12)
-
-***
-
-### type
-
-> **type**: `string`
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L13)
-
-***
-
-### width
-
-> **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L16)
-
-## Methods
-
-### load()
-
-> **load**(): `Promise`\<`LifeCycles`\>
-
-Defined in: [packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L18)
-
-#### Returns
-
-`Promise`\<`LifeCycles`\>

package/docs/interfaces/WorkspacesInfo.md

@@ -1,61 +0,0 @@
-[O3 Framework](../API.md) / WorkspacesInfo
-
-# Interface: WorkspacesInfo
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:556](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L556)
-
-## Properties
-
-### active
-
-> **active**: `boolean`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:557](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L557)
-
-***
-
-### prompt
-
-> **prompt**: `null` \| [`Prompt`](Prompt.md)
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:558](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L558)
-
-***
-
-### workspaceGroup?
-
-> `optional` **workspaceGroup**: `object`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:561](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L561)
-
-#### cleanup()?
-
-> `optional` **cleanup**(): `void`
-
-##### Returns
-
-`void`
-
-#### members
-
-> **members**: `string`[]
-
-#### name
-
-> **name**: `string`
-
-***
-
-### workspaces
-
-> **workspaces**: [`OpenWorkspace`](OpenWorkspace.md)[]
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:560](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L560)
-
-***
-
-### workspaceWindowState
-
-> **workspaceWindowState**: [`WorkspaceWindowState`](../type-aliases/WorkspaceWindowState.md)
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:559](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L559)

package/docs/type-aliases/WorkspaceDefinition.md

@@ -1,118 +0,0 @@
-[O3 Framework](../API.md) / WorkspaceDefinition
-
-# Type Alias: WorkspaceDefinition
-
-> **WorkspaceDefinition** = `object`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:211](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L211)
-
-A definition of a workspace as extracted from an app's routes.json
-
-## Properties
-
-### canHide?
-
-> `optional` **canHide**: `boolean`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:227](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L227)
-
-***
-
-### canMaximize?
-
-> `optional` **canMaximize**: `boolean`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L228)
-
-***
-
-### component
-
-> **component**: `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)
-
-The name of the component exported by this frontend module.
-
-***
-
-### groups
-
-> **groups**: `string`[]
-
-Defined in: [packages/framework/esm-globals/src/types.ts:260](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L260)
-
-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
-at a time. For example,
-
-#### Example
-
-```ts
-{
-   *  name: 'order-basket',
-   *  type: 'order',
-   *  groups: ['ward-patient']
-   * }
-
-This means that the 'order-basket' workspace can be opened independently, or only
-in the 'ward-patient'.
-If a workspace group is already open and a new workspace is launched, and the
-groups in the newly launched workspace do not include the currently open group’s
-name, the entire workspace group will close, and the new workspace will launch independently.
-```
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:215](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L215)
-
-The name of this workspace. This is used to launch the workspace.
-
-***
-
-### preferredWindowSize?
-
-> `optional` **preferredWindowSize**: [`WorkspaceWindowState`](WorkspaceWindowState.md)
-
-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)
-
-Launches the workspace in the preferred size, it defaults to the 'narrow' width
-
-***
-
-### title
-
-> **title**: `string`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L220)
-
-The title of the workspace. This will be looked up as a key in the translations of the module
-defining the workspace.
-
-***
-
-### type
-
-> **type**: `string`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:226](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L226)
-
-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
-right sidebar icon corresponds to the workspace.
-
-***
-
-### width?
-
-> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:234](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L234)
-
-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.
-The width "extra-wide" is for workspaces that contain their own sidebar.

package/docs/type-aliases/WorkspaceWindowState.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / WorkspaceWindowState
-
-# Type Alias: WorkspaceWindowState
-
-> **WorkspaceWindowState** = `"maximized"` \| `"hidden"` \| `"normal"`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:206](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L206)

package/docs/variables/ActionMenuButton.md

@@ -1,12 +0,0 @@
-[O3 Framework](../API.md) / ActionMenuButton
-
-# Variable: ActionMenuButton
-
-> `const` **ActionMenuButton**: `React.FC`\<[`ActionMenuButtonProps`](../interfaces/ActionMenuButtonProps.md)\>
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L42)
-
-## Depcreated
-
-migrate to workspace v2 and use ActionMenuButton2. See:
-https://openmrs.atlassian.net/wiki/spaces/docs/pages/615677981/Workspace+v2+Migration+Guide