@openmrs/esm-framework 6.3.1-pre.3092 → 6.3.1-pre.3104

package/docs/interfaces/OpenmrsAppContextProps.md

@@ -1,40 +1,31 @@
-[@openmrs/esm-framework](../API.md) / OpenmrsAppContextProps
+[O3 Framework](../API.md) / OpenmrsAppContextProps
 
-# Interface: OpenmrsAppContextProps<T\>
+# Interface: OpenmrsAppContextProps\<T\>
 
-## Type parameters
+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)
 
-| Name | Type |
-| :------ | :------ |
-| `T` | `unknown` |
+## Type Parameters
 
-## Table of contents
+### T
 
-### Context Properties
+`T` = `unknown`
 
-- [namespace](OpenmrsAppContextProps.md#namespace)
-- [value](OpenmrsAppContextProps.md#value)
-
-## Context Properties
+## Properties
 
 ### namespace
 
-• **namespace**: `string`
+> **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/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L6)
 
-#### Defined in
+the namespace that this component defines
 
-[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?
 
-### value
+> `optional` **value**: `T`
 
-• `Optional` **value**: `T`
+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)
 
 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,133 +1,103 @@
-[@openmrs/esm-framework](../API.md) / OpenmrsAppRoutes
+[O3 Framework](../API.md) / OpenmrsAppRoutes
 
 # Interface: OpenmrsAppRoutes
 
-This interface describes the format of the routes provided by an app
-
-## Table of contents
+Defined in: packages/framework/esm-globals/dist/types.d.ts:356
 
-### 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)
+This interface describes the format of the routes provided by an app
 
 ## Properties
 
-### backendDependencies
+### backendDependencies?
 
-• `Optional` **backendDependencies**: `Record`<`string`, `string`\>
+> `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
 
-#### Defined in
+A list of backend modules necessary for this frontend module and the corresponding required versions.
 
-packages/framework/esm-globals/dist/types.d.ts:360
+***
 
-___
+### extensions?
 
-### extensions
+> `optional` **extensions**: [`ExtensionDefinition`](../type-aliases/ExtensionDefinition.md)[]
 
-• `Optional` **extensions**: [`ExtensionDefinition`](../API.md#extensiondefinition)[]
+Defined in: packages/framework/esm-globals/dist/types.d.ts:374
 
 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
+***
 
-packages/framework/esm-globals/dist/types.d.ts:374
+### featureFlags?
 
-___
+> `optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
 
-### featureFlags
-
-• `Optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
+Defined in: packages/framework/esm-globals/dist/types.d.ts:376
 
 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?
 
-### modals
+> `optional` **modals**: [`ModalDefinition`](../type-aliases/ModalDefinition.md)[]
 
-• `Optional` **modals**: [`ModalDefinition`](../API.md#modaldefinition)[]
+Defined in: packages/framework/esm-globals/dist/types.d.ts:378
 
 An array of all modals supported by this frontend module. Modals can be launched by name.
 
-#### Defined in
+***
 
-packages/framework/esm-globals/dist/types.d.ts:378
+### optionalBackendDependencies?
 
-___
+> `optional` **optionalBackendDependencies**: `object`
 
-### optionalBackendDependencies
-
-• `Optional` **optionalBackendDependencies**: `Object`
+Defined in: packages/framework/esm-globals/dist/types.d.ts:362
 
 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?
 
-### pages
+> `optional` **pages**: [`PageDefinition`](../type-aliases/PageDefinition.md)[]
 
-• `Optional` **pages**: [`PageDefinition`](../API.md#pagedefinition)[]
+Defined in: packages/framework/esm-globals/dist/types.d.ts:372
 
 An array of all pages supported by this frontend module. Pages are automatically mounted based on a route.
 
-#### Defined in
+***
 
-packages/framework/esm-globals/dist/types.d.ts:372
+### version?
 
-___
+> `optional` **version**: `string`
 
-### version
-
-• `Optional` **version**: `string`
+Defined in: packages/framework/esm-globals/dist/types.d.ts:358
 
 The version of this frontend module.
 
-#### Defined in
-
-packages/framework/esm-globals/dist/types.d.ts:358
+***
 
-___
+### workspaceGroups?
 
-### workspaceGroups
+> `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
 
-• `Optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
+Defined in: packages/framework/esm-globals/dist/types.d.ts:382
 
 An array of all workspace groups supported by this frontend module.
 
-#### Defined in
+***
 
-packages/framework/esm-globals/dist/types.d.ts:382
+### workspaces?
 
-___
+> `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
 
-### workspaces
-
-• `Optional` **workspaces**: [`WorkspaceDefinition`](../API.md#workspacedefinition)[]
+Defined in: packages/framework/esm-globals/dist/types.d.ts:380
 
 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