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

package/docs/interfaces/CloseWorkspaceOptions.md

@@ -1,54 +0,0 @@
-[O3 Framework](../API.md) / CloseWorkspaceOptions
-
-# Interface: CloseWorkspaceOptions
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L15)
-
-## Properties
-
-### closeWorkspaceGroup?
-
-> `optional` **closeWorkspaceGroup**: `boolean`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L37)
-
-Controls whether the workspace group should be closed and store to be
-cleared when this workspace is closed.
-Defaults to true except when opening a new workspace of the same group.
-
-#### Default
-
-```ts
-true
-```
-
-***
-
-### ignoreChanges?
-
-> `optional` **ignoreChanges**: `boolean`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L22)
-
-Whether to close the workspace ignoring all the changes present in the workspace.
-
-If ignoreChanges is true, the user will not be prompted to save changes before closing
-even if the `testFcn` passed to `promptBeforeClosing` returns `true`.
-
-***
-
-### onWorkspaceClose()?
-
-> `optional` **onWorkspaceClose**: () => `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L29)
-
-If you want to take an action after the workspace is closed, you can pass your function as
-`onWorkspaceClose`. This function will be called only after the workspace is closed, given
-that the user might be shown a prompt.
-
-#### Returns
-
-`void`
-
-void

package/docs/interfaces/DefaultWorkspaceProps.md

@@ -1,113 +0,0 @@
-[O3 Framework](../API.md) / DefaultWorkspaceProps
-
-# Interface: DefaultWorkspaceProps
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L41)
-
-The default parameters received by all workspaces
-
-## Extended by
-
-- [`OpenWorkspace`](OpenWorkspace.md)
-
-## Methods
-
-### closeWorkspace()
-
-> **closeWorkspace**(`closeWorkspaceOptions?`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L49)
-
-Call this function to close the workspace. This function will prompt the user
-if there are any unsaved changes to workspace.
-
-You can pass `onWorkspaceClose` function to be called when the workspace is finally
-closed, given the user forcefully closes the workspace.
-
-#### Parameters
-
-##### closeWorkspaceOptions?
-
-[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
-
-#### Returns
-
-`void`
-
-***
-
-### closeWorkspaceWithSavedChanges()
-
-> **closeWorkspaceWithSavedChanges**(`closeWorkspaceOptions?`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L59)
-
-Call this function to close the workspace after the form is saved. This function
-will directly close the workspace without any prompt
-
-#### Parameters
-
-##### closeWorkspaceOptions?
-
-[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
-
-#### Returns
-
-`void`
-
-***
-
-### promptBeforeClosing()
-
-> **promptBeforeClosing**(`testFcn`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L54)
-
-Call this with a no-args function that returns true if the user should be prompted before
-this workspace is closed; e.g. if there is unsaved data.
-
-#### Parameters
-
-##### testFcn
-
-() => `boolean`
-
-#### Returns
-
-`void`
-
-***
-
-### setTitle()
-
-> **setTitle**(`title`, `titleNode?`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L74)
-
-Use this to set the workspace title if it needs to be set dynamically.
-
-Workspace titles generally are set in the workspace declaration in the routes.json file. They can also
-be set by the workspace launcher by passing `workspaceTitle` in the `additionalProps`
-parameter of the `launchWorkspace` function. This function is useful when the workspace
-title needs to be set dynamically.
-
-#### Parameters
-
-##### title
-
-`string`
-
-The title to set. If using titleNode, set this to a human-readable string
-       which will identify the workspace in notifications and other places.
-
-##### titleNode?
-
-`ReactNode`
-
-A React object to put in the workspace header in place of the title. This
-       is useful for displaying custom elements in the header. Note that custom header
-       elements can also be attached to the workspace header extension slots.
-
-#### Returns
-
-`void`

package/docs/interfaces/OpenWorkspace.md

@@ -1,281 +0,0 @@
-[O3 Framework](../API.md) / OpenWorkspace
-
-# Interface: OpenWorkspace
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L113)
-
-See [[WorkspaceDefinition]] for more information about these properties
-
-## Extends
-
-- [`WorkspaceRegistration`](WorkspaceRegistration.md).[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md)
-
-## Properties
-
-### additionalProps
-
-> **additionalProps**: `object`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L114)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`canHide`](WorkspaceRegistration.md#canhide)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`canMaximize`](WorkspaceRegistration.md#canmaximize)
-
-***
-
-### currentWorkspaceGroup?
-
-> `optional` **currentWorkspaceGroup**: `string`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L115)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`groups`](WorkspaceRegistration.md#groups)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`moduleName`](WorkspaceRegistration.md#modulename)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`name`](WorkspaceRegistration.md#name)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`preferredWindowSize`](WorkspaceRegistration.md#preferredwindowsize)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`title`](WorkspaceRegistration.md#title)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`titleNode`](WorkspaceRegistration.md#titlenode)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`type`](WorkspaceRegistration.md#type)
-
-***
-
-### 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)
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`width`](WorkspaceRegistration.md#width)
-
-## Methods
-
-### closeWorkspace()
-
-> **closeWorkspace**(`closeWorkspaceOptions?`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L49)
-
-Call this function to close the workspace. This function will prompt the user
-if there are any unsaved changes to workspace.
-
-You can pass `onWorkspaceClose` function to be called when the workspace is finally
-closed, given the user forcefully closes the workspace.
-
-#### Parameters
-
-##### closeWorkspaceOptions?
-
-[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`closeWorkspace`](DefaultWorkspaceProps.md#closeworkspace)
-
-***
-
-### closeWorkspaceWithSavedChanges()
-
-> **closeWorkspaceWithSavedChanges**(`closeWorkspaceOptions?`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L59)
-
-Call this function to close the workspace after the form is saved. This function
-will directly close the workspace without any prompt
-
-#### Parameters
-
-##### closeWorkspaceOptions?
-
-[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`closeWorkspaceWithSavedChanges`](DefaultWorkspaceProps.md#closeworkspacewithsavedchanges)
-
-***
-
-### 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`\>
-
-#### Inherited from
-
-[`WorkspaceRegistration`](WorkspaceRegistration.md).[`load`](WorkspaceRegistration.md#load)
-
-***
-
-### promptBeforeClosing()
-
-> **promptBeforeClosing**(`testFcn`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L54)
-
-Call this with a no-args function that returns true if the user should be prompted before
-this workspace is closed; e.g. if there is unsaved data.
-
-#### Parameters
-
-##### testFcn
-
-() => `boolean`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`promptBeforeClosing`](DefaultWorkspaceProps.md#promptbeforeclosing)
-
-***
-
-### setTitle()
-
-> **setTitle**(`title`, `titleNode?`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L74)
-
-Use this to set the workspace title if it needs to be set dynamically.
-
-Workspace titles generally are set in the workspace declaration in the routes.json file. They can also
-be set by the workspace launcher by passing `workspaceTitle` in the `additionalProps`
-parameter of the `launchWorkspace` function. This function is useful when the workspace
-title needs to be set dynamically.
-
-#### Parameters
-
-##### title
-
-`string`
-
-The title to set. If using titleNode, set this to a human-readable string
-       which will identify the workspace in notifications and other places.
-
-##### titleNode?
-
-`ReactNode`
-
-A React object to put in the workspace header in place of the title. This
-       is useful for displaying custom elements in the header. Note that custom header
-       elements can also be attached to the workspace header extension slots.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`setTitle`](DefaultWorkspaceProps.md#settitle)

package/docs/interfaces/Prompt.md

@@ -1,53 +0,0 @@
-[O3 Framework](../API.md) / Prompt
-
-# Interface: Prompt
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L91)
-
-## Properties
-
-### body
-
-> **body**: `string`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L93)
-
-***
-
-### cancelText?
-
-> `optional` **cancelText**: `string`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L98)
-
-Defaults to "Cancel"
-
-***
-
-### confirmText?
-
-> `optional` **confirmText**: `string`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:95](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L95)
-
-Defaults to "Confirm"
-
-***
-
-### title
-
-> **title**: `string`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L92)
-
-## Methods
-
-### onConfirm()
-
-> **onConfirm**(): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L96)
-
-#### Returns
-
-`void`

