@openmrs/esm-framework 6.3.1-pre.3012 → 6.3.1-pre.3016

package/docs/API.md

@@ -191,8 +191,12 @@
 - [isOnline](API.md#isonline)
 - [isVersionSatisfied](API.md#isversionsatisfied)
 - [reportError](API.md#reporterror)
+- [setLeftNav](API.md#setleftnav)
+- [unsetLeftNav](API.md#unsetleftnav)
 - [useFhirFetchAll](API.md#usefhirfetchall)
 - [useFhirInfinite](API.md#usefhirinfinite)
+- [useLeftNav](API.md#useleftnav)
+- [useLeftNavStore](API.md#useleftnavstore)
 - [useVisitContextStore](API.md#usevisitcontextstore)
 
 ### Store Functions
@@ -220,7 +224,6 @@
 - [PatientPhoto](API.md#patientphoto)
 - [getFhirServerPaginationHandlers](API.md#getfhirserverpaginationhandlers)
 - [isDesktop](API.md#isdesktop)
-- [setLeftNav](API.md#setleftnav)
 - [showActionableNotification](API.md#showactionablenotification)
 - [showModal](API.md#showmodal)
 - [showNotification](API.md#shownotification)
@@ -230,11 +233,9 @@
 - [subscribeNotificationShown](API.md#subscribenotificationshown)
 - [subscribeSnackbarShown](API.md#subscribesnackbarshown)
 - [subscribeToastShown](API.md#subscribetoastshown)
-- [unsetLeftNav](API.md#unsetleftnav)
 - [useBodyScrollLock](API.md#usebodyscrolllock)
 - [useFhirPagination](API.md#usefhirpagination)
 - [useLayoutType](API.md#uselayouttype)
-- [useLeftNavStore](API.md#useleftnavstore)
 - [useOnClickOutside](API.md#useonclickoutside)
 - [useOnVisible](API.md#useonvisible)
 - [useOpenmrsFetchAll](API.md#useopenmrsfetchall)
@@ -2398,7 +2399,7 @@ is deprecated; it simply renders nothing.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/left-nav/index.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L52)
+[packages/framework/esm-styleguide/src/left-nav/index.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L20)
 
 ___
 
@@ -3609,7 +3610,7 @@ Use this React Hook to obtain your module's configuration.
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useConfig.ts:139](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConfig.ts#L139)
+[packages/framework/esm-react-utils/src/useConfig.ts:145](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConfig.ts#L145)
 
 ___
 
@@ -4478,7 +4479,7 @@ writing a module for a specific implementation.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:212](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L212)
+[packages/framework/esm-extensions/src/extensions.ts:215](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L215)
 
 ___
 
@@ -4501,7 +4502,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:245](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L245)
+[packages/framework/esm-extensions/src/extensions.ts:248](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L248)
 
 ___
 
@@ -4523,7 +4524,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:269](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L269)
+[packages/framework/esm-extensions/src/extensions.ts:272](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L272)
 
 ___
 
@@ -4547,7 +4548,7 @@ An array of extensions assigned to the named slot
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:396](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L396)
+[packages/framework/esm-extensions/src/extensions.ts:399](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L399)
 
 ___
 
@@ -4579,7 +4580,7 @@ getExtensionNameFromId("baz")
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:160](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L160)
+[packages/framework/esm-extensions/src/extensions.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L163)
 
 ___
 
@@ -6642,6 +6643,54 @@ packages/framework/esm-error-handling/dist/index.d.ts:1
 
 ___
 
+### setLeftNav
+
+▸ **setLeftNav**(`__namedParameters`): `void`
+
+Sets the current left nav context. Must be paired with [unsetLeftNav](API.md#unsetleftnav).
+
+**`deprecated`** Please use [useLeftNav](API.md#useleftnav) instead. This function will be made internal in a future release.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | [`SetLeftNavParams`](interfaces/SetLeftNavParams.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L35)
+
+___
+
+### unsetLeftNav
+
+▸ **unsetLeftNav**(`name`): `void`
+
+Unsets the left nav context if the current context is for the supplied name.
+
+**`deprecated`** Please use [useLeftNav](API.md#useleftnav) instead. This function will be made internal in a future release.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L44)
+
+___
+
 ### useFhirFetchAll
 
 ▸ **useFhirFetchAll**<`T`\>(`url`, `options?`): `UseServerInfiniteReturnObject`<`T`, `fhir.Bundle`\>
@@ -6722,6 +6771,40 @@ a UseServerInfiniteReturnObject object
 
 ___
 
+### useLeftNav
+
+▸ **useLeftNav**(`params`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Omit`<`SetLeftNavParams`, ``"module"``\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/useLeftNav.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLeftNav.ts#L5)
+
+___
+
+### useLeftNavStore
+
+▸ **useLeftNavStore**(): `LeftNavStore`
+
+#### Returns
+
+`LeftNavStore`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/useLeftNavStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLeftNavStore.ts#L4)
+
+___
+
 ### useVisitContextStore
 
 ▸ **useVisitContextStore**(`mutateVisitCallback?`): `VisitStoreState` & `BindFunctionsIn`<{ `mutateVisit`: (`currState`: `VisitStoreState`) => {} ; `setVisitContext`: (`_`: `VisitStoreState`, `newSelectedVisit`: ``null`` \| `Visit`) => { `manuallySetVisitUuid`: ``null`` \| `string` ; `patientUuid`: ``null`` \| `string`  }  }\>
@@ -7334,26 +7417,6 @@ ___
 
 ___
 
-### setLeftNav
-
-▸ **setLeftNav**(`__namedParameters`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `__namedParameters` | `SetLeftNavParams` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/framework/esm-styleguide/src/left-nav/index.tsx:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L31)
-
-___
-
 ### showActionableNotification
 
 ▸ **showActionableNotification**(`notification`): `void`
@@ -7591,26 +7654,6 @@ packages/framework/esm-globals/dist/events.d.ts:62
 
 ___
 
-### unsetLeftNav
-
-▸ **unsetLeftNav**(`name`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/framework/esm-styleguide/src/left-nav/index.tsx:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L35)
-
-___
-
 ### useBodyScrollLock
 
 ▸ **useBodyScrollLock**(`active`): `void`
@@ -7705,20 +7748,6 @@ ___
 
 ___
 
-### useLeftNavStore
-
-▸ **useLeftNavStore**(): `LeftNavStore`
-
-#### Returns
-
-`LeftNavStore`
-
-#### Defined in
-
-[packages/framework/esm-styleguide/src/left-nav/index.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L41)
-
-___
-
 ### useOnClickOutside
 
 ▸ **useOnClickOutside**<`T`\>(`handler`, `active?`): `RefObject`<`T`\>

package/docs/interfaces/ComponentConfig.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / ComponentConfig
+
+# Interface: ComponentConfig
+
+## Table of contents
+
+### Properties
+
+- [extension](ComponentConfig.md#extension)
+- [featureName](ComponentConfig.md#featurename)
+- [moduleName](ComponentConfig.md#modulename)
+
+## Properties
+
+### extension
+
+• `Optional` **extension**: [`ExtensionData`](ExtensionData.md)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L10)
+
+___
+
+### featureName
+
+• **featureName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L9)
+
+___
+
+### moduleName
+
+• **moduleName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L8)

package/docs/interfaces/ExtensionData.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ComponentContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L6)
+[packages/framework/esm-extensions/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L4)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ComponentContext.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L5)
+[packages/framework/esm-extensions/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L3)
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ComponentContext.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L4)
+[packages/framework/esm-extensions/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L2)

package/docs/interfaces/LeftNavStore.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / LeftNavStore
+
+# Interface: LeftNavStore
+
+## Table of contents
+
+### Properties
+
+- [basePath](LeftNavStore.md#basepath)
+- [componentContext](LeftNavStore.md#componentcontext)
+- [mode](LeftNavStore.md#mode)
+- [slotName](LeftNavStore.md#slotname)
+
+## Properties
+
+### basePath
+
+• **basePath**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L7)
+
+___
+
+### componentContext
+
+• `Optional` **componentContext**: [`ComponentConfig`](ComponentConfig.md)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L9)
+
+___
+
+### mode
+
+• **mode**: ``"normal"`` \| ``"collapsed"``
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L8)
+
+___
+
+### slotName
+
+• **slotName**: ``null`` \| `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L6)

package/docs/interfaces/SetLeftNavParams.md

@@ -0,0 +1,55 @@
+[@openmrs/esm-framework](../API.md) / SetLeftNavParams
+
+# Interface: SetLeftNavParams
+
+## Table of contents
+
+### Properties
+
+- [basePath](SetLeftNavParams.md#basepath)
+- [componentContext](SetLeftNavParams.md#componentcontext)
+- [mode](SetLeftNavParams.md#mode)
+- [name](SetLeftNavParams.md#name)
+
+## Properties
+
+### basePath
+
+• **basePath**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L21)
+
+___
+
+### componentContext
+
+• `Optional` **componentContext**: [`ComponentConfig`](ComponentConfig.md)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L27)
+
+___
+
+### mode
+
+• `Optional` **mode**: ``"normal"`` \| ``"collapsed"``
+
+In normal mode, the left nav is shown in desktop mode, and collapse into hamburger menu button in tablet mode
+In collapsed mode, the left nav is always collapsed, regardless of desktop / tablet mode
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L26)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/left-nav.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L20)

package/docs/interfaces/UseConfigOptions.md

@@ -19,4 +19,4 @@ absolutely necessary as it can end up making frontend modules coupled to one ano
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useConfig.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConfig.ts#L131)
+[packages/framework/esm-react-utils/src/useConfig.ts:137](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConfig.ts#L137)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "6.3.1-pre.3012",
+  "version": "6.3.1-pre.3016",
   "license": "MPL-2.0",
   "type": "module",
   "module": "dist/openmrs-esm-framework.js",
@@ -59,24 +59,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "6.3.1-pre.3012",
-    "@openmrs/esm-config": "6.3.1-pre.3012",
-    "@openmrs/esm-context": "6.3.1-pre.3012",
-    "@openmrs/esm-dynamic-loading": "6.3.1-pre.3012",
-    "@openmrs/esm-emr-api": "6.3.1-pre.3012",
-    "@openmrs/esm-error-handling": "6.3.1-pre.3012",
-    "@openmrs/esm-expression-evaluator": "6.3.1-pre.3012",
-    "@openmrs/esm-extensions": "6.3.1-pre.3012",
-    "@openmrs/esm-feature-flags": "6.3.1-pre.3012",
-    "@openmrs/esm-globals": "6.3.1-pre.3012",
-    "@openmrs/esm-navigation": "6.3.1-pre.3012",
-    "@openmrs/esm-offline": "6.3.1-pre.3012",
-    "@openmrs/esm-react-utils": "6.3.1-pre.3012",
-    "@openmrs/esm-routes": "6.3.1-pre.3012",
-    "@openmrs/esm-state": "6.3.1-pre.3012",
-    "@openmrs/esm-styleguide": "6.3.1-pre.3012",
-    "@openmrs/esm-translations": "6.3.1-pre.3012",
-    "@openmrs/esm-utils": "6.3.1-pre.3012"
+    "@openmrs/esm-api": "6.3.1-pre.3016",
+    "@openmrs/esm-config": "6.3.1-pre.3016",
+    "@openmrs/esm-context": "6.3.1-pre.3016",
+    "@openmrs/esm-dynamic-loading": "6.3.1-pre.3016",
+    "@openmrs/esm-emr-api": "6.3.1-pre.3016",
+    "@openmrs/esm-error-handling": "6.3.1-pre.3016",
+    "@openmrs/esm-expression-evaluator": "6.3.1-pre.3016",
+    "@openmrs/esm-extensions": "6.3.1-pre.3016",
+    "@openmrs/esm-feature-flags": "6.3.1-pre.3016",
+    "@openmrs/esm-globals": "6.3.1-pre.3016",
+    "@openmrs/esm-navigation": "6.3.1-pre.3016",
+    "@openmrs/esm-offline": "6.3.1-pre.3016",
+    "@openmrs/esm-react-utils": "6.3.1-pre.3016",
+    "@openmrs/esm-routes": "6.3.1-pre.3016",
+    "@openmrs/esm-state": "6.3.1-pre.3016",
+    "@openmrs/esm-styleguide": "6.3.1-pre.3016",
+    "@openmrs/esm-translations": "6.3.1-pre.3016",
+    "@openmrs/esm-utils": "6.3.1-pre.3016"
   },
   "peerDependencies": {
     "dayjs": "1.x",