@openmrs/esm-framework 6.3.1-pre.3105 → 6.3.1-pre.3106

package/docs/interfaces/OpenWorkspace.md

@@ -1,174 +1,210 @@
-[O3 Framework](../API.md) / OpenWorkspace
+[@openmrs/esm-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/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L113)
+## Hierarchy
 
-The default parameters received by all workspaces
+- `WorkspaceRegistration`
 
-## Extends
+- [`DefaultWorkspaceProps`](DefaultWorkspaceProps.md)
 
-- `WorkspaceRegistration`.[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md)
+  ↳ **`OpenWorkspace`**
 
-## Properties
+## Table of contents
 
-### additionalProps
+### Other Properties
 
-> **additionalProps**: `object`
+- [canHide](OpenWorkspace.md#canhide)
+- [canMaximize](OpenWorkspace.md#canmaximize)
+- [groups](OpenWorkspace.md#groups)
+- [moduleName](OpenWorkspace.md#modulename)
+- [name](OpenWorkspace.md#name)
+- [preferredWindowSize](OpenWorkspace.md#preferredwindowsize)
+- [title](OpenWorkspace.md#title)
+- [titleNode](OpenWorkspace.md#titlenode)
+- [type](OpenWorkspace.md#type)
+- [width](OpenWorkspace.md#width)
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L114)
+### Workspace Properties
 
-***
+- [additionalProps](OpenWorkspace.md#additionalprops)
+- [currentWorkspaceGroup](OpenWorkspace.md#currentworkspacegroup)
 
-### canHide
+### Methods
+
+- [closeWorkspace](OpenWorkspace.md#closeworkspace)
+- [closeWorkspaceWithSavedChanges](OpenWorkspace.md#closeworkspacewithsavedchanges)
+- [load](OpenWorkspace.md#load)
+- [promptBeforeClosing](OpenWorkspace.md#promptbeforeclosing)
+- [setTitle](OpenWorkspace.md#settitle)
+
+## Other Properties
 
-> **canHide**: `boolean`
+### canHide
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:10
+• **canHide**: `boolean`
 
 #### Inherited from
 
-`WorkspaceRegistration.canHide`
+WorkspaceRegistration.canHide
 
-***
+#### Defined in
 
-### canMaximize
+packages/framework/esm-extensions/dist/workspaces.d.ts:10
 
-> **canMaximize**: `boolean`
+___
+
+### canMaximize
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:11
+• **canMaximize**: `boolean`
 
 #### Inherited from
 
-`WorkspaceRegistration.canMaximize`
+WorkspaceRegistration.canMaximize
 
-***
+#### Defined in
 
-### currentWorkspaceGroup?
+packages/framework/esm-extensions/dist/workspaces.d.ts:11
 
-> `optional` **currentWorkspaceGroup**: `string`
+___
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L115)
+### groups
 
-***
+• **groups**: `string`[]
 
-### groups
+#### Inherited from
 
-> **groups**: `string`[]
+WorkspaceRegistration.groups
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:18
+#### Defined in
 
-#### Inherited from
+packages/framework/esm-extensions/dist/workspaces.d.ts:18
 
-`WorkspaceRegistration.groups`
+___
 
-***
+### moduleName
+
+• **moduleName**: `string`
 
-### load()
+#### Inherited from
 
-> **load**: () => `Promise`\<`object` & `LifeCycles`\>
+WorkspaceRegistration.moduleName
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:14
+#### Defined in
 
-#### Returns
+packages/framework/esm-extensions/dist/workspaces.d.ts:17
 
-`Promise`\<`object` & `LifeCycles`\>
+___
+
+### name
+
+• **name**: `string`
 
 #### Inherited from
 
-`WorkspaceRegistration.load`
+WorkspaceRegistration.name
 
-***
+#### Defined in
 
-### moduleName
+packages/framework/esm-extensions/dist/workspaces.d.ts:6
 
-> **moduleName**: `string`
+___
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:17
+### preferredWindowSize
+
+• **preferredWindowSize**: [`WorkspaceWindowState`](../API.md#workspacewindowstate)
 
 #### Inherited from
 
-`WorkspaceRegistration.moduleName`
+WorkspaceRegistration.preferredWindowSize
 
-***
+#### Defined in
 
-### name
+packages/framework/esm-extensions/dist/workspaces.d.ts:13
+
+___
 
-> **name**: `string`
+### title
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:6
+• **title**: `string`
 
 #### Inherited from
 
-`WorkspaceRegistration.name`
+WorkspaceRegistration.title
 
-***
+#### Defined in
 
-### preferredWindowSize
+packages/framework/esm-extensions/dist/workspaces.d.ts:7
 
-> **preferredWindowSize**: [`WorkspaceWindowState`](../type-aliases/WorkspaceWindowState.md)
+___
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:13
+### titleNode
+
+• `Optional` **titleNode**: `ReactNode`
 
 #### Inherited from
 
-`WorkspaceRegistration.preferredWindowSize`
+WorkspaceRegistration.titleNode
 
-***
+#### Defined in
 
-### title
+packages/framework/esm-extensions/dist/workspaces.d.ts:8
 
-> **title**: `string`
+___
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:7
+### type
+
+• **type**: `string`
 
 #### Inherited from
 
-`WorkspaceRegistration.title`
+WorkspaceRegistration.type
 
-***
+#### Defined in
 
-### titleNode?
+packages/framework/esm-extensions/dist/workspaces.d.ts:9
 
-> `optional` **titleNode**: `ReactNode`
+___
+
+### width
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:8
+• **width**: ``"narrow"`` \| ``"wider"`` \| ``"extra-wide"``
 
 #### Inherited from
 
-`WorkspaceRegistration.titleNode`
+WorkspaceRegistration.width
 
-***
+#### Defined in
 
-### type
+packages/framework/esm-extensions/dist/workspaces.d.ts:12
 
-> **type**: `string`
+___
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:9
+## Workspace Properties
 
-#### Inherited from
+### additionalProps
 
-`WorkspaceRegistration.type`
+• **additionalProps**: `object`
 
-***
+#### Defined in
 
-### width
+[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)
 
-> **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
+___
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:12
+### currentWorkspaceGroup
 
-#### Inherited from
+• `Optional` **currentWorkspaceGroup**: `string`
 
-`WorkspaceRegistration.width`
+#### Defined in
 
-## Methods
+[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)
 
-### closeWorkspace()
+## Methods
 
-> **closeWorkspace**(`closeWorkspaceOptions?`): `void`
+### closeWorkspace
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L49)
+▸ **closeWorkspace**(`closeWorkspaceOptions?`): `void`
 
 Call this function to close the workspace. This function will prompt the user
 if there are any unsaved changes to workspace.
@@ -178,9 +214,9 @@ closed, given the user forcefully closes the workspace.
 
 #### Parameters
 
-##### closeWorkspaceOptions?
-
-[`CloseWorkspaceOptions`](CloseWorkspaceOptions.md)
+| Name | Type |
+| :------ | :------ |
+| `closeWorkspaceOptions?` | [`CloseWorkspaceOptions`](CloseWorkspaceOptions.md) |
 
 #### Returns
 
@@ -188,24 +224,26 @@ closed, given the user forcefully closes the workspace.
 
 #### Inherited from
 
-[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`closeWorkspace`](DefaultWorkspaceProps.md#closeworkspace)
+[DefaultWorkspaceProps](DefaultWorkspaceProps.md).[closeWorkspace](DefaultWorkspaceProps.md#closeworkspace)
 
-***
+#### Defined in
 
-### closeWorkspaceWithSavedChanges()
+[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)
 
-> **closeWorkspaceWithSavedChanges**(`closeWorkspaceOptions?`): `void`
+___
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L59)
+### closeWorkspaceWithSavedChanges
+
+▸ **closeWorkspaceWithSavedChanges**(`closeWorkspaceOptions?`): `void`
 
 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)
+| Name | Type |
+| :------ | :------ |
+| `closeWorkspaceOptions?` | [`CloseWorkspaceOptions`](CloseWorkspaceOptions.md) |
 
 #### Returns
 
@@ -213,24 +251,44 @@ will directly close the workspace without any prompt
 
 #### Inherited from
 
-[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`closeWorkspaceWithSavedChanges`](DefaultWorkspaceProps.md#closeworkspacewithsavedchanges)
+[DefaultWorkspaceProps](DefaultWorkspaceProps.md).[closeWorkspaceWithSavedChanges](DefaultWorkspaceProps.md#closeworkspacewithsavedchanges)
+
+#### 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)
 
-***
+___
 
-### promptBeforeClosing()
+### load
 
-> **promptBeforeClosing**(`testFcn`): `void`
+▸ **load**(): `Promise`<{ `default?`: `LifeCycles`<{}\>  } & `LifeCycles`<{}\>\>
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L54)
+#### Returns
+
+`Promise`<{ `default?`: `LifeCycles`<{}\>  } & `LifeCycles`<{}\>\>
+
+#### Inherited from
+
+WorkspaceRegistration.load
+
+#### Defined in
+
+packages/framework/esm-extensions/dist/workspaces.d.ts:14
+
+___
+
+### promptBeforeClosing
+
+▸ **promptBeforeClosing**(`testFcn`): `void`
 
 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`
+| Name | Type |
+| :------ | :------ |
+| `testFcn` | () => `boolean` |
 
 #### Returns
 
@@ -238,15 +296,17 @@ this workspace is closed; e.g. if there is unsaved data.
 
 #### Inherited from
 
-[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`promptBeforeClosing`](DefaultWorkspaceProps.md#promptbeforeclosing)
+[DefaultWorkspaceProps](DefaultWorkspaceProps.md).[promptBeforeClosing](DefaultWorkspaceProps.md#promptbeforeclosing)
+
+#### 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)
 
-### setTitle()
+___
 
-> **setTitle**(`title`, `titleNode?`): `void`
+### setTitle
 
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L74)
+▸ **setTitle**(`title`, `titleNode?`): `void`
 
 Use this to set the workspace title if it needs to be set dynamically.
 
@@ -257,20 +317,10 @@ 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.
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `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
 
@@ -278,4 +328,8 @@ A React object to put in the workspace header in place of the title. This
 
 #### Inherited from
 
-[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md).[`setTitle`](DefaultWorkspaceProps.md#settitle)
+[DefaultWorkspaceProps](DefaultWorkspaceProps.md).[setTitle](DefaultWorkspaceProps.md#settitle)
+
+#### 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)

package/docs/interfaces/OpenmrsAppContextProps.md

@@ -1,31 +1,40 @@
-[O3 Framework](../API.md) / OpenmrsAppContextProps
+[@openmrs/esm-framework](../API.md) / OpenmrsAppContextProps
 
-# Interface: OpenmrsAppContextProps\<T\>
+# Interface: OpenmrsAppContextProps<T\>
 
-Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L4)
+## Type parameters
 
-## Type Parameters
+| Name | Type |
+| :------ | :------ |
+| `T` | `unknown` |
 
-### T
+## Table of contents
 
-`T` = `unknown`
+### Context Properties
 
-## Properties
+- [namespace](OpenmrsAppContextProps.md#namespace)
+- [value](OpenmrsAppContextProps.md#value)
 
-### namespace
+## Context Properties
 
-> **namespace**: `string`
+### namespace
 
-Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L6)
+• **namespace**: `string`
 
 the namespace that this component defines
 
-***
+#### Defined in
+
+[packages/framework/esm-react-utils/src/OpenmrsContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L6)
 
-### value?
+___
 
-> `optional` **value**: `T`
+### value
 
-Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L8)
+• `Optional` **value**: `T`
 
 used to control the value associated with the namespace
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/OpenmrsContext.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L8)

package/docs/interfaces/OpenmrsAppRoutes.md

@@ -1,103 +1,133 @@
-[O3 Framework](../API.md) / OpenmrsAppRoutes
+[@openmrs/esm-framework](../API.md) / OpenmrsAppRoutes
 
 # Interface: OpenmrsAppRoutes
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:356
-
 This interface describes the format of the routes provided by an app
 
-## Properties
+## Table of contents
+
+### Properties
+
+- [backendDependencies](OpenmrsAppRoutes.md#backenddependencies)
+- [extensions](OpenmrsAppRoutes.md#extensions)
+- [featureFlags](OpenmrsAppRoutes.md#featureflags)
+- [modals](OpenmrsAppRoutes.md#modals)
+- [optionalBackendDependencies](OpenmrsAppRoutes.md#optionalbackenddependencies)
+- [pages](OpenmrsAppRoutes.md#pages)
+- [version](OpenmrsAppRoutes.md#version)
+- [workspaceGroups](OpenmrsAppRoutes.md#workspacegroups)
+- [workspaces](OpenmrsAppRoutes.md#workspaces)
 
-### backendDependencies?
+## Properties
 
-> `optional` **backendDependencies**: `Record`\<`string`, `string`\>
+### backendDependencies
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:360
+• `Optional` **backendDependencies**: `Record`<`string`, `string`\>
 
 A list of backend modules necessary for this frontend module and the corresponding required versions.
 
-***
+#### Defined in
+
+packages/framework/esm-globals/dist/types.d.ts:360
 
-### extensions?
+___
 
-> `optional` **extensions**: [`ExtensionDefinition`](../type-aliases/ExtensionDefinition.md)[]
+### extensions
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:374
+• `Optional` **extensions**: [`ExtensionDefinition`](../API.md#extensiondefinition)[]
 
 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.
 
-***
+#### Defined in
 
-### featureFlags?
+packages/framework/esm-globals/dist/types.d.ts:374
 
-> `optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
+___
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:376
+### featureFlags
+
+• `Optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
 
 An array of all feature flags for any beta-stage features this module provides.
 
-***
+#### Defined in
+
+packages/framework/esm-globals/dist/types.d.ts:376
 
-### modals?
+___
 
-> `optional` **modals**: [`ModalDefinition`](../type-aliases/ModalDefinition.md)[]
+### modals
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:378
+• `Optional` **modals**: [`ModalDefinition`](../API.md#modaldefinition)[]
 
 An array of all modals supported by this frontend module. Modals can be launched by name.
 
-***
+#### Defined in
 
-### optionalBackendDependencies?
+packages/framework/esm-globals/dist/types.d.ts:378
 
-> `optional` **optionalBackendDependencies**: `object`
+___
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:362
+### optionalBackendDependencies
+
+• `Optional` **optionalBackendDependencies**: `Object`
 
 A list of backend modules that may enable optional functionality in this frontend module if available and the corresponding required versions.
 
-#### Index Signature
+#### Index signature
 
-\[`key`: `string`\]: `string` \| \{ `feature?`: [`FeatureFlagDefinition`](FeatureFlagDefinition.md); `version`: `string`; \}
+▪ [key: `string`]: `string` \| { `feature?`: [`FeatureFlagDefinition`](FeatureFlagDefinition.md) ; `version`: `string`  }
 
 The name of the backend dependency and either the required version or an object describing the required version
 
-***
+#### Defined in
+
+packages/framework/esm-globals/dist/types.d.ts:362
 
-### pages?
+___
 
-> `optional` **pages**: [`PageDefinition`](../type-aliases/PageDefinition.md)[]
+### pages
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:372
+• `Optional` **pages**: [`PageDefinition`](../API.md#pagedefinition)[]
 
 An array of all pages supported by this frontend module. Pages are automatically mounted based on a route.
 
-***
+#### Defined in
 
-### version?
+packages/framework/esm-globals/dist/types.d.ts:372
 
-> `optional` **version**: `string`
+___
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:358
+### version
+
+• `Optional` **version**: `string`
 
 The version of this frontend module.
 
-***
+#### Defined in
+
+packages/framework/esm-globals/dist/types.d.ts:358
 
-### workspaceGroups?
+___
 
-> `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
+### workspaceGroups
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:382
+• `Optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
 
 An array of all workspace groups supported by this frontend module.
 
-***
+#### Defined in
 
-### workspaces?
+packages/framework/esm-globals/dist/types.d.ts:382
 
-> `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
+___
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:380
+### workspaces
+
+• `Optional` **workspaces**: [`WorkspaceDefinition`](../API.md#workspacedefinition)[]
 
 An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
+
+#### Defined in
+
+packages/framework/esm-globals/dist/types.d.ts:380