package/docs/interfaces/WorkspaceContainerProps.md

@@ -1,64 +0,0 @@
-[O3 Framework](../API.md) / WorkspaceContainerProps
-
-# Interface: ~~WorkspaceContainerProps~~
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L18)
-
-## Deprecated
-
-Workspace container is no longer needed with workspace v2.
-
-## Properties
-
-### ~~actionMenuProps?~~
-
-> `optional` **actionMenuProps**: `Record`\<`string`, `unknown`\>
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L37)
-
-Props to pass to the action menu component.
-
-***
-
-### ~~additionalWorkspaceProps?~~
-
-> `optional` **additionalWorkspaceProps**: `object`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L35)
-
-Additional props to pass to the workspace. Using this is unusual; you will generally
-want to pass props to the workspace when you open it using `launchWorkspace`. Use this
-only for props that will apply to every workspace launched on the page where this
-component is mounted.
-
-***
-
-### ~~contextKey~~
-
-> **contextKey**: `string`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L24)
-
-The context key is a path element that identifies the pages on which workspaces should
-appear. Defined to ensure workspaces do not stay open when navigating between pages.
-Must be a valid sub-path of the URL, with no initial or trailing slash.
-
-***
-
-### ~~overlay?~~
-
-> `optional` **overlay**: `boolean`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L26)
-
-When true, renders the workspace as an overlay instead of a side panel window.
-
-***
-
-### ~~showSiderailAndBottomNav?~~
-
-> `optional` **showSiderailAndBottomNav**: `boolean`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L28)
-
-When true, renders the Siderail (desktop) or Bottom Nav (tablet/mobile) action menu.

package/docs/interfaces/WorkspaceGroupDefinition.md

@@ -1,25 +0,0 @@
-[O3 Framework](../API.md) / WorkspaceGroupDefinition
-
-# Interface: WorkspaceGroupDefinition
-
-Defined in: [packages/framework/esm-globals/src/types.ts:267](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L267)
-
-## Properties
-
-### members?
-
-> `optional` **members**: `string`[]
-
-Defined in: [packages/framework/esm-globals/src/types.ts:275](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L275)
-
-List of workspace names which are part of the workspace group.
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: [packages/framework/esm-globals/src/types.ts:271](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L271)
-
-Name of the workspace group. This is used to launch the workspace group