@openmrs/esm-framework 6.2.1-pre.2791 → 6.2.1-pre.2794

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/.turbo/turbo-build.log +2 -2
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +25 -4
  5. package/docs/interfaces/Concept.md +2 -2
  6. package/docs/interfaces/ConceptClass.md +6 -6
  7. package/docs/interfaces/Diagnosis.md +4 -4
  8. package/docs/interfaces/Obs.md +6 -6
  9. package/docs/interfaces/OpenmrsResource.md +4 -0
  10. package/docs/interfaces/OpenmrsResourceStrict.md +0 -4
  11. package/package.json +18 -18
package/docs/API.md CHANGED
@@ -230,6 +230,7 @@
230
230
  - [useBodyScrollLock](API.md#usebodyscrolllock)
231
231
  - [useFhirPagination](API.md#usefhirpagination)
232
232
  - [useLayoutType](API.md#uselayouttype)
233
+ - [useLeftNavStore](API.md#useleftnavstore)
233
234
  - [useOnClickOutside](API.md#useonclickoutside)
234
235
  - [useOpenmrsFetchAll](API.md#useopenmrsfetchall)
235
236
  - [useOpenmrsInfinite](API.md#useopenmrsinfinite)
@@ -2363,9 +2364,15 @@ ___
2363
2364
 
2364
2365
  • `Const` **LeftNavMenu**: `ForwardRefExoticComponent`<`SideNavProps` & `RefAttributes`<`HTMLElement`\>\>
2365
2366
 
2367
+ This component renders the left nav in desktop mode. It's also used to render the same
2368
+ nav when the hamburger menu is clicked on in tablet mode. See side-menu-panel.component.tsx
2369
+
2370
+ Use of this component by anything other than <SideMenuPanel> (where isChildOfHeader == false)
2371
+ is deprecated; it simply renders nothing.
2372
+
2366
2373
  #### Defined in
2367
2374
 
2368
- [packages/framework/esm-styleguide/src/left-nav/index.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L30)
2375
+ [packages/framework/esm-styleguide/src/left-nav/index.tsx:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L53)
2369
2376
 
2370
2377
  ___
2371
2378
 
@@ -7115,7 +7122,7 @@ ___
7115
7122
 
7116
7123
  | Name | Type |
7117
7124
  | :------ | :------ |
7118
- | `__namedParameters` | `Object` |
7125
+ | `__namedParameters` | `SetLeftNavParams` |
7119
7126
 
7120
7127
  #### Returns
7121
7128
 
@@ -7123,7 +7130,7 @@ ___
7123
7130
 
7124
7131
  #### Defined in
7125
7132
 
7126
- [packages/framework/esm-styleguide/src/left-nav/index.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L18)
7133
+ [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)
7127
7134
 
7128
7135
  ___
7129
7136
 
@@ -7372,7 +7379,7 @@ ___
7372
7379
 
7373
7380
  #### Defined in
7374
7381
 
7375
- [packages/framework/esm-styleguide/src/left-nav/index.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L22)
7382
+ [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)
7376
7383
 
7377
7384
  ___
7378
7385
 
@@ -7470,6 +7477,20 @@ ___
7470
7477
 
7471
7478
  ___
7472
7479
 
7480
+ ### useLeftNavStore
7481
+
7482
+ ▸ **useLeftNavStore**(): `LeftNavStore`
7483
+
7484
+ #### Returns
7485
+
7486
+ `LeftNavStore`
7487
+
7488
+ #### Defined in
7489
+
7490
+ [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)
7491
+
7492
+ ___
7493
+
7473
7494
  ### useOnClickOutside
7474
7495
 
7475
7496
  ▸ **useOnClickOutside**<`T`\>(`handler`, `active?`): `RefObject`<`T`\>
package/docs/interfaces/Concept.md CHANGED
@@ -170,7 +170,7 @@ ___
170
170
 
171
171
  ### retired
172
172
 
173
- • **retired**: `boolean`
173
+ • `Optional` **retired**: `boolean`
174
174
 
175
175
  #### Defined in
176
176
 
@@ -214,7 +214,7 @@ ___
214
214
 
215
215
  ### version
216
216
 
217
- • **version**: `string`
217
+ • `Optional` **version**: `string`
218
218
 
219
219
  #### Defined in
220
220
 
package/docs/interfaces/ConceptClass.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Hierarchy
6
6
 
7
- - [`OpenmrsResourceStrict`](OpenmrsResourceStrict.md)
7
+ - [`OpenmrsResource`](OpenmrsResource.md)
8
8
 
9
9
  ↳ **`ConceptClass`**
10
10
 
@@ -29,7 +29,7 @@
29
29
 
30
30
  #### Inherited from
31
31
 
32
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[auditInfo](OpenmrsResourceStrict.md#auditinfo)
32
+ [OpenmrsResource](OpenmrsResource.md).[auditInfo](OpenmrsResource.md#auditinfo)
33
33
 
34
34
  #### Defined in
35
35
 
@@ -53,7 +53,7 @@ ___
53
53
 
54
54
  #### Inherited from
55
55
 
56
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[display](OpenmrsResourceStrict.md#display)
56
+ [OpenmrsResource](OpenmrsResource.md).[display](OpenmrsResource.md#display)
57
57
 
58
58
  #### Defined in
59
59
 
@@ -67,7 +67,7 @@ ___
67
67
 
68
68
  #### Inherited from
69
69
 
70
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[links](OpenmrsResourceStrict.md#links)
70
+ [OpenmrsResource](OpenmrsResource.md).[links](OpenmrsResource.md#links)
71
71
 
72
72
  #### Defined in
73
73
 
@@ -91,7 +91,7 @@ ___
91
91
 
92
92
  #### Inherited from
93
93
 
94
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[resourceVersion](OpenmrsResourceStrict.md#resourceversion)
94
+ [OpenmrsResource](OpenmrsResource.md).[resourceVersion](OpenmrsResource.md#resourceversion)
95
95
 
96
96
  #### Defined in
97
97
 
@@ -115,7 +115,7 @@ ___
115
115
 
116
116
  #### Inherited from
117
117
 
118
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[uuid](OpenmrsResourceStrict.md#uuid)
118
+ [OpenmrsResource](OpenmrsResource.md).[uuid](OpenmrsResource.md#uuid)
119
119
 
120
120
  #### Defined in
121
121
 
package/docs/interfaces/Diagnosis.md CHANGED
@@ -60,11 +60,11 @@ ___
60
60
 
61
61
  | Name | Type |
62
62
  | :------ | :------ |
63
- | `coded?` | { `conceptClass`: [`ConceptClass`](ConceptClass.md) ; `datatype`: [`OpenmrsResource`](OpenmrsResource.md) ; `display?`: `string` ; `name`: [`Concept`](Concept.md) ; `uuid`: `string` } |
64
- | `coded.conceptClass` | [`ConceptClass`](ConceptClass.md) |
65
- | `coded.datatype` | [`OpenmrsResource`](OpenmrsResource.md) |
63
+ | `coded?` | { `conceptClass?`: [`ConceptClass`](ConceptClass.md) ; `datatype?`: [`OpenmrsResource`](OpenmrsResource.md) ; `display?`: `string` ; `name?`: [`Concept`](Concept.md) ; `uuid`: `string` } |
64
+ | `coded.conceptClass?` | [`ConceptClass`](ConceptClass.md) |
65
+ | `coded.datatype?` | [`OpenmrsResource`](OpenmrsResource.md) |
66
66
  | `coded.display?` | `string` |
67
- | `coded.name` | [`Concept`](Concept.md) |
67
+ | `coded.name?` | [`Concept`](Concept.md) |
68
68
  | `coded.uuid` | `string` |
69
69
  | `nonCoded?` | `string` |
70
70
 
package/docs/interfaces/Obs.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Hierarchy
6
6
 
7
- - [`OpenmrsResourceStrict`](OpenmrsResourceStrict.md)
7
+ - [`OpenmrsResource`](OpenmrsResource.md)
8
8
 
9
9
  ↳ **`Obs`**
10
10
 
@@ -53,7 +53,7 @@ ___
53
53
 
54
54
  #### Inherited from
55
55
 
56
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[auditInfo](OpenmrsResourceStrict.md#auditinfo)
56
+ [OpenmrsResource](OpenmrsResource.md).[auditInfo](OpenmrsResource.md#auditinfo)
57
57
 
58
58
  #### Defined in
59
59
 
@@ -87,7 +87,7 @@ ___
87
87
 
88
88
  #### Inherited from
89
89
 
90
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[display](OpenmrsResourceStrict.md#display)
90
+ [OpenmrsResource](OpenmrsResource.md).[display](OpenmrsResource.md#display)
91
91
 
92
92
  #### Defined in
93
93
 
@@ -151,7 +151,7 @@ ___
151
151
 
152
152
  #### Inherited from
153
153
 
154
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[links](OpenmrsResourceStrict.md#links)
154
+ [OpenmrsResource](OpenmrsResource.md).[links](OpenmrsResource.md#links)
155
155
 
156
156
  #### Defined in
157
157
 
@@ -215,7 +215,7 @@ ___
215
215
 
216
216
  #### Inherited from
217
217
 
218
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[resourceVersion](OpenmrsResourceStrict.md#resourceversion)
218
+ [OpenmrsResource](OpenmrsResource.md).[resourceVersion](OpenmrsResource.md#resourceversion)
219
219
 
220
220
  #### Defined in
221
221
 
@@ -239,7 +239,7 @@ ___
239
239
 
240
240
  #### Inherited from
241
241
 
242
- [OpenmrsResourceStrict](OpenmrsResourceStrict.md).[uuid](OpenmrsResourceStrict.md#uuid)
242
+ [OpenmrsResource](OpenmrsResource.md).[uuid](OpenmrsResource.md#uuid)
243
243
 
244
244
  #### Defined in
245
245
 
package/docs/interfaces/OpenmrsResource.md CHANGED
@@ -14,6 +14,8 @@
14
14
 
15
15
  ↳↳ [`ConceptName`](ConceptName.md)
16
16
 
17
+ ↳↳ [`ConceptClass`](ConceptClass.md)
18
+
17
19
  ↳↳ [`Diagnosis`](Diagnosis.md)
18
20
 
19
21
  ↳↳ [`Encounter`](Encounter.md)
@@ -24,6 +26,8 @@
24
26
 
25
27
  ↳↳ [`EncounterRole`](EncounterRole.md)
26
28
 
29
+ ↳↳ [`Obs`](Obs.md)
30
+
27
31
  ↳↳ [`User`](User.md)
28
32
 
29
33
  ## Indexable
package/docs/interfaces/OpenmrsResourceStrict.md CHANGED
@@ -10,10 +10,6 @@ accounted for, use OpenmrsResource instead.
10
10
 
11
11
  - **`OpenmrsResourceStrict`**
12
12
 
13
- ↳ [`ConceptClass`](ConceptClass.md)
14
-
15
- ↳ [`Obs`](Obs.md)
16
-
17
13
  ↳ [`OpenmrsResource`](OpenmrsResource.md)
18
14
 
19
15
  ↳ [`PatientIdentifierType`](PatientIdentifierType.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "6.2.1-pre.2791",
3
+ "version": "6.2.1-pre.2794",
4
4
  "license": "MPL-2.0",
5
5
  "browser": "dist/openmrs-esm-framework.js",
6
6
  "main": "src/index.ts",
@@ -37,23 +37,23 @@
37
37
  "access": "public"
38
38
  },
39
39
  "dependencies": {
40
- "@openmrs/esm-api": "6.2.1-pre.2791",
41
- "@openmrs/esm-config": "6.2.1-pre.2791",
42
- "@openmrs/esm-context": "6.2.1-pre.2791",
43
- "@openmrs/esm-dynamic-loading": "6.2.1-pre.2791",
44
- "@openmrs/esm-error-handling": "6.2.1-pre.2791",
45
- "@openmrs/esm-expression-evaluator": "6.2.1-pre.2791",
46
- "@openmrs/esm-extensions": "6.2.1-pre.2791",
47
- "@openmrs/esm-feature-flags": "6.2.1-pre.2791",
48
- "@openmrs/esm-globals": "6.2.1-pre.2791",
49
- "@openmrs/esm-navigation": "6.2.1-pre.2791",
50
- "@openmrs/esm-offline": "6.2.1-pre.2791",
51
- "@openmrs/esm-react-utils": "6.2.1-pre.2791",
52
- "@openmrs/esm-routes": "6.2.1-pre.2791",
53
- "@openmrs/esm-state": "6.2.1-pre.2791",
54
- "@openmrs/esm-styleguide": "6.2.1-pre.2791",
55
- "@openmrs/esm-translations": "6.2.1-pre.2791",
56
- "@openmrs/esm-utils": "6.2.1-pre.2791",
40
+ "@openmrs/esm-api": "6.2.1-pre.2794",
41
+ "@openmrs/esm-config": "6.2.1-pre.2794",
42
+ "@openmrs/esm-context": "6.2.1-pre.2794",
43
+ "@openmrs/esm-dynamic-loading": "6.2.1-pre.2794",
44
+ "@openmrs/esm-error-handling": "6.2.1-pre.2794",
45
+ "@openmrs/esm-expression-evaluator": "6.2.1-pre.2794",
46
+ "@openmrs/esm-extensions": "6.2.1-pre.2794",
47
+ "@openmrs/esm-feature-flags": "6.2.1-pre.2794",
48
+ "@openmrs/esm-globals": "6.2.1-pre.2794",
49
+ "@openmrs/esm-navigation": "6.2.1-pre.2794",
50
+ "@openmrs/esm-offline": "6.2.1-pre.2794",
51
+ "@openmrs/esm-react-utils": "6.2.1-pre.2794",
52
+ "@openmrs/esm-routes": "6.2.1-pre.2794",
53
+ "@openmrs/esm-state": "6.2.1-pre.2794",
54
+ "@openmrs/esm-styleguide": "6.2.1-pre.2794",
55
+ "@openmrs/esm-translations": "6.2.1-pre.2794",
56
+ "@openmrs/esm-utils": "6.2.1-pre.2794",
57
57
  "dayjs": "^1.10.7"
58
58
  },
59
59
  "peerDependencies": {