@openmrs/esm-framework 3.1.15-pre.744 → 3.1.15-pre.752
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/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.LICENSE.txt +2 -0
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +147 -351
- package/docs/interfaces/AssignedExtension.md +63 -0
- package/docs/interfaces/ConnectedExtension.md +3 -106
- package/docs/interfaces/ExtensionInfo.md +8 -8
- package/docs/interfaces/ExtensionInstance.md +1 -1
- package/docs/interfaces/ExtensionInternalStore.md +34 -0
- package/docs/interfaces/ExtensionProps.md +2 -2
- package/docs/interfaces/ExtensionRegistration.md +7 -9
- package/docs/interfaces/ExtensionSlotConfigObject.md +9 -3
- package/docs/interfaces/ExtensionSlotInfo.md +23 -9
- package/docs/interfaces/ExtensionSlotState.md +30 -0
- package/docs/interfaces/ExtensionStore.md +2 -17
- package/mock.tsx +39 -17
- package/package.json +14 -13
- package/src/integration-tests/extension-config.test.tsx +4 -10
- package/docs/interfaces/ConfigStore.md +0 -34
- package/docs/interfaces/ExtensionDetails.md +0 -81
- package/docs/interfaces/ExtensionSlotConfigsStore.md +0 -32
- package/docs/interfaces/ExtensionSlotInstance.md +0 -51
- package/docs/interfaces/ImplementerToolsConfigStore.md +0 -19
package/docs/API.md
CHANGED
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
### Interfaces
|
|
18
18
|
|
|
19
19
|
- [AppState](interfaces/AppState.md)
|
|
20
|
+
- [AssignedExtension](interfaces/AssignedExtension.md)
|
|
20
21
|
- [BreadcrumbRegistration](interfaces/BreadcrumbRegistration.md)
|
|
21
22
|
- [BreadcrumbSettings](interfaces/BreadcrumbSettings.md)
|
|
22
23
|
- [CancelLoading](interfaces/CancelLoading.md)
|
|
@@ -27,7 +28,6 @@
|
|
|
27
28
|
- [Config](interfaces/Config.md)
|
|
28
29
|
- [ConfigObject](interfaces/ConfigObject.md)
|
|
29
30
|
- [ConfigSchema](interfaces/ConfigSchema.md)
|
|
30
|
-
- [ConfigStore](interfaces/ConfigStore.md)
|
|
31
31
|
- [ConfigurableLinkProps](interfaces/ConfigurableLinkProps.md)
|
|
32
32
|
- [ConnectedExtension](interfaces/ConnectedExtension.md)
|
|
33
33
|
- [ConnectivityChangedEvent](interfaces/ConnectivityChangedEvent.md)
|
|
@@ -37,26 +37,24 @@
|
|
|
37
37
|
- [CurrentUserWithoutResponseOption](interfaces/CurrentUserWithoutResponseOption.md)
|
|
38
38
|
- [ExtensionData](interfaces/ExtensionData.md)
|
|
39
39
|
- [ExtensionDefinition](interfaces/ExtensionDefinition.md)
|
|
40
|
-
- [ExtensionDetails](interfaces/ExtensionDetails.md)
|
|
41
40
|
- [ExtensionInfo](interfaces/ExtensionInfo.md)
|
|
42
41
|
- [ExtensionInstance](interfaces/ExtensionInstance.md)
|
|
42
|
+
- [ExtensionInternalStore](interfaces/ExtensionInternalStore.md)
|
|
43
43
|
- [ExtensionMeta](interfaces/ExtensionMeta.md)
|
|
44
44
|
- [ExtensionProps](interfaces/ExtensionProps.md)
|
|
45
45
|
- [ExtensionRegistration](interfaces/ExtensionRegistration.md)
|
|
46
46
|
- [ExtensionSlotBaseProps](interfaces/ExtensionSlotBaseProps.md)
|
|
47
47
|
- [ExtensionSlotConfig](interfaces/ExtensionSlotConfig.md)
|
|
48
48
|
- [ExtensionSlotConfigObject](interfaces/ExtensionSlotConfigObject.md)
|
|
49
|
-
- [ExtensionSlotConfigsStore](interfaces/ExtensionSlotConfigsStore.md)
|
|
50
49
|
- [ExtensionSlotConfigureValueObject](interfaces/ExtensionSlotConfigureValueObject.md)
|
|
51
50
|
- [ExtensionSlotInfo](interfaces/ExtensionSlotInfo.md)
|
|
52
|
-
- [
|
|
51
|
+
- [ExtensionSlotState](interfaces/ExtensionSlotState.md)
|
|
53
52
|
- [ExtensionStore](interfaces/ExtensionStore.md)
|
|
54
53
|
- [FHIRCode](interfaces/FHIRCode.md)
|
|
55
54
|
- [FHIRRequestObj](interfaces/FHIRRequestObj.md)
|
|
56
55
|
- [FHIRResource](interfaces/FHIRResource.md)
|
|
57
56
|
- [FetchHeaders](interfaces/FetchHeaders.md)
|
|
58
57
|
- [FetchResponse](interfaces/FetchResponse.md)
|
|
59
|
-
- [ImplementerToolsConfigStore](interfaces/ImplementerToolsConfigStore.md)
|
|
60
58
|
- [ImportMap](interfaces/ImportMap.md)
|
|
61
59
|
- [Lifecycle](interfaces/Lifecycle.md)
|
|
62
60
|
- [Location](interfaces/Location.md)
|
|
@@ -113,11 +111,11 @@
|
|
|
113
111
|
- [DateInput](API.md#dateinput)
|
|
114
112
|
- [ExtensionSlotProps](API.md#extensionslotprops)
|
|
115
113
|
- [FormatDateMode](API.md#formatdatemode)
|
|
114
|
+
- [FormatDateOptions](API.md#formatdateoptions)
|
|
116
115
|
- [KnownOmrsServiceWorkerEvents](API.md#knownomrsserviceworkerevents)
|
|
117
116
|
- [KnownOmrsServiceWorkerMessages](API.md#knownomrsserviceworkermessages)
|
|
118
117
|
- [LayoutType](API.md#layouttype)
|
|
119
118
|
- [LoggedInUserData](API.md#loggedinuserdata)
|
|
120
|
-
- [MaybeAsync](API.md#maybeasync)
|
|
121
119
|
- [NavigationContextType](API.md#navigationcontexttype)
|
|
122
120
|
- [OmrsOfflineCachingStrategy](API.md#omrsofflinecachingstrategy)
|
|
123
121
|
- [OmrsOfflineHttpHeaderNames](API.md#omrsofflinehttpheadernames)
|
|
@@ -148,13 +146,11 @@
|
|
|
148
146
|
- [extensionStore](API.md#extensionstore)
|
|
149
147
|
- [fhirBaseUrl](API.md#fhirbaseurl)
|
|
150
148
|
- [getStartedVisit](API.md#getstartedvisit)
|
|
151
|
-
- [implementerToolsConfigStore](API.md#implementertoolsconfigstore)
|
|
152
149
|
- [offlineUuidPrefix](API.md#offlineuuidprefix)
|
|
153
150
|
- [omrsOfflineCachingStrategyHttpHeaderName](API.md#omrsofflinecachingstrategyhttpheadername)
|
|
154
151
|
- [omrsOfflineResponseBodyHttpHeaderName](API.md#omrsofflineresponsebodyhttpheadername)
|
|
155
152
|
- [omrsOfflineResponseStatusHttpHeaderName](API.md#omrsofflineresponsestatushttpheadername)
|
|
156
153
|
- [sessionEndpoint](API.md#sessionendpoint)
|
|
157
|
-
- [temporaryConfigStore](API.md#temporaryconfigstore)
|
|
158
154
|
- [validators](API.md#validators)
|
|
159
155
|
|
|
160
156
|
### API Functions
|
|
@@ -206,18 +202,16 @@
|
|
|
206
202
|
- [formatTime](API.md#formattime)
|
|
207
203
|
- [generateOfflineUuid](API.md#generateofflineuuid)
|
|
208
204
|
- [getAppState](API.md#getappstate)
|
|
209
|
-
- [
|
|
205
|
+
- [getAssignedExtensions](API.md#getassignedextensions)
|
|
210
206
|
- [getAsyncExtensionLifecycle](API.md#getasyncextensionlifecycle)
|
|
211
207
|
- [getAsyncLifecycle](API.md#getasynclifecycle)
|
|
212
208
|
- [getConfig](API.md#getconfig)
|
|
213
|
-
- [
|
|
209
|
+
- [getConnectedExtensions](API.md#getconnectedextensions)
|
|
214
210
|
- [getCustomProps](API.md#getcustomprops)
|
|
215
|
-
- [getExtensionConfigStore](API.md#getextensionconfigstore)
|
|
216
211
|
- [getExtensionNameFromId](API.md#getextensionnamefromid)
|
|
217
212
|
- [getExtensionRegistration](API.md#getextensionregistration)
|
|
218
213
|
- [getExtensionRegistrationFrom](API.md#getextensionregistrationfrom)
|
|
219
|
-
- [
|
|
220
|
-
- [getExtensionSlotsForModule](API.md#getextensionslotsformodule)
|
|
214
|
+
- [getExtensionStore](API.md#getextensionstore)
|
|
221
215
|
- [getGlobalStore](API.md#getglobalstore)
|
|
222
216
|
- [getLifecycle](API.md#getlifecycle)
|
|
223
217
|
- [getLocations](API.md#getlocations)
|
|
@@ -229,7 +223,6 @@
|
|
|
229
223
|
- [getSyncLifecycle](API.md#getsynclifecycle)
|
|
230
224
|
- [getSynchronizationItems](API.md#getsynchronizationitems)
|
|
231
225
|
- [getSynchronizationItemsFor](API.md#getsynchronizationitemsfor)
|
|
232
|
-
- [getUpdatedExtensionSlotInfo](API.md#getupdatedextensionslotinfo)
|
|
233
226
|
- [getVisitTypes](API.md#getvisittypes)
|
|
234
227
|
- [getVisitsForPatient](API.md#getvisitsforpatient)
|
|
235
228
|
- [handleApiError](API.md#handleapierror)
|
|
@@ -252,8 +245,6 @@
|
|
|
252
245
|
- [pushNavigationContext](API.md#pushnavigationcontext)
|
|
253
246
|
- [queueSynchronizationItem](API.md#queuesynchronizationitem)
|
|
254
247
|
- [queueSynchronizationItemFor](API.md#queuesynchronizationitemfor)
|
|
255
|
-
- [registerExtension](API.md#registerextension)
|
|
256
|
-
- [registerExtensionSlot](API.md#registerextensionslot)
|
|
257
248
|
- [registerOfflinePatientHandler](API.md#registerofflinepatienthandler)
|
|
258
249
|
- [registerOmrsServiceWorker](API.md#registeromrsserviceworker)
|
|
259
250
|
- [renderExtension](API.md#renderextension)
|
|
@@ -291,20 +282,15 @@
|
|
|
291
282
|
- [toOmrsYearlessDateFormat](API.md#toomrsyearlessdateformat)
|
|
292
283
|
- [toVisitTypeObject](API.md#tovisittypeobject)
|
|
293
284
|
- [translateFrom](API.md#translatefrom)
|
|
294
|
-
- [unregisterExtensionSlot](API.md#unregisterextensionslot)
|
|
295
285
|
- [update](API.md#update)
|
|
296
|
-
- [updateExtensionStore](API.md#updateextensionstore)
|
|
297
286
|
- [updateVisit](API.md#updatevisit)
|
|
298
287
|
- [useAssignedExtensionIds](API.md#useassignedextensionids)
|
|
299
|
-
- [
|
|
288
|
+
- [useAssignedExtensions](API.md#useassignedextensions)
|
|
300
289
|
- [useBodyScrollLock](API.md#usebodyscrolllock)
|
|
301
290
|
- [useConfig](API.md#useconfig)
|
|
302
291
|
- [useConnectedExtensions](API.md#useconnectedextensions)
|
|
303
292
|
- [useConnectivity](API.md#useconnectivity)
|
|
304
293
|
- [useCurrentPatient](API.md#usecurrentpatient)
|
|
305
|
-
- [useExtension](API.md#useextension)
|
|
306
|
-
- [useExtensionSlot](API.md#useextensionslot)
|
|
307
|
-
- [useExtensionSlotConfig](API.md#useextensionslotconfig)
|
|
308
294
|
- [useExtensionSlotMeta](API.md#useextensionslotmeta)
|
|
309
295
|
- [useExtensionStore](API.md#useextensionstore)
|
|
310
296
|
- [useForceUpdate](API.md#useforceupdate)
|
|
@@ -402,6 +388,22 @@ ___
|
|
|
402
388
|
|
|
403
389
|
___
|
|
404
390
|
|
|
391
|
+
### FormatDateOptions
|
|
392
|
+
|
|
393
|
+
Ƭ **FormatDateOptions**: `Object`
|
|
394
|
+
|
|
395
|
+
#### Type declaration
|
|
396
|
+
|
|
397
|
+
| Name | Type | Description |
|
|
398
|
+
| :------ | :------ | :------ |
|
|
399
|
+
| `time` | `boolean` \| ``"for today"`` | Whether the time should be included in the output always (`true`), never (`false`), or only when the input date is today (`for today`). |
|
|
400
|
+
|
|
401
|
+
#### Defined in
|
|
402
|
+
|
|
403
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:156](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L156)
|
|
404
|
+
|
|
405
|
+
___
|
|
406
|
+
|
|
405
407
|
### KnownOmrsServiceWorkerEvents
|
|
406
408
|
|
|
407
409
|
Ƭ **KnownOmrsServiceWorkerEvents**: [`NetworkRequestFailedEvent`](interfaces/NetworkRequestFailedEvent.md)
|
|
@@ -442,22 +444,6 @@ ___
|
|
|
442
444
|
|
|
443
445
|
___
|
|
444
446
|
|
|
445
|
-
### MaybeAsync
|
|
446
|
-
|
|
447
|
-
Ƭ **MaybeAsync**<`T`\>: `T` \| `Promise`<`T`\>
|
|
448
|
-
|
|
449
|
-
#### Type parameters
|
|
450
|
-
|
|
451
|
-
| Name |
|
|
452
|
-
| :------ |
|
|
453
|
-
| `T` |
|
|
454
|
-
|
|
455
|
-
#### Defined in
|
|
456
|
-
|
|
457
|
-
[packages/framework/esm-extensions/src/store.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L83)
|
|
458
|
-
|
|
459
|
-
___
|
|
460
|
-
|
|
461
447
|
### NavigationContextType
|
|
462
448
|
|
|
463
449
|
Ƭ **NavigationContextType**: ``"workspace"`` \| ``"dialog"`` \| ``"link"``
|
|
@@ -568,7 +554,7 @@ ___
|
|
|
568
554
|
|
|
569
555
|
#### Defined in
|
|
570
556
|
|
|
571
|
-
[packages/framework/esm-config/src/types.ts:
|
|
557
|
+
[packages/framework/esm-config/src/types.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L58)
|
|
572
558
|
|
|
573
559
|
___
|
|
574
560
|
|
|
@@ -612,7 +598,7 @@ ___
|
|
|
612
598
|
|
|
613
599
|
#### Defined in
|
|
614
600
|
|
|
615
|
-
[packages/framework/esm-config/src/types.ts:
|
|
601
|
+
[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)
|
|
616
602
|
|
|
617
603
|
___
|
|
618
604
|
|
|
@@ -636,7 +622,7 @@ ___
|
|
|
636
622
|
|
|
637
623
|
#### Defined in
|
|
638
624
|
|
|
639
|
-
[packages/framework/esm-config/src/types.ts:
|
|
625
|
+
[packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L63)
|
|
640
626
|
|
|
641
627
|
## API Variables
|
|
642
628
|
|
|
@@ -703,7 +689,7 @@ and *must* only be used once within that `<ExtensionSlot>`.
|
|
|
703
689
|
|
|
704
690
|
#### Defined in
|
|
705
691
|
|
|
706
|
-
[packages/framework/esm-react-utils/src/Extension.tsx:
|
|
692
|
+
[packages/framework/esm-react-utils/src/Extension.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L23)
|
|
707
693
|
|
|
708
694
|
___
|
|
709
695
|
|
|
@@ -746,11 +732,13 @@ ___
|
|
|
746
732
|
|
|
747
733
|
### extensionStore
|
|
748
734
|
|
|
749
|
-
• `Const` **extensionStore**: `Store`<[`
|
|
735
|
+
• `Const` **extensionStore**: `Store`<[`ExtensionInternalStore`](interfaces/ExtensionInternalStore.md)\>
|
|
736
|
+
|
|
737
|
+
**`deprecated`** Use `getExtensionStore`. The structure of this store has also changed.
|
|
750
738
|
|
|
751
739
|
#### Defined in
|
|
752
740
|
|
|
753
|
-
[packages/framework/esm-extensions/src/
|
|
741
|
+
[packages/framework/esm-extensions/src/index.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/index.ts#L12)
|
|
754
742
|
|
|
755
743
|
___
|
|
756
744
|
|
|
@@ -774,16 +762,6 @@ ___
|
|
|
774
762
|
|
|
775
763
|
___
|
|
776
764
|
|
|
777
|
-
### implementerToolsConfigStore
|
|
778
|
-
|
|
779
|
-
• `Const` **implementerToolsConfigStore**: `Store`<[`ImplementerToolsConfigStore`](interfaces/ImplementerToolsConfigStore.md)\>
|
|
780
|
-
|
|
781
|
-
#### Defined in
|
|
782
|
-
|
|
783
|
-
[packages/framework/esm-config/src/module-config/state.ts:182](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L182)
|
|
784
|
-
|
|
785
|
-
___
|
|
786
|
-
|
|
787
765
|
### offlineUuidPrefix
|
|
788
766
|
|
|
789
767
|
• `Const` **offlineUuidPrefix**: ``"OFFLINE+"``
|
|
@@ -834,16 +812,6 @@ ___
|
|
|
834
812
|
|
|
835
813
|
___
|
|
836
814
|
|
|
837
|
-
### temporaryConfigStore
|
|
838
|
-
|
|
839
|
-
• `Const` **temporaryConfigStore**: `Store`<`TemporaryConfigStore`\>
|
|
840
|
-
|
|
841
|
-
#### Defined in
|
|
842
|
-
|
|
843
|
-
[packages/framework/esm-config/src/module-config/state.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L69)
|
|
844
|
-
|
|
845
|
-
___
|
|
846
|
-
|
|
847
815
|
### validators
|
|
848
816
|
|
|
849
817
|
• `Const` **validators**: `Object`
|
|
@@ -1343,14 +1311,27 @@ ___
|
|
|
1343
1311
|
|
|
1344
1312
|
### attach
|
|
1345
1313
|
|
|
1346
|
-
▸ **attach**(`
|
|
1314
|
+
▸ **attach**(`slotName`, `extensionId`): `void`
|
|
1315
|
+
|
|
1316
|
+
Attach an extension to an extension slot.
|
|
1317
|
+
|
|
1318
|
+
This will cause the extension to be rendered into the specified
|
|
1319
|
+
extension slot, unless it is removed by configuration. Using
|
|
1320
|
+
`attach` is an alternative to specifying the `slot` or `slots`
|
|
1321
|
+
in the extension declaration.
|
|
1322
|
+
|
|
1323
|
+
It is particularly useful when creating a slot into which
|
|
1324
|
+
you want to render an existing extension. This enables you
|
|
1325
|
+
to do so without modifying the extension's declaration, which
|
|
1326
|
+
may be impractical or inappropriate, for example if you are
|
|
1327
|
+
writing a module for a specific implementation.
|
|
1347
1328
|
|
|
1348
1329
|
#### Parameters
|
|
1349
1330
|
|
|
1350
|
-
| Name | Type |
|
|
1351
|
-
| :------ | :------ |
|
|
1352
|
-
| `
|
|
1353
|
-
| `extensionId` | `string` |
|
|
1331
|
+
| Name | Type | Description |
|
|
1332
|
+
| :------ | :------ | :------ |
|
|
1333
|
+
| `slotName` | `string` | a name uniquely identifying the slot |
|
|
1334
|
+
| `extensionId` | `string` | an extension name, with an optional #-suffix to distinguish it from other instances of the same extension attached to the same slot. |
|
|
1354
1335
|
|
|
1355
1336
|
#### Returns
|
|
1356
1337
|
|
|
@@ -1358,7 +1339,7 @@ ___
|
|
|
1358
1339
|
|
|
1359
1340
|
#### Defined in
|
|
1360
1341
|
|
|
1361
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1342
|
+
[packages/framework/esm-extensions/src/extensions.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L126)
|
|
1362
1343
|
|
|
1363
1344
|
___
|
|
1364
1345
|
|
|
@@ -1559,7 +1540,7 @@ ___
|
|
|
1559
1540
|
|
|
1560
1541
|
#### Defined in
|
|
1561
1542
|
|
|
1562
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1543
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:170](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L170)
|
|
1563
1544
|
|
|
1564
1545
|
___
|
|
1565
1546
|
|
|
@@ -1587,6 +1568,8 @@ ___
|
|
|
1587
1568
|
|
|
1588
1569
|
▸ **detach**(`extensionSlotName`, `extensionId`): `void`
|
|
1589
1570
|
|
|
1571
|
+
Avoid using this. Extension attachments should be considered declarative.
|
|
1572
|
+
|
|
1590
1573
|
#### Parameters
|
|
1591
1574
|
|
|
1592
1575
|
| Name | Type |
|
|
@@ -1600,7 +1583,7 @@ ___
|
|
|
1600
1583
|
|
|
1601
1584
|
#### Defined in
|
|
1602
1585
|
|
|
1603
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1586
|
+
[packages/framework/esm-extensions/src/extensions.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L157)
|
|
1604
1587
|
|
|
1605
1588
|
___
|
|
1606
1589
|
|
|
@@ -1608,6 +1591,8 @@ ___
|
|
|
1608
1591
|
|
|
1609
1592
|
▸ **detachAll**(`extensionSlotName`): `void`
|
|
1610
1593
|
|
|
1594
|
+
Avoid using this. Extension attachments should be considered declarative.
|
|
1595
|
+
|
|
1611
1596
|
#### Parameters
|
|
1612
1597
|
|
|
1613
1598
|
| Name | Type |
|
|
@@ -1620,7 +1605,7 @@ ___
|
|
|
1620
1605
|
|
|
1621
1606
|
#### Defined in
|
|
1622
1607
|
|
|
1623
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1608
|
+
[packages/framework/esm-extensions/src/extensions.ts:181](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L181)
|
|
1624
1609
|
|
|
1625
1610
|
___
|
|
1626
1611
|
|
|
@@ -1706,15 +1691,23 @@ ___
|
|
|
1706
1691
|
|
|
1707
1692
|
### formatDate
|
|
1708
1693
|
|
|
1709
|
-
▸ **formatDate**(`date`, `mode?`): `string`
|
|
1694
|
+
▸ **formatDate**(`date`, `mode?`, `options?`): `string`
|
|
1710
1695
|
|
|
1711
1696
|
Formats the input date according to the current locale and the
|
|
1712
1697
|
given format mode.
|
|
1713
1698
|
|
|
1714
|
-
`standard`: "13 Dec 2021"
|
|
1715
|
-
`no year`: "13 Dec"
|
|
1716
|
-
`no day`: "Dec 2021"
|
|
1717
|
-
`wide`: "13 — Dec — 2021"
|
|
1699
|
+
- `standard`: "13 Dec 2021"
|
|
1700
|
+
- `no year`: "13 Dec"
|
|
1701
|
+
- `no day`: "Dec 2021"
|
|
1702
|
+
- `wide`: "13 — Dec — 2021"
|
|
1703
|
+
|
|
1704
|
+
Regardless of the mode, if the date is today, then "Today" is produced
|
|
1705
|
+
(in the locale language).
|
|
1706
|
+
|
|
1707
|
+
Can be used to format a date with time, also, by providing `options`.
|
|
1708
|
+
By default, the time is included only when the input date is today.
|
|
1709
|
+
The time is appended with a comma and a space. This agrees with the
|
|
1710
|
+
output of `Date.prototype.toLocaleString` for *most* locales.
|
|
1718
1711
|
|
|
1719
1712
|
#### Parameters
|
|
1720
1713
|
|
|
@@ -1722,6 +1715,7 @@ given format mode.
|
|
|
1722
1715
|
| :------ | :------ | :------ |
|
|
1723
1716
|
| `date` | `Date` | `undefined` |
|
|
1724
1717
|
| `mode` | [`FormatDateMode`](API.md#formatdatemode) | `"standard"` |
|
|
1718
|
+
| `options` | [`FormatDateOptions`](API.md#formatdateoptions) | `undefined` |
|
|
1725
1719
|
|
|
1726
1720
|
#### Returns
|
|
1727
1721
|
|
|
@@ -1729,7 +1723,7 @@ given format mode.
|
|
|
1729
1723
|
|
|
1730
1724
|
#### Defined in
|
|
1731
1725
|
|
|
1732
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:
|
|
1726
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L184)
|
|
1733
1727
|
|
|
1734
1728
|
___
|
|
1735
1729
|
|
|
@@ -1758,7 +1752,7 @@ output of `Date.prototype.toLocaleString` for *most* locales.
|
|
|
1758
1752
|
|
|
1759
1753
|
#### Defined in
|
|
1760
1754
|
|
|
1761
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:
|
|
1755
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L254)
|
|
1762
1756
|
|
|
1763
1757
|
___
|
|
1764
1758
|
|
|
@@ -1781,7 +1775,7 @@ Formats the input as a time, according to the current locale.
|
|
|
1781
1775
|
|
|
1782
1776
|
#### Defined in
|
|
1783
1777
|
|
|
1784
|
-
[packages/framework/esm-utils/src/omrs-dates.ts:
|
|
1778
|
+
[packages/framework/esm-utils/src/omrs-dates.ts:238](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L238)
|
|
1785
1779
|
|
|
1786
1780
|
___
|
|
1787
1781
|
|
|
@@ -1817,25 +1811,23 @@ The [store](https://github.com/developit/unistore#store) named `app`.
|
|
|
1817
1811
|
|
|
1818
1812
|
___
|
|
1819
1813
|
|
|
1820
|
-
###
|
|
1814
|
+
### getAssignedExtensions
|
|
1821
1815
|
|
|
1822
|
-
▸ **
|
|
1816
|
+
▸ **getAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
|
|
1823
1817
|
|
|
1824
1818
|
#### Parameters
|
|
1825
1819
|
|
|
1826
1820
|
| Name | Type |
|
|
1827
1821
|
| :------ | :------ |
|
|
1828
1822
|
| `slotName` | `string` |
|
|
1829
|
-
| `config` | [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md) |
|
|
1830
|
-
| `attachedIds` | `string`[] |
|
|
1831
1823
|
|
|
1832
1824
|
#### Returns
|
|
1833
1825
|
|
|
1834
|
-
`
|
|
1826
|
+
[`AssignedExtension`](interfaces/AssignedExtension.md)[]
|
|
1835
1827
|
|
|
1836
1828
|
#### Defined in
|
|
1837
1829
|
|
|
1838
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1830
|
+
[packages/framework/esm-extensions/src/extensions.ts:249](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L249)
|
|
1839
1831
|
|
|
1840
1832
|
___
|
|
1841
1833
|
|
|
@@ -1933,27 +1925,33 @@ of the execution of a function.
|
|
|
1933
1925
|
|
|
1934
1926
|
#### Defined in
|
|
1935
1927
|
|
|
1936
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
1928
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:198](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L198)
|
|
1937
1929
|
|
|
1938
1930
|
___
|
|
1939
1931
|
|
|
1940
|
-
###
|
|
1932
|
+
### getConnectedExtensions
|
|
1933
|
+
|
|
1934
|
+
▸ **getConnectedExtensions**(`assignedExtensions`, `online?`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
|
|
1941
1935
|
|
|
1942
|
-
|
|
1936
|
+
Filters a list of extensions according to whether they support the
|
|
1937
|
+
current connectivity status.
|
|
1943
1938
|
|
|
1944
1939
|
#### Parameters
|
|
1945
1940
|
|
|
1946
|
-
| Name | Type |
|
|
1947
|
-
| :------ | :------ |
|
|
1948
|
-
| `
|
|
1941
|
+
| Name | Type | Default value | Description |
|
|
1942
|
+
| :------ | :------ | :------ | :------ |
|
|
1943
|
+
| `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` | The list of extensions to filter. |
|
|
1944
|
+
| `online` | `boolean` \| ``null`` | `null` | Whether the app is currently online. If `null`, uses `navigator.onLine`. |
|
|
1949
1945
|
|
|
1950
1946
|
#### Returns
|
|
1951
1947
|
|
|
1952
|
-
|
|
1948
|
+
[`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
|
|
1949
|
+
|
|
1950
|
+
A list of extensions that should be rendered
|
|
1953
1951
|
|
|
1954
1952
|
#### Defined in
|
|
1955
1953
|
|
|
1956
|
-
[packages/framework/esm-
|
|
1954
|
+
[packages/framework/esm-extensions/src/extensions.ts:239](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L239)
|
|
1957
1955
|
|
|
1958
1956
|
___
|
|
1959
1957
|
|
|
@@ -1978,32 +1976,22 @@ ___
|
|
|
1978
1976
|
|
|
1979
1977
|
___
|
|
1980
1978
|
|
|
1981
|
-
### getExtensionConfigStore
|
|
1982
|
-
|
|
1983
|
-
▸ **getExtensionConfigStore**(`extensionSlotModuleName`, `attachedExtensionSlotName`, `extensionId`): `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
|
|
1984
|
-
|
|
1985
|
-
#### Parameters
|
|
1986
|
-
|
|
1987
|
-
| Name | Type |
|
|
1988
|
-
| :------ | :------ |
|
|
1989
|
-
| `extensionSlotModuleName` | `string` |
|
|
1990
|
-
| `attachedExtensionSlotName` | `string` |
|
|
1991
|
-
| `extensionId` | `string` |
|
|
1992
|
-
|
|
1993
|
-
#### Returns
|
|
1994
|
-
|
|
1995
|
-
`Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
|
|
1996
|
-
|
|
1997
|
-
#### Defined in
|
|
1998
|
-
|
|
1999
|
-
[packages/framework/esm-config/src/module-config/state.ts:166](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L166)
|
|
2000
|
-
|
|
2001
|
-
___
|
|
2002
|
-
|
|
2003
1979
|
### getExtensionNameFromId
|
|
2004
1980
|
|
|
2005
1981
|
▸ **getExtensionNameFromId**(`extensionId`): `string`
|
|
2006
1982
|
|
|
1983
|
+
Given an extension ID, which is a string uniquely identifying
|
|
1984
|
+
an instance of an extension within an extension slot, this
|
|
1985
|
+
returns the extension name.
|
|
1986
|
+
|
|
1987
|
+
**`example`**
|
|
1988
|
+
```js
|
|
1989
|
+
getExtensionNameFromId("foo#bar")
|
|
1990
|
+
--> "foo"
|
|
1991
|
+
getExtensionNameFromId("baz")
|
|
1992
|
+
--> "baz"
|
|
1993
|
+
```
|
|
1994
|
+
|
|
2007
1995
|
#### Parameters
|
|
2008
1996
|
|
|
2009
1997
|
| Name | Type |
|
|
@@ -2016,7 +2004,7 @@ ___
|
|
|
2016
2004
|
|
|
2017
2005
|
#### Defined in
|
|
2018
2006
|
|
|
2019
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2007
|
+
[packages/framework/esm-extensions/src/extensions.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L70)
|
|
2020
2008
|
|
|
2021
2009
|
___
|
|
2022
2010
|
|
|
@@ -2036,7 +2024,7 @@ ___
|
|
|
2036
2024
|
|
|
2037
2025
|
#### Defined in
|
|
2038
2026
|
|
|
2039
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2027
|
+
[packages/framework/esm-extensions/src/extensions.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L83)
|
|
2040
2028
|
|
|
2041
2029
|
___
|
|
2042
2030
|
|
|
@@ -2048,7 +2036,7 @@ ___
|
|
|
2048
2036
|
|
|
2049
2037
|
| Name | Type |
|
|
2050
2038
|
| :------ | :------ |
|
|
2051
|
-
| `state` | [`
|
|
2039
|
+
| `state` | [`ExtensionInternalStore`](interfaces/ExtensionInternalStore.md) |
|
|
2052
2040
|
| `extensionId` | `string` |
|
|
2053
2041
|
|
|
2054
2042
|
#### Returns
|
|
@@ -2057,47 +2045,25 @@ ___
|
|
|
2057
2045
|
|
|
2058
2046
|
#### Defined in
|
|
2059
2047
|
|
|
2060
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2061
|
-
|
|
2062
|
-
___
|
|
2063
|
-
|
|
2064
|
-
### getExtensionSlotsConfigStore
|
|
2065
|
-
|
|
2066
|
-
▸ **getExtensionSlotsConfigStore**(`moduleName`): `Store`<[`ExtensionSlotConfigsStore`](interfaces/ExtensionSlotConfigsStore.md)\>
|
|
2067
|
-
|
|
2068
|
-
#### Parameters
|
|
2069
|
-
|
|
2070
|
-
| Name | Type |
|
|
2071
|
-
| :------ | :------ |
|
|
2072
|
-
| `moduleName` | `string` |
|
|
2073
|
-
|
|
2074
|
-
#### Returns
|
|
2075
|
-
|
|
2076
|
-
`Store`<[`ExtensionSlotConfigsStore`](interfaces/ExtensionSlotConfigsStore.md)\>
|
|
2077
|
-
|
|
2078
|
-
#### Defined in
|
|
2079
|
-
|
|
2080
|
-
[packages/framework/esm-config/src/module-config/state.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L157)
|
|
2048
|
+
[packages/framework/esm-extensions/src/extensions.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L75)
|
|
2081
2049
|
|
|
2082
2050
|
___
|
|
2083
2051
|
|
|
2084
|
-
###
|
|
2052
|
+
### getExtensionStore
|
|
2085
2053
|
|
|
2086
|
-
▸ **
|
|
2054
|
+
▸ `Const` **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
|
|
2087
2055
|
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
| :------ | :------ |
|
|
2092
|
-
| `moduleName` | `string` |
|
|
2056
|
+
This returns a [store](https://github.com/developit/unistore#store)
|
|
2057
|
+
that modules can use to get information about the state of the
|
|
2058
|
+
extension system.
|
|
2093
2059
|
|
|
2094
2060
|
#### Returns
|
|
2095
2061
|
|
|
2096
|
-
`
|
|
2062
|
+
`Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
|
|
2097
2063
|
|
|
2098
2064
|
#### Defined in
|
|
2099
2065
|
|
|
2100
|
-
[packages/framework/esm-extensions/src/
|
|
2066
|
+
[packages/framework/esm-extensions/src/store.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L128)
|
|
2101
2067
|
|
|
2102
2068
|
___
|
|
2103
2069
|
|
|
@@ -2338,33 +2304,6 @@ ___
|
|
|
2338
2304
|
|
|
2339
2305
|
___
|
|
2340
2306
|
|
|
2341
|
-
### getUpdatedExtensionSlotInfo
|
|
2342
|
-
|
|
2343
|
-
▸ **getUpdatedExtensionSlotInfo**(`slotName`, `moduleName`, `extensionSlot`): [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
|
|
2344
|
-
|
|
2345
|
-
Returns information describing all extensions which can be rendered into an extension slot with
|
|
2346
|
-
the specified name.
|
|
2347
|
-
The returned information describe the extension itself, as well as the extension slot name(s)
|
|
2348
|
-
with which it has been attached.
|
|
2349
|
-
|
|
2350
|
-
#### Parameters
|
|
2351
|
-
|
|
2352
|
-
| Name | Type | Description |
|
|
2353
|
-
| :------ | :------ | :------ |
|
|
2354
|
-
| `slotName` | `string` | The extension slot name for which matching extension info should be returned. |
|
|
2355
|
-
| `moduleName` | `string` | The module name. Used for applying extension-specific config values to the result. |
|
|
2356
|
-
| `extensionSlot` | [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md) | The extension slot information object. |
|
|
2357
|
-
|
|
2358
|
-
#### Returns
|
|
2359
|
-
|
|
2360
|
-
[`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
|
|
2361
|
-
|
|
2362
|
-
#### Defined in
|
|
2363
|
-
|
|
2364
|
-
[packages/framework/esm-extensions/src/extensions.ts:330](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L330)
|
|
2365
|
-
|
|
2366
|
-
___
|
|
2367
|
-
|
|
2368
2307
|
### getVisitTypes
|
|
2369
2308
|
|
|
2370
2309
|
▸ **getVisitTypes**(): `Observable`<[`VisitType`](interfaces/VisitType.md)[]\>
|
|
@@ -2744,7 +2683,7 @@ Validate and interpolate defaults for `providedConfig` according to `schema`
|
|
|
2744
2683
|
|
|
2745
2684
|
#### Defined in
|
|
2746
2685
|
|
|
2747
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
2686
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L220)
|
|
2748
2687
|
|
|
2749
2688
|
___
|
|
2750
2689
|
|
|
@@ -2765,7 +2704,7 @@ ___
|
|
|
2765
2704
|
|
|
2766
2705
|
#### Defined in
|
|
2767
2706
|
|
|
2768
|
-
[packages/framework/esm-config/src/module-config/module-config.ts:
|
|
2707
|
+
[packages/framework/esm-config/src/module-config/module-config.ts:178](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L178)
|
|
2769
2708
|
|
|
2770
2709
|
___
|
|
2771
2710
|
|
|
@@ -2854,48 +2793,6 @@ ___
|
|
|
2854
2793
|
|
|
2855
2794
|
___
|
|
2856
2795
|
|
|
2857
|
-
### registerExtension
|
|
2858
|
-
|
|
2859
|
-
▸ `Const` **registerExtension**(`name`, `details`): `void`
|
|
2860
|
-
|
|
2861
|
-
#### Parameters
|
|
2862
|
-
|
|
2863
|
-
| Name | Type |
|
|
2864
|
-
| :------ | :------ |
|
|
2865
|
-
| `name` | `string` |
|
|
2866
|
-
| `details` | [`ExtensionDetails`](interfaces/ExtensionDetails.md) |
|
|
2867
|
-
|
|
2868
|
-
#### Returns
|
|
2869
|
-
|
|
2870
|
-
`void`
|
|
2871
|
-
|
|
2872
|
-
#### Defined in
|
|
2873
|
-
|
|
2874
|
-
[packages/framework/esm-extensions/src/extensions.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L62)
|
|
2875
|
-
|
|
2876
|
-
___
|
|
2877
|
-
|
|
2878
|
-
### registerExtensionSlot
|
|
2879
|
-
|
|
2880
|
-
▸ **registerExtensionSlot**(`moduleName`, `slotName`): `void`
|
|
2881
|
-
|
|
2882
|
-
#### Parameters
|
|
2883
|
-
|
|
2884
|
-
| Name | Type | Description |
|
|
2885
|
-
| :------ | :------ | :------ |
|
|
2886
|
-
| `moduleName` | `string` | The name of the module that contains the extension slot |
|
|
2887
|
-
| `slotName` | `string` | The extension slot name that is actually used |
|
|
2888
|
-
|
|
2889
|
-
#### Returns
|
|
2890
|
-
|
|
2891
|
-
`void`
|
|
2892
|
-
|
|
2893
|
-
#### Defined in
|
|
2894
|
-
|
|
2895
|
-
[packages/framework/esm-extensions/src/extensions.ts:256](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L256)
|
|
2896
|
-
|
|
2897
|
-
___
|
|
2898
|
-
|
|
2899
2796
|
### registerOfflinePatientHandler
|
|
2900
2797
|
|
|
2901
2798
|
▸ **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
|
|
@@ -3783,27 +3680,6 @@ ___
|
|
|
3783
3680
|
|
|
3784
3681
|
___
|
|
3785
3682
|
|
|
3786
|
-
### unregisterExtensionSlot
|
|
3787
|
-
|
|
3788
|
-
▸ **unregisterExtensionSlot**(`moduleName`, `slotName`): `void`
|
|
3789
|
-
|
|
3790
|
-
#### Parameters
|
|
3791
|
-
|
|
3792
|
-
| Name | Type |
|
|
3793
|
-
| :------ | :------ |
|
|
3794
|
-
| `moduleName` | `string` |
|
|
3795
|
-
| `slotName` | `string` |
|
|
3796
|
-
|
|
3797
|
-
#### Returns
|
|
3798
|
-
|
|
3799
|
-
`void`
|
|
3800
|
-
|
|
3801
|
-
#### Defined in
|
|
3802
|
-
|
|
3803
|
-
[packages/framework/esm-extensions/src/extensions.ts:279](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L279)
|
|
3804
|
-
|
|
3805
|
-
___
|
|
3806
|
-
|
|
3807
3683
|
### update
|
|
3808
3684
|
|
|
3809
3685
|
▸ **update**<`T`\>(`obj`, `__namedParameters`, `value`): `T`
|
|
@@ -3832,26 +3708,6 @@ ___
|
|
|
3832
3708
|
|
|
3833
3709
|
___
|
|
3834
3710
|
|
|
3835
|
-
### updateExtensionStore
|
|
3836
|
-
|
|
3837
|
-
▸ **updateExtensionStore**(`updater`): `void`
|
|
3838
|
-
|
|
3839
|
-
#### Parameters
|
|
3840
|
-
|
|
3841
|
-
| Name | Type |
|
|
3842
|
-
| :------ | :------ |
|
|
3843
|
-
| `updater` | (`state`: [`ExtensionStore`](interfaces/ExtensionStore.md)) => [`MaybeAsync`](API.md#maybeasync)<[`ExtensionStore`](interfaces/ExtensionStore.md)\> |
|
|
3844
|
-
|
|
3845
|
-
#### Returns
|
|
3846
|
-
|
|
3847
|
-
`void`
|
|
3848
|
-
|
|
3849
|
-
#### Defined in
|
|
3850
|
-
|
|
3851
|
-
[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)
|
|
3852
|
-
|
|
3853
|
-
___
|
|
3854
|
-
|
|
3855
3711
|
### updateVisit
|
|
3856
3712
|
|
|
3857
3713
|
▸ **updateVisit**(`uuid`, `payload`, `abortController`): `Observable`<`any`\>
|
|
@@ -3876,16 +3732,18 @@ ___
|
|
|
3876
3732
|
|
|
3877
3733
|
### useAssignedExtensionIds
|
|
3878
3734
|
|
|
3879
|
-
▸ **useAssignedExtensionIds**(`
|
|
3735
|
+
▸ **useAssignedExtensionIds**(`slotName`): `string`[]
|
|
3880
3736
|
|
|
3881
3737
|
Gets the assigned extension ids for a given extension slot name.
|
|
3882
3738
|
Does not consider if offline or online.
|
|
3883
3739
|
|
|
3740
|
+
**`deprecated`** Use `useAssignedExtensions`
|
|
3741
|
+
|
|
3884
3742
|
#### Parameters
|
|
3885
3743
|
|
|
3886
3744
|
| Name | Type | Description |
|
|
3887
3745
|
| :------ | :------ | :------ |
|
|
3888
|
-
| `
|
|
3746
|
+
| `slotName` | `string` | The name of the slot to get the assigned IDs for. |
|
|
3889
3747
|
|
|
3890
3748
|
#### Returns
|
|
3891
3749
|
|
|
@@ -3893,29 +3751,30 @@ Does not consider if offline or online.
|
|
|
3893
3751
|
|
|
3894
3752
|
#### Defined in
|
|
3895
3753
|
|
|
3896
|
-
[packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:
|
|
3754
|
+
[packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L12)
|
|
3897
3755
|
|
|
3898
3756
|
___
|
|
3899
3757
|
|
|
3900
|
-
###
|
|
3758
|
+
### useAssignedExtensions
|
|
3901
3759
|
|
|
3902
|
-
▸ **
|
|
3760
|
+
▸ **useAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
|
|
3903
3761
|
|
|
3904
|
-
Gets the assigned
|
|
3762
|
+
Gets the assigned extensions for a given extension slot name.
|
|
3763
|
+
Does not consider if offline or online.
|
|
3905
3764
|
|
|
3906
3765
|
#### Parameters
|
|
3907
3766
|
|
|
3908
|
-
| Name | Type |
|
|
3909
|
-
| :------ | :------ |
|
|
3910
|
-
| `
|
|
3767
|
+
| Name | Type | Description |
|
|
3768
|
+
| :------ | :------ | :------ |
|
|
3769
|
+
| `slotName` | `string` | The name of the slot to get the assigned extensions for. |
|
|
3911
3770
|
|
|
3912
3771
|
#### Returns
|
|
3913
3772
|
|
|
3914
|
-
`
|
|
3773
|
+
[`AssignedExtension`](interfaces/AssignedExtension.md)[]
|
|
3915
3774
|
|
|
3916
3775
|
#### Defined in
|
|
3917
3776
|
|
|
3918
|
-
[packages/framework/esm-react-utils/src/
|
|
3777
|
+
[packages/framework/esm-react-utils/src/useAssignedExtensions.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L10)
|
|
3919
3778
|
|
|
3920
3779
|
___
|
|
3921
3780
|
|
|
@@ -3967,7 +3826,7 @@ ___
|
|
|
3967
3826
|
|
|
3968
3827
|
### useConnectedExtensions
|
|
3969
3828
|
|
|
3970
|
-
▸ **useConnectedExtensions**(`
|
|
3829
|
+
▸ **useConnectedExtensions**(`slotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
|
|
3971
3830
|
|
|
3972
3831
|
Gets the assigned extension for a given extension slot name.
|
|
3973
3832
|
Considers if offline or online.
|
|
@@ -3976,7 +3835,7 @@ Considers if offline or online.
|
|
|
3976
3835
|
|
|
3977
3836
|
| Name | Type | Description |
|
|
3978
3837
|
| :------ | :------ | :------ |
|
|
3979
|
-
| `
|
|
3838
|
+
| `slotName` | `string` | The name of the slot to get the assigned extensions for. |
|
|
3980
3839
|
|
|
3981
3840
|
#### Returns
|
|
3982
3841
|
|
|
@@ -3984,7 +3843,7 @@ Considers if offline or online.
|
|
|
3984
3843
|
|
|
3985
3844
|
#### Defined in
|
|
3986
3845
|
|
|
3987
|
-
[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:
|
|
3846
|
+
[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L14)
|
|
3988
3847
|
|
|
3989
3848
|
___
|
|
3990
3849
|
|
|
@@ -4022,78 +3881,6 @@ ___
|
|
|
4022
3881
|
|
|
4023
3882
|
___
|
|
4024
3883
|
|
|
4025
|
-
### useExtension
|
|
4026
|
-
|
|
4027
|
-
▸ **useExtension**<`TRef`\>(`state?`): [`RefObject`<`TRef`\>, [`ExtensionData`](interfaces/ExtensionData.md) \| `undefined`]
|
|
4028
|
-
|
|
4029
|
-
#### Type parameters
|
|
4030
|
-
|
|
4031
|
-
| Name | Type |
|
|
4032
|
-
| :------ | :------ |
|
|
4033
|
-
| `TRef` | extends `HTMLElement` |
|
|
4034
|
-
|
|
4035
|
-
#### Parameters
|
|
4036
|
-
|
|
4037
|
-
| Name | Type |
|
|
4038
|
-
| :------ | :------ |
|
|
4039
|
-
| `state?` | `Record`<`string`, `any`\> |
|
|
4040
|
-
|
|
4041
|
-
#### Returns
|
|
4042
|
-
|
|
4043
|
-
[`RefObject`<`TRef`\>, [`ExtensionData`](interfaces/ExtensionData.md) \| `undefined`]
|
|
4044
|
-
|
|
4045
|
-
#### Defined in
|
|
4046
|
-
|
|
4047
|
-
[packages/framework/esm-react-utils/src/useExtension.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtension.ts#L5)
|
|
4048
|
-
|
|
4049
|
-
___
|
|
4050
|
-
|
|
4051
|
-
### useExtensionSlot
|
|
4052
|
-
|
|
4053
|
-
▸ **useExtensionSlot**(`extensionSlotName`): `Object`
|
|
4054
|
-
|
|
4055
|
-
#### Parameters
|
|
4056
|
-
|
|
4057
|
-
| Name | Type |
|
|
4058
|
-
| :------ | :------ |
|
|
4059
|
-
| `extensionSlotName` | `string` |
|
|
4060
|
-
|
|
4061
|
-
#### Returns
|
|
4062
|
-
|
|
4063
|
-
`Object`
|
|
4064
|
-
|
|
4065
|
-
| Name | Type |
|
|
4066
|
-
| :------ | :------ |
|
|
4067
|
-
| `extensionSlotModuleName` | `string` |
|
|
4068
|
-
| `extensionSlotName` | `string` |
|
|
4069
|
-
| `extensions` | [`ConnectedExtension`](interfaces/ConnectedExtension.md)[] |
|
|
4070
|
-
|
|
4071
|
-
#### Defined in
|
|
4072
|
-
|
|
4073
|
-
[packages/framework/esm-react-utils/src/useExtensionSlot.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionSlot.ts#L9)
|
|
4074
|
-
|
|
4075
|
-
___
|
|
4076
|
-
|
|
4077
|
-
### useExtensionSlotConfig
|
|
4078
|
-
|
|
4079
|
-
▸ **useExtensionSlotConfig**(`extensionSlotName`): [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md)
|
|
4080
|
-
|
|
4081
|
-
#### Parameters
|
|
4082
|
-
|
|
4083
|
-
| Name | Type |
|
|
4084
|
-
| :------ | :------ |
|
|
4085
|
-
| `extensionSlotName` | `string` |
|
|
4086
|
-
|
|
4087
|
-
#### Returns
|
|
4088
|
-
|
|
4089
|
-
[`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md)
|
|
4090
|
-
|
|
4091
|
-
#### Defined in
|
|
4092
|
-
|
|
4093
|
-
[packages/framework/esm-react-utils/src/useExtensionSlotConfig.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionSlotConfig.ts#L16)
|
|
4094
|
-
|
|
4095
|
-
___
|
|
4096
|
-
|
|
4097
3884
|
### useExtensionSlotMeta
|
|
4098
3885
|
|
|
4099
3886
|
▸ **useExtensionSlotMeta**<`T`\>(`extensionSlotName`): `Object`
|
|
@@ -4126,16 +3913,22 @@ ___
|
|
|
4126
3913
|
|
|
4127
3914
|
▸ `Const` **useExtensionStore**(): `T`
|
|
4128
3915
|
|
|
3916
|
+
The implementation of this will soon undergo a breaking change.
|
|
3917
|
+
This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
|
|
3918
|
+
|
|
4129
3919
|
#### Returns
|
|
4130
3920
|
|
|
4131
3921
|
`T`
|
|
4132
3922
|
|
|
4133
3923
|
#### Defined in
|
|
4134
3924
|
|
|
4135
|
-
[packages/framework/esm-react-utils/src/useExtensionStore.ts:
|
|
3925
|
+
[packages/framework/esm-react-utils/src/useExtensionStore.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L11)
|
|
4136
3926
|
|
|
4137
3927
|
▸ `Const` **useExtensionStore**(`actions`): `T` & [`BoundActions`](API.md#boundactions)
|
|
4138
3928
|
|
|
3929
|
+
The implementation of this will soon undergo a breaking change.
|
|
3930
|
+
This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
|
|
3931
|
+
|
|
4139
3932
|
#### Parameters
|
|
4140
3933
|
|
|
4141
3934
|
| Name | Type |
|
|
@@ -4148,10 +3941,13 @@ ___
|
|
|
4148
3941
|
|
|
4149
3942
|
#### Defined in
|
|
4150
3943
|
|
|
4151
|
-
[packages/framework/esm-react-utils/src/useExtensionStore.ts:
|
|
3944
|
+
[packages/framework/esm-react-utils/src/useExtensionStore.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L11)
|
|
4152
3945
|
|
|
4153
3946
|
▸ `Const` **useExtensionStore**(`actions?`): `T` & [`BoundActions`](API.md#boundactions)
|
|
4154
3947
|
|
|
3948
|
+
The implementation of this will soon undergo a breaking change.
|
|
3949
|
+
This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
|
|
3950
|
+
|
|
4155
3951
|
#### Parameters
|
|
4156
3952
|
|
|
4157
3953
|
| Name | Type |
|
|
@@ -4164,7 +3960,7 @@ ___
|
|
|
4164
3960
|
|
|
4165
3961
|
#### Defined in
|
|
4166
3962
|
|
|
4167
|
-
[packages/framework/esm-react-utils/src/useExtensionStore.ts:
|
|
3963
|
+
[packages/framework/esm-react-utils/src/useExtensionStore.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L11)
|
|
4168
3964
|
|
|
4169
3965
|
___
|
|
4170
3966
|
|