@openmrs/esm-framework 3.1.15-pre.707 → 3.1.15-pre.718
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.map +1 -1
- package/docs/API.md +23 -34
- package/docs/interfaces/ComponentDefinition.md +1 -1
- package/docs/interfaces/ConnectedExtension.md +144 -0
- package/docs/interfaces/{ExtensionComponentDefinition.md → ExtensionDefinition.md} +67 -19
- package/docs/interfaces/ExtensionDetails.md +6 -6
- package/docs/interfaces/ExtensionRegistration.md +2 -0
- package/docs/interfaces/ExtensionSlotBaseProps.md +6 -6
- package/docs/interfaces/PageDefinition.md +2 -2
- package/package.json +13 -13
- package/src/integration-tests/extension-config.test.tsx +49 -0
- package/docs/interfaces/LegacyAppExtensionDefinition.md +0 -170
- package/docs/interfaces/ModernAppExtensionDefinition.md +0 -196
package/docs/API.md
CHANGED
|
@@ -29,13 +29,14 @@
|
|
|
29
29
|
- [ConfigSchema](interfaces/ConfigSchema.md)
|
|
30
30
|
- [ConfigStore](interfaces/ConfigStore.md)
|
|
31
31
|
- [ConfigurableLinkProps](interfaces/ConfigurableLinkProps.md)
|
|
32
|
+
- [ConnectedExtension](interfaces/ConnectedExtension.md)
|
|
32
33
|
- [ConnectivityChangedEvent](interfaces/ConnectivityChangedEvent.md)
|
|
33
34
|
- [CurrentPatientOptions](interfaces/CurrentPatientOptions.md)
|
|
34
35
|
- [CurrentUserOptions](interfaces/CurrentUserOptions.md)
|
|
35
36
|
- [CurrentUserWithResponseOption](interfaces/CurrentUserWithResponseOption.md)
|
|
36
37
|
- [CurrentUserWithoutResponseOption](interfaces/CurrentUserWithoutResponseOption.md)
|
|
37
|
-
- [ExtensionComponentDefinition](interfaces/ExtensionComponentDefinition.md)
|
|
38
38
|
- [ExtensionData](interfaces/ExtensionData.md)
|
|
39
|
+
- [ExtensionDefinition](interfaces/ExtensionDefinition.md)
|
|
39
40
|
- [ExtensionDetails](interfaces/ExtensionDetails.md)
|
|
40
41
|
- [ExtensionInfo](interfaces/ExtensionInfo.md)
|
|
41
42
|
- [ExtensionInstance](interfaces/ExtensionInstance.md)
|
|
@@ -57,13 +58,11 @@
|
|
|
57
58
|
- [FetchResponse](interfaces/FetchResponse.md)
|
|
58
59
|
- [ImplementerToolsConfigStore](interfaces/ImplementerToolsConfigStore.md)
|
|
59
60
|
- [ImportMap](interfaces/ImportMap.md)
|
|
60
|
-
- [LegacyAppExtensionDefinition](interfaces/LegacyAppExtensionDefinition.md)
|
|
61
61
|
- [Lifecycle](interfaces/Lifecycle.md)
|
|
62
62
|
- [Location](interfaces/Location.md)
|
|
63
63
|
- [LoggedInUser](interfaces/LoggedInUser.md)
|
|
64
64
|
- [LoggedInUserFetchResponse](interfaces/LoggedInUserFetchResponse.md)
|
|
65
65
|
- [MessageServiceWorkerResult](interfaces/MessageServiceWorkerResult.md)
|
|
66
|
-
- [ModernAppExtensionDefinition](interfaces/ModernAppExtensionDefinition.md)
|
|
67
66
|
- [NavigateOptions](interfaces/NavigateOptions.md)
|
|
68
67
|
- [NavigationContext](interfaces/NavigationContext.md)
|
|
69
68
|
- [NetworkRequestFailedEvent](interfaces/NetworkRequestFailedEvent.md)
|
|
@@ -108,7 +107,6 @@
|
|
|
108
107
|
### Type aliases
|
|
109
108
|
|
|
110
109
|
- [Actions](API.md#actions)
|
|
111
|
-
- [AppExtensionDefinition](API.md#appextensiondefinition)
|
|
112
110
|
- [BoundActions](API.md#boundactions)
|
|
113
111
|
- [ConfigValue](API.md#configvalue)
|
|
114
112
|
- [CurrentPatient](API.md#currentpatient)
|
|
@@ -335,16 +333,6 @@
|
|
|
335
333
|
|
|
336
334
|
___
|
|
337
335
|
|
|
338
|
-
### AppExtensionDefinition
|
|
339
|
-
|
|
340
|
-
Ƭ **AppExtensionDefinition**: [`ModernAppExtensionDefinition`](interfaces/ModernAppExtensionDefinition.md) & [`LegacyAppExtensionDefinition`](interfaces/LegacyAppExtensionDefinition.md)
|
|
341
|
-
|
|
342
|
-
#### Defined in
|
|
343
|
-
|
|
344
|
-
[packages/framework/esm-globals/src/types.ts:150](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L150)
|
|
345
|
-
|
|
346
|
-
___
|
|
347
|
-
|
|
348
336
|
### BoundActions
|
|
349
337
|
|
|
350
338
|
Ƭ **BoundActions**: `Object`
|
|
@@ -395,7 +383,7 @@ ___
|
|
|
395
383
|
|
|
396
384
|
#### Defined in
|
|
397
385
|
|
|
398
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
386
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L48)
|
|
399
387
|
|
|
400
388
|
___
|
|
401
389
|
|
|
@@ -710,7 +698,7 @@ ___
|
|
|
710
698
|
|
|
711
699
|
#### Defined in
|
|
712
700
|
|
|
713
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
701
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L51)
|
|
714
702
|
|
|
715
703
|
___
|
|
716
704
|
|
|
@@ -1355,7 +1343,7 @@ ___
|
|
|
1355
1343
|
|
|
1356
1344
|
#### Defined in
|
|
1357
1345
|
|
|
1358
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1346
|
+
[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)
|
|
1359
1347
|
|
|
1360
1348
|
___
|
|
1361
1349
|
|
|
@@ -1597,7 +1585,7 @@ ___
|
|
|
1597
1585
|
|
|
1598
1586
|
#### Defined in
|
|
1599
1587
|
|
|
1600
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1588
|
+
[packages/framework/esm-extensions/src/extensions.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L105)
|
|
1601
1589
|
|
|
1602
1590
|
___
|
|
1603
1591
|
|
|
@@ -1617,7 +1605,7 @@ ___
|
|
|
1617
1605
|
|
|
1618
1606
|
#### Defined in
|
|
1619
1607
|
|
|
1620
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1608
|
+
[packages/framework/esm-extensions/src/extensions.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L128)
|
|
1621
1609
|
|
|
1622
1610
|
___
|
|
1623
1611
|
|
|
@@ -1735,13 +1723,14 @@ ___
|
|
|
1735
1723
|
|
|
1736
1724
|
### getAssignedIds
|
|
1737
1725
|
|
|
1738
|
-
▸ **getAssignedIds**(`
|
|
1726
|
+
▸ **getAssignedIds**(`slotName`, `config`, `attachedIds`): `string`[]
|
|
1739
1727
|
|
|
1740
1728
|
#### Parameters
|
|
1741
1729
|
|
|
1742
1730
|
| Name | Type |
|
|
1743
1731
|
| :------ | :------ |
|
|
1744
|
-
| `
|
|
1732
|
+
| `slotName` | `string` |
|
|
1733
|
+
| `config` | [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md) |
|
|
1745
1734
|
| `attachedIds` | `string`[] |
|
|
1746
1735
|
|
|
1747
1736
|
#### Returns
|
|
@@ -1750,7 +1739,7 @@ ___
|
|
|
1750
1739
|
|
|
1751
1740
|
#### Defined in
|
|
1752
1741
|
|
|
1753
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1742
|
+
[packages/framework/esm-extensions/src/extensions.ts:178](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L178)
|
|
1754
1743
|
|
|
1755
1744
|
___
|
|
1756
1745
|
|
|
@@ -1931,7 +1920,7 @@ ___
|
|
|
1931
1920
|
|
|
1932
1921
|
#### Defined in
|
|
1933
1922
|
|
|
1934
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1923
|
+
[packages/framework/esm-extensions/src/extensions.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L33)
|
|
1935
1924
|
|
|
1936
1925
|
___
|
|
1937
1926
|
|
|
@@ -1951,7 +1940,7 @@ ___
|
|
|
1951
1940
|
|
|
1952
1941
|
#### Defined in
|
|
1953
1942
|
|
|
1954
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1943
|
+
[packages/framework/esm-extensions/src/extensions.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L46)
|
|
1955
1944
|
|
|
1956
1945
|
___
|
|
1957
1946
|
|
|
@@ -1972,7 +1961,7 @@ ___
|
|
|
1972
1961
|
|
|
1973
1962
|
#### Defined in
|
|
1974
1963
|
|
|
1975
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
1964
|
+
[packages/framework/esm-extensions/src/extensions.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L38)
|
|
1976
1965
|
|
|
1977
1966
|
___
|
|
1978
1967
|
|
|
@@ -2012,7 +2001,7 @@ ___
|
|
|
2012
2001
|
|
|
2013
2002
|
#### Defined in
|
|
2014
2003
|
|
|
2015
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2004
|
+
[packages/framework/esm-extensions/src/extensions.ts:303](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L303)
|
|
2016
2005
|
|
|
2017
2006
|
___
|
|
2018
2007
|
|
|
@@ -2276,7 +2265,7 @@ with which it has been attached.
|
|
|
2276
2265
|
|
|
2277
2266
|
#### Defined in
|
|
2278
2267
|
|
|
2279
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2268
|
+
[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)
|
|
2280
2269
|
|
|
2281
2270
|
___
|
|
2282
2271
|
|
|
@@ -2763,7 +2752,7 @@ ___
|
|
|
2763
2752
|
|
|
2764
2753
|
#### Defined in
|
|
2765
2754
|
|
|
2766
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2755
|
+
[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)
|
|
2767
2756
|
|
|
2768
2757
|
___
|
|
2769
2758
|
|
|
@@ -2784,7 +2773,7 @@ ___
|
|
|
2784
2773
|
|
|
2785
2774
|
#### Defined in
|
|
2786
2775
|
|
|
2787
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
2776
|
+
[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)
|
|
2788
2777
|
|
|
2789
2778
|
___
|
|
2790
2779
|
|
|
@@ -3687,7 +3676,7 @@ ___
|
|
|
3687
3676
|
|
|
3688
3677
|
#### Defined in
|
|
3689
3678
|
|
|
3690
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
3679
|
+
[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)
|
|
3691
3680
|
|
|
3692
3681
|
___
|
|
3693
3682
|
|
|
@@ -3854,7 +3843,7 @@ ___
|
|
|
3854
3843
|
|
|
3855
3844
|
### useConnectedExtensions
|
|
3856
3845
|
|
|
3857
|
-
▸ **useConnectedExtensions**(`extensionSlotName`): [`
|
|
3846
|
+
▸ **useConnectedExtensions**(`extensionSlotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
|
|
3858
3847
|
|
|
3859
3848
|
Gets the assigned extension for a given extension slot name.
|
|
3860
3849
|
Considers if offline or online.
|
|
@@ -3867,11 +3856,11 @@ Considers if offline or online.
|
|
|
3867
3856
|
|
|
3868
3857
|
#### Returns
|
|
3869
3858
|
|
|
3870
|
-
[`
|
|
3859
|
+
[`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
|
|
3871
3860
|
|
|
3872
3861
|
#### Defined in
|
|
3873
3862
|
|
|
3874
|
-
[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:
|
|
3863
|
+
[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L36)
|
|
3875
3864
|
|
|
3876
3865
|
___
|
|
3877
3866
|
|
|
@@ -3953,7 +3942,7 @@ ___
|
|
|
3953
3942
|
| :------ | :------ |
|
|
3954
3943
|
| `extensionSlotModuleName` | `string` |
|
|
3955
3944
|
| `extensionSlotName` | `string` |
|
|
3956
|
-
| `extensions` | [`
|
|
3945
|
+
| `extensions` | [`ConnectedExtension`](interfaces/ConnectedExtension.md)[] |
|
|
3957
3946
|
|
|
3958
3947
|
#### Defined in
|
|
3959
3948
|
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ConnectedExtension
|
|
2
|
+
|
|
3
|
+
# Interface: ConnectedExtension
|
|
4
|
+
|
|
5
|
+
We have the following extension modes:
|
|
6
|
+
|
|
7
|
+
- attached (set via code in form of: attach, detach, ...)
|
|
8
|
+
- configured (set via configuration in form of: added, removed, ...)
|
|
9
|
+
- assigned (computed from attached and configured)
|
|
10
|
+
- connected (computed from assigned using connectivity and online / offline)
|
|
11
|
+
|
|
12
|
+
## Hierarchy
|
|
13
|
+
|
|
14
|
+
- [`ExtensionRegistration`](ExtensionRegistration.md)
|
|
15
|
+
|
|
16
|
+
↳ **`ConnectedExtension`**
|
|
17
|
+
|
|
18
|
+
## Table of contents
|
|
19
|
+
|
|
20
|
+
### Properties
|
|
21
|
+
|
|
22
|
+
- [id](ConnectedExtension.md#id)
|
|
23
|
+
- [meta](ConnectedExtension.md#meta)
|
|
24
|
+
- [moduleName](ConnectedExtension.md#modulename)
|
|
25
|
+
- [name](ConnectedExtension.md#name)
|
|
26
|
+
- [offline](ConnectedExtension.md#offline)
|
|
27
|
+
- [online](ConnectedExtension.md#online)
|
|
28
|
+
- [order](ConnectedExtension.md#order)
|
|
29
|
+
|
|
30
|
+
### Methods
|
|
31
|
+
|
|
32
|
+
- [load](ConnectedExtension.md#load)
|
|
33
|
+
|
|
34
|
+
## Properties
|
|
35
|
+
|
|
36
|
+
### id
|
|
37
|
+
|
|
38
|
+
• **id**: `string`
|
|
39
|
+
|
|
40
|
+
#### Defined in
|
|
41
|
+
|
|
42
|
+
[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L28)
|
|
43
|
+
|
|
44
|
+
___
|
|
45
|
+
|
|
46
|
+
### meta
|
|
47
|
+
|
|
48
|
+
• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
|
|
49
|
+
|
|
50
|
+
#### Inherited from
|
|
51
|
+
|
|
52
|
+
[ExtensionRegistration](ExtensionRegistration.md).[meta](ExtensionRegistration.md#meta)
|
|
53
|
+
|
|
54
|
+
#### Defined in
|
|
55
|
+
|
|
56
|
+
[packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L16)
|
|
57
|
+
|
|
58
|
+
___
|
|
59
|
+
|
|
60
|
+
### moduleName
|
|
61
|
+
|
|
62
|
+
• **moduleName**: `string`
|
|
63
|
+
|
|
64
|
+
#### Inherited from
|
|
65
|
+
|
|
66
|
+
[ExtensionRegistration](ExtensionRegistration.md).[moduleName](ExtensionRegistration.md#modulename)
|
|
67
|
+
|
|
68
|
+
#### Defined in
|
|
69
|
+
|
|
70
|
+
[packages/framework/esm-extensions/src/store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L15)
|
|
71
|
+
|
|
72
|
+
___
|
|
73
|
+
|
|
74
|
+
### name
|
|
75
|
+
|
|
76
|
+
• **name**: `string`
|
|
77
|
+
|
|
78
|
+
#### Inherited from
|
|
79
|
+
|
|
80
|
+
[ExtensionRegistration](ExtensionRegistration.md).[name](ExtensionRegistration.md#name)
|
|
81
|
+
|
|
82
|
+
#### Defined in
|
|
83
|
+
|
|
84
|
+
[packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L13)
|
|
85
|
+
|
|
86
|
+
___
|
|
87
|
+
|
|
88
|
+
### offline
|
|
89
|
+
|
|
90
|
+
• `Optional` **offline**: `boolean` \| `object`
|
|
91
|
+
|
|
92
|
+
#### Inherited from
|
|
93
|
+
|
|
94
|
+
[ExtensionRegistration](ExtensionRegistration.md).[offline](ExtensionRegistration.md#offline)
|
|
95
|
+
|
|
96
|
+
#### Defined in
|
|
97
|
+
|
|
98
|
+
[packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
|
|
99
|
+
|
|
100
|
+
___
|
|
101
|
+
|
|
102
|
+
### online
|
|
103
|
+
|
|
104
|
+
• `Optional` **online**: `boolean` \| `object`
|
|
105
|
+
|
|
106
|
+
#### Inherited from
|
|
107
|
+
|
|
108
|
+
[ExtensionRegistration](ExtensionRegistration.md).[online](ExtensionRegistration.md#online)
|
|
109
|
+
|
|
110
|
+
#### Defined in
|
|
111
|
+
|
|
112
|
+
[packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L18)
|
|
113
|
+
|
|
114
|
+
___
|
|
115
|
+
|
|
116
|
+
### order
|
|
117
|
+
|
|
118
|
+
• `Optional` **order**: `number`
|
|
119
|
+
|
|
120
|
+
#### Inherited from
|
|
121
|
+
|
|
122
|
+
[ExtensionRegistration](ExtensionRegistration.md).[order](ExtensionRegistration.md#order)
|
|
123
|
+
|
|
124
|
+
#### Defined in
|
|
125
|
+
|
|
126
|
+
[packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L17)
|
|
127
|
+
|
|
128
|
+
## Methods
|
|
129
|
+
|
|
130
|
+
### load
|
|
131
|
+
|
|
132
|
+
▸ **load**(): `Promise`<`any`\>
|
|
133
|
+
|
|
134
|
+
#### Returns
|
|
135
|
+
|
|
136
|
+
`Promise`<`any`\>
|
|
137
|
+
|
|
138
|
+
#### Inherited from
|
|
139
|
+
|
|
140
|
+
[ExtensionRegistration](ExtensionRegistration.md).[load](ExtensionRegistration.md#load)
|
|
141
|
+
|
|
142
|
+
#### Defined in
|
|
143
|
+
|
|
144
|
+
[packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
|
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
[@openmrs/esm-framework](../API.md) /
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ExtensionDefinition
|
|
2
2
|
|
|
3
|
-
# Interface:
|
|
3
|
+
# Interface: ExtensionDefinition
|
|
4
4
|
|
|
5
5
|
## Hierarchy
|
|
6
6
|
|
|
7
7
|
- [`ComponentDefinition`](ComponentDefinition.md)
|
|
8
8
|
|
|
9
|
-
↳ **`
|
|
10
|
-
|
|
11
|
-
↳↳ [`ModernAppExtensionDefinition`](ModernAppExtensionDefinition.md)
|
|
12
|
-
|
|
13
|
-
↳↳ [`LegacyAppExtensionDefinition`](LegacyAppExtensionDefinition.md)
|
|
9
|
+
↳ **`ExtensionDefinition`**
|
|
14
10
|
|
|
15
11
|
## Table of contents
|
|
16
12
|
|
|
17
13
|
### Properties
|
|
18
14
|
|
|
19
|
-
- [appName](
|
|
20
|
-
- [
|
|
21
|
-
- [
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
- [
|
|
25
|
-
- [
|
|
15
|
+
- [appName](ExtensionDefinition.md#appname)
|
|
16
|
+
- [id](ExtensionDefinition.md#id)
|
|
17
|
+
- [meta](ExtensionDefinition.md#meta)
|
|
18
|
+
- [name](ExtensionDefinition.md#name)
|
|
19
|
+
- [offline](ExtensionDefinition.md#offline)
|
|
20
|
+
- [online](ExtensionDefinition.md#online)
|
|
21
|
+
- [order](ExtensionDefinition.md#order)
|
|
22
|
+
- [privilege](ExtensionDefinition.md#privilege)
|
|
23
|
+
- [resources](ExtensionDefinition.md#resources)
|
|
24
|
+
- [slot](ExtensionDefinition.md#slot)
|
|
25
|
+
- [slots](ExtensionDefinition.md#slots)
|
|
26
26
|
|
|
27
27
|
### Methods
|
|
28
28
|
|
|
29
|
-
- [load](
|
|
29
|
+
- [load](ExtensionDefinition.md#load)
|
|
30
30
|
|
|
31
31
|
## Properties
|
|
32
32
|
|
|
@@ -46,15 +46,39 @@ The module/app that defines the component
|
|
|
46
46
|
|
|
47
47
|
___
|
|
48
48
|
|
|
49
|
+
### id
|
|
50
|
+
|
|
51
|
+
• `Optional` **id**: `string`
|
|
52
|
+
|
|
53
|
+
**`deprecated`** A confusing way to specify the name of the extension
|
|
54
|
+
|
|
55
|
+
#### Defined in
|
|
56
|
+
|
|
57
|
+
[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)
|
|
58
|
+
|
|
59
|
+
___
|
|
60
|
+
|
|
49
61
|
### meta
|
|
50
62
|
|
|
51
63
|
• `Optional` **meta**: `Record`<`string`, `any`\>
|
|
52
64
|
|
|
53
|
-
The meta data used for reflection by other components
|
|
65
|
+
The meta data used for reflection by other components
|
|
54
66
|
|
|
55
67
|
#### Defined in
|
|
56
68
|
|
|
57
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
69
|
+
[packages/framework/esm-globals/src/types.ts:123](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L123)
|
|
70
|
+
|
|
71
|
+
___
|
|
72
|
+
|
|
73
|
+
### name
|
|
74
|
+
|
|
75
|
+
• **name**: `string`
|
|
76
|
+
|
|
77
|
+
The name of the extension being registered
|
|
78
|
+
|
|
79
|
+
#### Defined in
|
|
80
|
+
|
|
81
|
+
[packages/framework/esm-globals/src/types.ts:117](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L117)
|
|
58
82
|
|
|
59
83
|
___
|
|
60
84
|
|
|
@@ -94,11 +118,11 @@ ___
|
|
|
94
118
|
|
|
95
119
|
• `Optional` **order**: `number`
|
|
96
120
|
|
|
97
|
-
Specifies
|
|
121
|
+
Specifies the relative order in which the extension renders in a slot
|
|
98
122
|
|
|
99
123
|
#### Defined in
|
|
100
124
|
|
|
101
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
125
|
+
[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)
|
|
102
126
|
|
|
103
127
|
___
|
|
104
128
|
|
|
@@ -132,6 +156,30 @@ Defines resources that are loaded when the component should mount.
|
|
|
132
156
|
|
|
133
157
|
[packages/framework/esm-globals/src/types.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L112)
|
|
134
158
|
|
|
159
|
+
___
|
|
160
|
+
|
|
161
|
+
### slot
|
|
162
|
+
|
|
163
|
+
• `Optional` **slot**: `string`
|
|
164
|
+
|
|
165
|
+
A slot to attach to
|
|
166
|
+
|
|
167
|
+
#### Defined in
|
|
168
|
+
|
|
169
|
+
[packages/framework/esm-globals/src/types.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L119)
|
|
170
|
+
|
|
171
|
+
___
|
|
172
|
+
|
|
173
|
+
### slots
|
|
174
|
+
|
|
175
|
+
• `Optional` **slots**: `string`[]
|
|
176
|
+
|
|
177
|
+
Slots to attach to
|
|
178
|
+
|
|
179
|
+
#### Defined in
|
|
180
|
+
|
|
181
|
+
[packages/framework/esm-globals/src/types.ts:121](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L121)
|
|
182
|
+
|
|
135
183
|
## Methods
|
|
136
184
|
|
|
137
185
|
### load
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
|
|
25
25
|
#### Defined in
|
|
26
26
|
|
|
27
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
27
|
+
[packages/framework/esm-extensions/src/extensions.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L56)
|
|
28
28
|
|
|
29
29
|
___
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ ___
|
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
37
|
+
[packages/framework/esm-extensions/src/extensions.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L54)
|
|
38
38
|
|
|
39
39
|
___
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ ___
|
|
|
44
44
|
|
|
45
45
|
#### Defined in
|
|
46
46
|
|
|
47
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
47
|
+
[packages/framework/esm-extensions/src/extensions.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L58)
|
|
48
48
|
|
|
49
49
|
___
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ ___
|
|
|
54
54
|
|
|
55
55
|
#### Defined in
|
|
56
56
|
|
|
57
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
57
|
+
[packages/framework/esm-extensions/src/extensions.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L57)
|
|
58
58
|
|
|
59
59
|
___
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ ___
|
|
|
64
64
|
|
|
65
65
|
#### Defined in
|
|
66
66
|
|
|
67
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
67
|
+
[packages/framework/esm-extensions/src/extensions.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L59)
|
|
68
68
|
|
|
69
69
|
## Methods
|
|
70
70
|
|
|
@@ -78,4 +78,4 @@ ___
|
|
|
78
78
|
|
|
79
79
|
#### Defined in
|
|
80
80
|
|
|
81
|
-
[packages/framework/esm-extensions/src/extensions.ts:
|
|
81
|
+
[packages/framework/esm-extensions/src/extensions.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L55)
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
#### Defined in
|
|
23
23
|
|
|
24
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
24
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L43)
|
|
25
25
|
|
|
26
26
|
___
|
|
27
27
|
|
|
@@ -31,24 +31,24 @@ ___
|
|
|
31
31
|
|
|
32
32
|
#### Defined in
|
|
33
33
|
|
|
34
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
34
|
+
[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)
|
|
35
35
|
|
|
36
36
|
## Methods
|
|
37
37
|
|
|
38
38
|
### select
|
|
39
39
|
|
|
40
|
-
▸ `Optional` **select**(`extensions`): [`
|
|
40
|
+
▸ `Optional` **select**(`extensions`): [`ConnectedExtension`](ConnectedExtension.md)[]
|
|
41
41
|
|
|
42
42
|
#### Parameters
|
|
43
43
|
|
|
44
44
|
| Name | Type |
|
|
45
45
|
| :------ | :------ |
|
|
46
|
-
| `extensions` | [`
|
|
46
|
+
| `extensions` | [`ConnectedExtension`](ConnectedExtension.md)[] |
|
|
47
47
|
|
|
48
48
|
#### Returns
|
|
49
49
|
|
|
50
|
-
[`
|
|
50
|
+
[`ConnectedExtension`](ConnectedExtension.md)[]
|
|
51
51
|
|
|
52
52
|
#### Defined in
|
|
53
53
|
|
|
54
|
-
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:
|
|
54
|
+
[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:44](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L44)
|
|
@@ -82,7 +82,7 @@ The order in which to load the page. This determines DOM order.
|
|
|
82
82
|
|
|
83
83
|
#### Defined in
|
|
84
84
|
|
|
85
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
85
|
+
[packages/framework/esm-globals/src/types.ts:138](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L138)
|
|
86
86
|
|
|
87
87
|
___
|
|
88
88
|
|
|
@@ -126,7 +126,7 @@ The route of the page.
|
|
|
126
126
|
|
|
127
127
|
#### Defined in
|
|
128
128
|
|
|
129
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
129
|
+
[packages/framework/esm-globals/src/types.ts:134](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L134)
|
|
130
130
|
|
|
131
131
|
## Methods
|
|
132
132
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "3.1.15-pre.
|
|
3
|
+
"version": "3.1.15-pre.718",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"browser": "dist/openmrs-esm-framework.js",
|
|
6
6
|
"main": "src/index.ts",
|
|
@@ -35,17 +35,17 @@
|
|
|
35
35
|
"access": "public"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@openmrs/esm-api": "^3.1.15-pre.
|
|
39
|
-
"@openmrs/esm-breadcrumbs": "^3.1.15-pre.
|
|
40
|
-
"@openmrs/esm-config": "^3.1.15-pre.
|
|
41
|
-
"@openmrs/esm-error-handling": "^3.1.15-pre.
|
|
42
|
-
"@openmrs/esm-extensions": "^3.1.15-pre.
|
|
43
|
-
"@openmrs/esm-globals": "^3.1.15-pre.
|
|
44
|
-
"@openmrs/esm-offline": "^3.1.15-pre.
|
|
45
|
-
"@openmrs/esm-react-utils": "^3.1.15-pre.
|
|
46
|
-
"@openmrs/esm-state": "^3.1.15-pre.
|
|
47
|
-
"@openmrs/esm-styleguide": "^3.1.15-pre.
|
|
48
|
-
"@openmrs/esm-utils": "^3.1.15-pre.
|
|
38
|
+
"@openmrs/esm-api": "^3.1.15-pre.718",
|
|
39
|
+
"@openmrs/esm-breadcrumbs": "^3.1.15-pre.718",
|
|
40
|
+
"@openmrs/esm-config": "^3.1.15-pre.718",
|
|
41
|
+
"@openmrs/esm-error-handling": "^3.1.15-pre.718",
|
|
42
|
+
"@openmrs/esm-extensions": "^3.1.15-pre.718",
|
|
43
|
+
"@openmrs/esm-globals": "^3.1.15-pre.718",
|
|
44
|
+
"@openmrs/esm-offline": "^3.1.15-pre.718",
|
|
45
|
+
"@openmrs/esm-react-utils": "^3.1.15-pre.718",
|
|
46
|
+
"@openmrs/esm-state": "^3.1.15-pre.718",
|
|
47
|
+
"@openmrs/esm-styleguide": "^3.1.15-pre.718",
|
|
48
|
+
"@openmrs/esm-utils": "^3.1.15-pre.718"
|
|
49
49
|
},
|
|
50
|
-
"gitHead": "
|
|
50
|
+
"gitHead": "4f30619d9e3db89532aafd059d9d12740782501b"
|
|
51
51
|
}
|