@openmrs/esm-framework 3.4.1-pre.133 → 3.4.1-pre.149
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.
- package/.turbo/turbo-build.log +10 -10
- package/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +42 -37
- package/docs/interfaces/AssignedExtension.md +7 -7
- package/docs/interfaces/ComponentDefinition.md +5 -4
- package/docs/interfaces/ConfigObject.md +11 -0
- package/docs/interfaces/ConnectedExtension.md +4 -4
- package/docs/interfaces/DisplayConditionsConfigObject.md +19 -0
- package/docs/interfaces/ExtensionDefinition.md +11 -10
- package/docs/interfaces/ExtensionRegistration.md +11 -0
- package/docs/interfaces/ExtensionSlotBaseProps.md +16 -3
- package/docs/interfaces/ExtensionSlotConfig.md +4 -4
- package/docs/interfaces/ExtensionSlotConfigObject.md +3 -3
- package/docs/interfaces/ExtensionSlotState.md +2 -2
- package/docs/interfaces/ExtensionStore.md +1 -1
- package/docs/interfaces/OldExtensionSlotBaseProps.md +67 -0
- package/docs/interfaces/PageDefinition.md +7 -6
- package/docs/interfaces/UserHasAccessProps.md +1 -1
- package/mock.tsx +2 -1
- package/package.json +13 -13
- package/src/integration-tests/extension-config.test.tsx +180 -20
package/docs/API.md
CHANGED
|
@@ -198,7 +198,7 @@ ___
|
|
|
198
198
|
|
|
199
199
|
#### Defined in
|
|
200
200
|
|
|
201
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
201
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L17)
|
|
202
202
|
|
|
203
203
|
___
|
|
204
204
|
|
|
@@ -228,7 +228,7 @@ ___
|
|
|
228
228
|
|
|
229
229
|
#### Defined in
|
|
230
230
|
|
|
231
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
231
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L15)
|
|
232
232
|
|
|
233
233
|
___
|
|
234
234
|
|
|
@@ -245,7 +245,7 @@ ___
|
|
|
245
245
|
|
|
246
246
|
#### Defined in
|
|
247
247
|
|
|
248
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
248
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L22)
|
|
249
249
|
|
|
250
250
|
___
|
|
251
251
|
|
|
@@ -382,17 +382,17 @@ ___
|
|
|
382
382
|
|
|
383
383
|
#### Defined in
|
|
384
384
|
|
|
385
|
-
[packages/framework/esm-config/src/types.ts:
|
|
385
|
+
[packages/framework/esm-config/src/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L37)
|
|
386
386
|
|
|
387
387
|
___
|
|
388
388
|
|
|
389
389
|
### ExtensionSlotProps
|
|
390
390
|
|
|
391
|
-
Ƭ **ExtensionSlotProps**: [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement`\>
|
|
391
|
+
Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement`\>
|
|
392
392
|
|
|
393
393
|
#### Defined in
|
|
394
394
|
|
|
395
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
395
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L58)
|
|
396
396
|
|
|
397
397
|
___
|
|
398
398
|
|
|
@@ -409,7 +409,7 @@ ___
|
|
|
409
409
|
|
|
410
410
|
#### Defined in
|
|
411
411
|
|
|
412
|
-
[packages/framework/esm-config/src/types.ts:
|
|
412
|
+
[packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L65)
|
|
413
413
|
|
|
414
414
|
___
|
|
415
415
|
|
|
@@ -453,7 +453,7 @@ ___
|
|
|
453
453
|
|
|
454
454
|
#### Defined in
|
|
455
455
|
|
|
456
|
-
[packages/framework/esm-config/src/types.ts:
|
|
456
|
+
[packages/framework/esm-config/src/types.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L72)
|
|
457
457
|
|
|
458
458
|
___
|
|
459
459
|
|
|
@@ -477,7 +477,7 @@ ___
|
|
|
477
477
|
|
|
478
478
|
#### Defined in
|
|
479
479
|
|
|
480
|
-
[packages/framework/esm-config/src/types.ts:
|
|
480
|
+
[packages/framework/esm-config/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L70)
|
|
481
481
|
|
|
482
482
|
___
|
|
483
483
|
|
|
@@ -714,7 +714,7 @@ ___
|
|
|
714
714
|
|
|
715
715
|
#### Defined in
|
|
716
716
|
|
|
717
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
717
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L68)
|
|
718
718
|
|
|
719
719
|
___
|
|
720
720
|
|
|
@@ -757,7 +757,7 @@ ___
|
|
|
757
757
|
|
|
758
758
|
#### Defined in
|
|
759
759
|
|
|
760
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
760
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:188](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L188)
|
|
761
761
|
|
|
762
762
|
___
|
|
763
763
|
|
|
@@ -823,7 +823,7 @@ leak and source of bugs.
|
|
|
823
823
|
|
|
824
824
|
#### Defined in
|
|
825
825
|
|
|
826
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
826
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L71)
|
|
827
827
|
|
|
828
828
|
▸ **getCurrentUser**(`opts`): `Observable`<[`Session`](interfaces/Session.md)\>
|
|
829
829
|
|
|
@@ -840,7 +840,7 @@ leak and source of bugs.
|
|
|
840
840
|
|
|
841
841
|
#### Defined in
|
|
842
842
|
|
|
843
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
843
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L72)
|
|
844
844
|
|
|
845
845
|
▸ **getCurrentUser**(`opts`): `Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
|
|
846
846
|
|
|
@@ -857,7 +857,7 @@ leak and source of bugs.
|
|
|
857
857
|
|
|
858
858
|
#### Defined in
|
|
859
859
|
|
|
860
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
860
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L73)
|
|
861
861
|
|
|
862
862
|
___
|
|
863
863
|
|
|
@@ -885,7 +885,7 @@ ___
|
|
|
885
885
|
|
|
886
886
|
#### Defined in
|
|
887
887
|
|
|
888
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
888
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:202](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L202)
|
|
889
889
|
|
|
890
890
|
___
|
|
891
891
|
|
|
@@ -899,7 +899,7 @@ ___
|
|
|
899
899
|
|
|
900
900
|
#### Defined in
|
|
901
901
|
|
|
902
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
902
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L220)
|
|
903
903
|
|
|
904
904
|
___
|
|
905
905
|
|
|
@@ -913,7 +913,7 @@ ___
|
|
|
913
913
|
|
|
914
914
|
#### Defined in
|
|
915
915
|
|
|
916
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
916
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L105)
|
|
917
917
|
|
|
918
918
|
___
|
|
919
919
|
|
|
@@ -1122,7 +1122,7 @@ refetchCurrentUser()
|
|
|
1122
1122
|
|
|
1123
1123
|
#### Defined in
|
|
1124
1124
|
|
|
1125
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
1125
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L163)
|
|
1126
1126
|
|
|
1127
1127
|
___
|
|
1128
1128
|
|
|
@@ -1164,7 +1164,7 @@ ___
|
|
|
1164
1164
|
|
|
1165
1165
|
#### Defined in
|
|
1166
1166
|
|
|
1167
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
1167
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:229](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L229)
|
|
1168
1168
|
|
|
1169
1169
|
___
|
|
1170
1170
|
|
|
@@ -1365,24 +1365,24 @@ ___
|
|
|
1365
1365
|
|
|
1366
1366
|
### userHasAccess
|
|
1367
1367
|
|
|
1368
|
-
▸ **userHasAccess**(`requiredPrivilege`, `user`): `
|
|
1368
|
+
▸ **userHasAccess**(`requiredPrivilege`, `user`): `boolean`
|
|
1369
1369
|
|
|
1370
1370
|
#### Parameters
|
|
1371
1371
|
|
|
1372
1372
|
| Name | Type |
|
|
1373
1373
|
| :------ | :------ |
|
|
1374
|
-
| `requiredPrivilege` | `string` |
|
|
1374
|
+
| `requiredPrivilege` | `string` \| `string`[] |
|
|
1375
1375
|
| `user` | `Object` |
|
|
1376
1376
|
| `user.privileges` | [`Privilege`](interfaces/Privilege.md)[] |
|
|
1377
1377
|
| `user.roles` | [`Role`](interfaces/Role.md)[] |
|
|
1378
1378
|
|
|
1379
1379
|
#### Returns
|
|
1380
1380
|
|
|
1381
|
-
`
|
|
1381
|
+
`boolean`
|
|
1382
1382
|
|
|
1383
1383
|
#### Defined in
|
|
1384
1384
|
|
|
1385
|
-
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:
|
|
1385
|
+
[packages/framework/esm-api/src/shared-api-objects/current-user.ts:195](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L195)
|
|
1386
1386
|
|
|
1387
1387
|
___
|
|
1388
1388
|
|
|
@@ -1509,7 +1509,7 @@ for more information about defining a config schema.
|
|
|
1509
1509
|
|
|
1510
1510
|
#### Defined in
|
|
1511
1511
|
|
|
1512
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1512
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:192](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L192)
|
|
1513
1513
|
|
|
1514
1514
|
___
|
|
1515
1515
|
|
|
@@ -1541,7 +1541,7 @@ for more information about defining a config schema.
|
|
|
1541
1541
|
|
|
1542
1542
|
#### Defined in
|
|
1543
1543
|
|
|
1544
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1544
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L222)
|
|
1545
1545
|
|
|
1546
1546
|
___
|
|
1547
1547
|
|
|
@@ -1571,7 +1571,7 @@ of the execution of a function.
|
|
|
1571
1571
|
|
|
1572
1572
|
#### Defined in
|
|
1573
1573
|
|
|
1574
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1574
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:264](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L264)
|
|
1575
1575
|
|
|
1576
1576
|
___
|
|
1577
1577
|
|
|
@@ -1592,7 +1592,7 @@ ___
|
|
|
1592
1592
|
|
|
1593
1593
|
#### Defined in
|
|
1594
1594
|
|
|
1595
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1595
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L244)
|
|
1596
1596
|
|
|
1597
1597
|
___
|
|
1598
1598
|
|
|
@@ -1608,6 +1608,7 @@ Use this React Hook to obtain your module's configuration.
|
|
|
1608
1608
|
|
|
1609
1609
|
| Name | Type | Description |
|
|
1610
1610
|
| :------ | :------ | :------ |
|
|
1611
|
+
| `Display conditions?` | [`DisplayConditionsConfigObject`](interfaces/DisplayConditionsConfigObject.md) | - |
|
|
1611
1612
|
| `constructor` | `Function` | The initial value of Object.prototype.constructor is the standard built-in Object constructor. |
|
|
1612
1613
|
| `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` | Determines whether an object has a property with the specified name. |
|
|
1613
1614
|
| `isPrototypeOf` | (`v`: `Object`) => `boolean` | Determines whether an object exists in another object's prototype chain. |
|
|
@@ -2155,7 +2156,7 @@ writing a module for a specific implementation.
|
|
|
2155
2156
|
|
|
2156
2157
|
#### Defined in
|
|
2157
2158
|
|
|
2158
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2159
|
+
[packages/framework/esm-extensions/src/extensions.ts:174](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L174)
|
|
2159
2160
|
|
|
2160
2161
|
___
|
|
2161
2162
|
|
|
@@ -2178,7 +2179,7 @@ Avoid using this. Extension attachments should be considered declarative.
|
|
|
2178
2179
|
|
|
2179
2180
|
#### Defined in
|
|
2180
2181
|
|
|
2181
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2182
|
+
[packages/framework/esm-extensions/src/extensions.ts:205](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L205)
|
|
2182
2183
|
|
|
2183
2184
|
___
|
|
2184
2185
|
|
|
@@ -2200,7 +2201,7 @@ Avoid using this. Extension attachments should be considered declarative.
|
|
|
2200
2201
|
|
|
2201
2202
|
#### Defined in
|
|
2202
2203
|
|
|
2203
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2204
|
+
[packages/framework/esm-extensions/src/extensions.ts:229](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L229)
|
|
2204
2205
|
|
|
2205
2206
|
___
|
|
2206
2207
|
|
|
@@ -2208,19 +2209,23 @@ ___
|
|
|
2208
2209
|
|
|
2209
2210
|
▸ **getAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
|
|
2210
2211
|
|
|
2212
|
+
Gets the list of extensions assigned to a given slot
|
|
2213
|
+
|
|
2211
2214
|
#### Parameters
|
|
2212
2215
|
|
|
2213
|
-
| Name | Type |
|
|
2214
|
-
| :------ | :------ |
|
|
2215
|
-
| `slotName` | `string` |
|
|
2216
|
+
| Name | Type | Description |
|
|
2217
|
+
| :------ | :------ | :------ |
|
|
2218
|
+
| `slotName` | `string` | The slot to load the assigned extensions for |
|
|
2216
2219
|
|
|
2217
2220
|
#### Returns
|
|
2218
2221
|
|
|
2219
2222
|
[`AssignedExtension`](interfaces/AssignedExtension.md)[]
|
|
2220
2223
|
|
|
2224
|
+
An array of extensions assigned to the named slot
|
|
2225
|
+
|
|
2221
2226
|
#### Defined in
|
|
2222
2227
|
|
|
2223
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2228
|
+
[packages/framework/esm-extensions/src/extensions.ts:359](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L359)
|
|
2224
2229
|
|
|
2225
2230
|
___
|
|
2226
2231
|
|
|
@@ -2246,7 +2251,7 @@ A list of extensions that should be rendered
|
|
|
2246
2251
|
|
|
2247
2252
|
#### Defined in
|
|
2248
2253
|
|
|
2249
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2254
|
+
[packages/framework/esm-extensions/src/extensions.ts:287](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L287)
|
|
2250
2255
|
|
|
2251
2256
|
___
|
|
2252
2257
|
|
|
@@ -2278,7 +2283,7 @@ getExtensionNameFromId("baz")
|
|
|
2278
2283
|
|
|
2279
2284
|
#### Defined in
|
|
2280
2285
|
|
|
2281
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2286
|
+
[packages/framework/esm-extensions/src/extensions.ts:118](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L118)
|
|
2282
2287
|
|
|
2283
2288
|
___
|
|
2284
2289
|
|
|
@@ -2296,7 +2301,7 @@ extension system.
|
|
|
2296
2301
|
|
|
2297
2302
|
#### Defined in
|
|
2298
2303
|
|
|
2299
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
2304
|
+
[packages/framework/esm-extensions/src/store.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L130)
|
|
2300
2305
|
|
|
2301
2306
|
___
|
|
2302
2307
|
|
|
@@ -24,7 +24,7 @@ The extension's config. Note that this will be `null` until the slot is mounted.
|
|
|
24
24
|
|
|
25
25
|
#### Defined in
|
|
26
26
|
|
|
27
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
27
|
+
[packages/framework/esm-extensions/src/store.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L80)
|
|
28
28
|
|
|
29
29
|
___
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ ___
|
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
37
|
+
[packages/framework/esm-extensions/src/store.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L75)
|
|
38
38
|
|
|
39
39
|
___
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ ___
|
|
|
44
44
|
|
|
45
45
|
#### Defined in
|
|
46
46
|
|
|
47
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
47
|
+
[packages/framework/esm-extensions/src/store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L78)
|
|
48
48
|
|
|
49
49
|
___
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ ___
|
|
|
54
54
|
|
|
55
55
|
#### Defined in
|
|
56
56
|
|
|
57
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
57
|
+
[packages/framework/esm-extensions/src/store.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L77)
|
|
58
58
|
|
|
59
59
|
___
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ ___
|
|
|
64
64
|
|
|
65
65
|
#### Defined in
|
|
66
66
|
|
|
67
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
67
|
+
[packages/framework/esm-extensions/src/store.ts:76](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L76)
|
|
68
68
|
|
|
69
69
|
___
|
|
70
70
|
|
|
@@ -74,7 +74,7 @@ ___
|
|
|
74
74
|
|
|
75
75
|
#### Defined in
|
|
76
76
|
|
|
77
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
77
|
+
[packages/framework/esm-extensions/src/store.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L82)
|
|
78
78
|
|
|
79
79
|
___
|
|
80
80
|
|
|
@@ -84,4 +84,4 @@ ___
|
|
|
84
84
|
|
|
85
85
|
#### Defined in
|
|
86
86
|
|
|
87
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
87
|
+
[packages/framework/esm-extensions/src/store.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L81)
|
|
@@ -64,13 +64,14 @@ ___
|
|
|
64
64
|
|
|
65
65
|
### privilege
|
|
66
66
|
|
|
67
|
-
• `Optional` **privilege**: `string`
|
|
67
|
+
• `Optional` **privilege**: `string` \| `string`[]
|
|
68
68
|
|
|
69
|
-
Defines the access privilege required for this component, if any.
|
|
69
|
+
Defines the access privilege(s) required for this component, if any.
|
|
70
|
+
If more than one privilege is provided, the user must have all specified permissions.
|
|
70
71
|
|
|
71
72
|
#### Defined in
|
|
72
73
|
|
|
73
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
74
|
+
[packages/framework/esm-globals/src/types.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L116)
|
|
74
75
|
|
|
75
76
|
___
|
|
76
77
|
|
|
@@ -82,7 +83,7 @@ Defines resources that are loaded when the component should mount.
|
|
|
82
83
|
|
|
83
84
|
#### Defined in
|
|
84
85
|
|
|
85
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
86
|
+
[packages/framework/esm-globals/src/types.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L120)
|
|
86
87
|
|
|
87
88
|
## Methods
|
|
88
89
|
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
### Properties
|
|
18
18
|
|
|
19
|
+
- [Display conditions](ConfigObject.md#display conditions)
|
|
19
20
|
- [constructor](ConfigObject.md#constructor)
|
|
20
21
|
|
|
21
22
|
### Methods
|
|
@@ -29,6 +30,16 @@
|
|
|
29
30
|
|
|
30
31
|
## Properties
|
|
31
32
|
|
|
33
|
+
### Display conditions
|
|
34
|
+
|
|
35
|
+
• `Optional` **Display conditions**: [`DisplayConditionsConfigObject`](DisplayConditionsConfigObject.md)
|
|
36
|
+
|
|
37
|
+
#### Defined in
|
|
38
|
+
|
|
39
|
+
[packages/framework/esm-config/src/types.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L30)
|
|
40
|
+
|
|
41
|
+
___
|
|
42
|
+
|
|
32
43
|
### constructor
|
|
33
44
|
|
|
34
45
|
• **constructor**: `Function`
|
|
@@ -21,7 +21,7 @@ The extension's config. Note that this will be `null` until the slot is mounted.
|
|
|
21
21
|
|
|
22
22
|
#### Defined in
|
|
23
23
|
|
|
24
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
24
|
+
[packages/framework/esm-extensions/src/store.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L90)
|
|
25
25
|
|
|
26
26
|
___
|
|
27
27
|
|
|
@@ -31,7 +31,7 @@ ___
|
|
|
31
31
|
|
|
32
32
|
#### Defined in
|
|
33
33
|
|
|
34
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
34
|
+
[packages/framework/esm-extensions/src/store.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L86)
|
|
35
35
|
|
|
36
36
|
___
|
|
37
37
|
|
|
@@ -41,7 +41,7 @@ ___
|
|
|
41
41
|
|
|
42
42
|
#### Defined in
|
|
43
43
|
|
|
44
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
44
|
+
[packages/framework/esm-extensions/src/store.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L88)
|
|
45
45
|
|
|
46
46
|
___
|
|
47
47
|
|
|
@@ -51,4 +51,4 @@ ___
|
|
|
51
51
|
|
|
52
52
|
#### Defined in
|
|
53
53
|
|
|
54
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
54
|
+
[packages/framework/esm-extensions/src/store.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L87)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / DisplayConditionsConfigObject
|
|
2
|
+
|
|
3
|
+
# Interface: DisplayConditionsConfigObject
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [privileges](DisplayConditionsConfigObject.md#privileges)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### privileges
|
|
14
|
+
|
|
15
|
+
• `Optional` **privileges**: `string`[]
|
|
16
|
+
|
|
17
|
+
#### Defined in
|
|
18
|
+
|
|
19
|
+
[packages/framework/esm-config/src/types.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L34)
|
|
@@ -54,7 +54,7 @@ ___
|
|
|
54
54
|
|
|
55
55
|
#### Defined in
|
|
56
56
|
|
|
57
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
57
|
+
[packages/framework/esm-globals/src/types.ts:135](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L135)
|
|
58
58
|
|
|
59
59
|
___
|
|
60
60
|
|
|
@@ -66,7 +66,7 @@ The meta data used for reflection by other components
|
|
|
66
66
|
|
|
67
67
|
#### Defined in
|
|
68
68
|
|
|
69
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
69
|
+
[packages/framework/esm-globals/src/types.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L131)
|
|
70
70
|
|
|
71
71
|
___
|
|
72
72
|
|
|
@@ -78,7 +78,7 @@ The name of the extension being registered
|
|
|
78
78
|
|
|
79
79
|
#### Defined in
|
|
80
80
|
|
|
81
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
81
|
+
[packages/framework/esm-globals/src/types.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L125)
|
|
82
82
|
|
|
83
83
|
___
|
|
84
84
|
|
|
@@ -122,15 +122,16 @@ Specifies the relative order in which the extension renders in a slot
|
|
|
122
122
|
|
|
123
123
|
#### Defined in
|
|
124
124
|
|
|
125
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
125
|
+
[packages/framework/esm-globals/src/types.ts:133](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L133)
|
|
126
126
|
|
|
127
127
|
___
|
|
128
128
|
|
|
129
129
|
### privilege
|
|
130
130
|
|
|
131
|
-
• `Optional` **privilege**: `string`
|
|
131
|
+
• `Optional` **privilege**: `string` \| `string`[]
|
|
132
132
|
|
|
133
|
-
Defines the access privilege required for this component, if any.
|
|
133
|
+
Defines the access privilege(s) required for this component, if any.
|
|
134
|
+
If more than one privilege is provided, the user must have all specified permissions.
|
|
134
135
|
|
|
135
136
|
#### Inherited from
|
|
136
137
|
|
|
@@ -138,7 +139,7 @@ Defines the access privilege required for this component, if any.
|
|
|
138
139
|
|
|
139
140
|
#### Defined in
|
|
140
141
|
|
|
141
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
142
|
+
[packages/framework/esm-globals/src/types.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L116)
|
|
142
143
|
|
|
143
144
|
___
|
|
144
145
|
|
|
@@ -154,7 +155,7 @@ Defines resources that are loaded when the component should mount.
|
|
|
154
155
|
|
|
155
156
|
#### Defined in
|
|
156
157
|
|
|
157
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
158
|
+
[packages/framework/esm-globals/src/types.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L120)
|
|
158
159
|
|
|
159
160
|
___
|
|
160
161
|
|
|
@@ -166,7 +167,7 @@ A slot to attach to
|
|
|
166
167
|
|
|
167
168
|
#### Defined in
|
|
168
169
|
|
|
169
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
170
|
+
[packages/framework/esm-globals/src/types.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L127)
|
|
170
171
|
|
|
171
172
|
___
|
|
172
173
|
|
|
@@ -178,7 +179,7 @@ Slots to attach to
|
|
|
178
179
|
|
|
179
180
|
#### Defined in
|
|
180
181
|
|
|
181
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
182
|
+
[packages/framework/esm-globals/src/types.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L129)
|
|
182
183
|
|
|
183
184
|
## Methods
|
|
184
185
|
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
- [offline](ExtensionRegistration.md#offline)
|
|
13
13
|
- [online](ExtensionRegistration.md#online)
|
|
14
14
|
- [order](ExtensionRegistration.md#order)
|
|
15
|
+
- [privileges](ExtensionRegistration.md#privileges)
|
|
15
16
|
|
|
16
17
|
### Methods
|
|
17
18
|
|
|
@@ -77,6 +78,16 @@ ___
|
|
|
77
78
|
|
|
78
79
|
[packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L20)
|
|
79
80
|
|
|
81
|
+
___
|
|
82
|
+
|
|
83
|
+
### privileges
|
|
84
|
+
|
|
85
|
+
• `Optional` **privileges**: `string` \| `string`[]
|
|
86
|
+
|
|
87
|
+
#### Defined in
|
|
88
|
+
|
|
89
|
+
[packages/framework/esm-extensions/src/store.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L23)
|
|
90
|
+
|
|
80
91
|
## Methods
|
|
81
92
|
|
|
82
93
|
### load
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
### Properties
|
|
8
8
|
|
|
9
9
|
- [extensionSlotName](ExtensionSlotBaseProps.md#extensionslotname)
|
|
10
|
+
- [name](ExtensionSlotBaseProps.md#name)
|
|
10
11
|
- [state](ExtensionSlotBaseProps.md#state)
|
|
11
12
|
|
|
12
13
|
### Methods
|
|
@@ -17,7 +18,19 @@
|
|
|
17
18
|
|
|
18
19
|
### extensionSlotName
|
|
19
20
|
|
|
20
|
-
• **extensionSlotName**: `string`
|
|
21
|
+
• `Optional` **extensionSlotName**: `string`
|
|
22
|
+
|
|
23
|
+
**`deprecated`** Use `name`
|
|
24
|
+
|
|
25
|
+
#### Defined in
|
|
26
|
+
|
|
27
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L45)
|
|
28
|
+
|
|
29
|
+
___
|
|
30
|
+
|
|
31
|
+
### name
|
|
32
|
+
|
|
33
|
+
• **name**: `string`
|
|
21
34
|
|
|
22
35
|
#### Defined in
|
|
23
36
|
|
|
@@ -31,7 +44,7 @@ ___
|
|
|
31
44
|
|
|
32
45
|
#### Defined in
|
|
33
46
|
|
|
34
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
47
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L47)
|
|
35
48
|
|
|
36
49
|
## Methods
|
|
37
50
|
|
|
@@ -51,4 +64,4 @@ ___
|
|
|
51
64
|
|
|
52
65
|
#### Defined in
|
|
53
66
|
|
|
54
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
67
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L46)
|