@openmrs/esm-extensions 3.1.15-pre.701 → 3.1.15-pre.717
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/README.md +0 -2
- package/package.json +5 -6
- package/docs/API.md +0 -511
- package/docs/interfaces/CancelLoading.md +0 -17
- package/docs/interfaces/ExtensionDetails.md +0 -81
- package/docs/interfaces/ExtensionInfo.md +0 -140
- package/docs/interfaces/ExtensionInstance.md +0 -19
- package/docs/interfaces/ExtensionMeta.md +0 -7
- package/docs/interfaces/ExtensionRegistration.md +0 -98
- package/docs/interfaces/ExtensionSlotInfo.md +0 -50
- package/docs/interfaces/ExtensionSlotInstance.md +0 -51
- package/docs/interfaces/ExtensionStore.md +0 -34
- package/docs/interfaces/Lifecycle.md +0 -68
- package/docs/interfaces/NavigationContext.md +0 -50
- package/typedoc.json +0 -7
package/README.md
CHANGED
package/package.json
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-extensions",
|
|
3
|
-
"version": "3.1.15-pre.
|
|
3
|
+
"version": "3.1.15-pre.717",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"description": "Coordinates extensions and extension points in the OpenMRS Frontend",
|
|
6
6
|
"browser": "dist/openmrs-esm-extensions.js",
|
|
7
7
|
"main": "src/index.ts",
|
|
8
8
|
"source": true,
|
|
9
9
|
"scripts": {
|
|
10
|
-
"document": "../../../document.sh esm-extensions",
|
|
11
10
|
"test": "jest --config jest.config.js --passWithNoTests",
|
|
12
11
|
"build": "webpack --mode=production",
|
|
13
12
|
"analyze": "webpack --mode=production --env analyze=true",
|
|
@@ -43,13 +42,13 @@
|
|
|
43
42
|
"single-spa": "5.x"
|
|
44
43
|
},
|
|
45
44
|
"devDependencies": {
|
|
46
|
-
"@openmrs/esm-api": "^3.1.15-pre.
|
|
47
|
-
"@openmrs/esm-config": "^3.1.15-pre.
|
|
48
|
-
"@openmrs/esm-state": "^3.1.15-pre.
|
|
45
|
+
"@openmrs/esm-api": "^3.1.15-pre.717",
|
|
46
|
+
"@openmrs/esm-config": "^3.1.15-pre.717",
|
|
47
|
+
"@openmrs/esm-state": "^3.1.15-pre.717",
|
|
49
48
|
"single-spa": "^5.9.2"
|
|
50
49
|
},
|
|
51
50
|
"dependencies": {
|
|
52
51
|
"lodash-es": "^4.17.21"
|
|
53
52
|
},
|
|
54
|
-
"gitHead": "
|
|
53
|
+
"gitHead": "a32a7f7f7713dcf22992df9864b6e6b3ff0490d6"
|
|
55
54
|
}
|
package/docs/API.md
DELETED
|
@@ -1,511 +0,0 @@
|
|
|
1
|
-
[Back to README.md](../README.md)
|
|
2
|
-
|
|
3
|
-
# @openmrs/esm-extensions
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Interfaces
|
|
8
|
-
|
|
9
|
-
- [CancelLoading](interfaces/CancelLoading.md)
|
|
10
|
-
- [ExtensionDetails](interfaces/ExtensionDetails.md)
|
|
11
|
-
- [ExtensionInfo](interfaces/ExtensionInfo.md)
|
|
12
|
-
- [ExtensionInstance](interfaces/ExtensionInstance.md)
|
|
13
|
-
- [ExtensionMeta](interfaces/ExtensionMeta.md)
|
|
14
|
-
- [ExtensionRegistration](interfaces/ExtensionRegistration.md)
|
|
15
|
-
- [ExtensionSlotInfo](interfaces/ExtensionSlotInfo.md)
|
|
16
|
-
- [ExtensionSlotInstance](interfaces/ExtensionSlotInstance.md)
|
|
17
|
-
- [ExtensionStore](interfaces/ExtensionStore.md)
|
|
18
|
-
- [Lifecycle](interfaces/Lifecycle.md)
|
|
19
|
-
- [NavigationContext](interfaces/NavigationContext.md)
|
|
20
|
-
|
|
21
|
-
### Type aliases
|
|
22
|
-
|
|
23
|
-
- [MaybeAsync](API.md#maybeasync)
|
|
24
|
-
- [NavigationContextType](API.md#navigationcontexttype)
|
|
25
|
-
|
|
26
|
-
### Variables
|
|
27
|
-
|
|
28
|
-
- [extensionStore](API.md#extensionstore)
|
|
29
|
-
|
|
30
|
-
### Functions
|
|
31
|
-
|
|
32
|
-
- [attach](API.md#attach)
|
|
33
|
-
- [checkStatus](API.md#checkstatus)
|
|
34
|
-
- [checkStatusFor](API.md#checkstatusfor)
|
|
35
|
-
- [detach](API.md#detach)
|
|
36
|
-
- [detachAll](API.md#detachall)
|
|
37
|
-
- [getAssignedIds](API.md#getassignedids)
|
|
38
|
-
- [getCustomProps](API.md#getcustomprops)
|
|
39
|
-
- [getExtensionNameFromId](API.md#getextensionnamefromid)
|
|
40
|
-
- [getExtensionRegistration](API.md#getextensionregistration)
|
|
41
|
-
- [getExtensionRegistrationFrom](API.md#getextensionregistrationfrom)
|
|
42
|
-
- [getExtensionSlotsForModule](API.md#getextensionslotsformodule)
|
|
43
|
-
- [getUpdatedExtensionSlotInfo](API.md#getupdatedextensionslotinfo)
|
|
44
|
-
- [pushNavigationContext](API.md#pushnavigationcontext)
|
|
45
|
-
- [registerExtension](API.md#registerextension)
|
|
46
|
-
- [registerExtensionSlot](API.md#registerextensionslot)
|
|
47
|
-
- [renderExtension](API.md#renderextension)
|
|
48
|
-
- [switchTo](API.md#switchto)
|
|
49
|
-
- [unregisterExtensionSlot](API.md#unregisterextensionslot)
|
|
50
|
-
- [updateExtensionStore](API.md#updateextensionstore)
|
|
51
|
-
|
|
52
|
-
## Type aliases
|
|
53
|
-
|
|
54
|
-
### MaybeAsync
|
|
55
|
-
|
|
56
|
-
Ƭ **MaybeAsync**<`T`\>: `T` \| `Promise`<`T`\>
|
|
57
|
-
|
|
58
|
-
#### Type parameters
|
|
59
|
-
|
|
60
|
-
| Name |
|
|
61
|
-
| :------ |
|
|
62
|
-
| `T` |
|
|
63
|
-
|
|
64
|
-
#### Defined in
|
|
65
|
-
|
|
66
|
-
[store.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L83)
|
|
67
|
-
|
|
68
|
-
___
|
|
69
|
-
|
|
70
|
-
### NavigationContextType
|
|
71
|
-
|
|
72
|
-
Ƭ **NavigationContextType**: ``"workspace"`` \| ``"dialog"`` \| ``"link"``
|
|
73
|
-
|
|
74
|
-
#### Defined in
|
|
75
|
-
|
|
76
|
-
[contexts.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L3)
|
|
77
|
-
|
|
78
|
-
## Variables
|
|
79
|
-
|
|
80
|
-
### extensionStore
|
|
81
|
-
|
|
82
|
-
• `Const` **extensionStore**: `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
|
|
83
|
-
|
|
84
|
-
#### Defined in
|
|
85
|
-
|
|
86
|
-
[store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L78)
|
|
87
|
-
|
|
88
|
-
## Functions
|
|
89
|
-
|
|
90
|
-
### attach
|
|
91
|
-
|
|
92
|
-
▸ **attach**(`extensionSlotName`, `extensionId`): `void`
|
|
93
|
-
|
|
94
|
-
#### Parameters
|
|
95
|
-
|
|
96
|
-
| Name | Type |
|
|
97
|
-
| :------ | :------ |
|
|
98
|
-
| `extensionSlotName` | `string` |
|
|
99
|
-
| `extensionId` | `string` |
|
|
100
|
-
|
|
101
|
-
#### Returns
|
|
102
|
-
|
|
103
|
-
`void`
|
|
104
|
-
|
|
105
|
-
#### Defined in
|
|
106
|
-
|
|
107
|
-
[extensions.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L71)
|
|
108
|
-
|
|
109
|
-
___
|
|
110
|
-
|
|
111
|
-
### checkStatus
|
|
112
|
-
|
|
113
|
-
▸ **checkStatus**(`online?`, `offline?`): `boolean`
|
|
114
|
-
|
|
115
|
-
#### Parameters
|
|
116
|
-
|
|
117
|
-
| Name | Type | Default value |
|
|
118
|
-
| :------ | :------ | :------ |
|
|
119
|
-
| `online` | `boolean` \| `object` | `true` |
|
|
120
|
-
| `offline` | `boolean` \| `object` | `false` |
|
|
121
|
-
|
|
122
|
-
#### Returns
|
|
123
|
-
|
|
124
|
-
`boolean`
|
|
125
|
-
|
|
126
|
-
#### Defined in
|
|
127
|
-
|
|
128
|
-
[helpers.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/helpers.ts#L1)
|
|
129
|
-
|
|
130
|
-
___
|
|
131
|
-
|
|
132
|
-
### checkStatusFor
|
|
133
|
-
|
|
134
|
-
▸ **checkStatusFor**(`status`, `online?`, `offline?`): `boolean`
|
|
135
|
-
|
|
136
|
-
#### Parameters
|
|
137
|
-
|
|
138
|
-
| Name | Type | Default value |
|
|
139
|
-
| :------ | :------ | :------ |
|
|
140
|
-
| `status` | `boolean` | `undefined` |
|
|
141
|
-
| `online` | `boolean` \| `object` | `true` |
|
|
142
|
-
| `offline` | `boolean` \| `object` | `false` |
|
|
143
|
-
|
|
144
|
-
#### Returns
|
|
145
|
-
|
|
146
|
-
`boolean`
|
|
147
|
-
|
|
148
|
-
#### Defined in
|
|
149
|
-
|
|
150
|
-
[helpers.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/helpers.ts#L9)
|
|
151
|
-
|
|
152
|
-
___
|
|
153
|
-
|
|
154
|
-
### detach
|
|
155
|
-
|
|
156
|
-
▸ **detach**(`extensionSlotName`, `extensionId`): `void`
|
|
157
|
-
|
|
158
|
-
#### Parameters
|
|
159
|
-
|
|
160
|
-
| Name | Type |
|
|
161
|
-
| :------ | :------ |
|
|
162
|
-
| `extensionSlotName` | `string` |
|
|
163
|
-
| `extensionId` | `string` |
|
|
164
|
-
|
|
165
|
-
#### Returns
|
|
166
|
-
|
|
167
|
-
`void`
|
|
168
|
-
|
|
169
|
-
#### Defined in
|
|
170
|
-
|
|
171
|
-
[extensions.ts:101](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L101)
|
|
172
|
-
|
|
173
|
-
___
|
|
174
|
-
|
|
175
|
-
### detachAll
|
|
176
|
-
|
|
177
|
-
▸ **detachAll**(`extensionSlotName`): `void`
|
|
178
|
-
|
|
179
|
-
#### Parameters
|
|
180
|
-
|
|
181
|
-
| Name | Type |
|
|
182
|
-
| :------ | :------ |
|
|
183
|
-
| `extensionSlotName` | `string` |
|
|
184
|
-
|
|
185
|
-
#### Returns
|
|
186
|
-
|
|
187
|
-
`void`
|
|
188
|
-
|
|
189
|
-
#### Defined in
|
|
190
|
-
|
|
191
|
-
[extensions.ts:124](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L124)
|
|
192
|
-
|
|
193
|
-
___
|
|
194
|
-
|
|
195
|
-
### getAssignedIds
|
|
196
|
-
|
|
197
|
-
▸ **getAssignedIds**(`instance`, `attachedIds`): `string`[]
|
|
198
|
-
|
|
199
|
-
#### Parameters
|
|
200
|
-
|
|
201
|
-
| Name | Type |
|
|
202
|
-
| :------ | :------ |
|
|
203
|
-
| `instance` | [`ExtensionSlotInstance`](interfaces/ExtensionSlotInstance.md) |
|
|
204
|
-
| `attachedIds` | `string`[] |
|
|
205
|
-
|
|
206
|
-
#### Returns
|
|
207
|
-
|
|
208
|
-
`string`[]
|
|
209
|
-
|
|
210
|
-
#### Defined in
|
|
211
|
-
|
|
212
|
-
[extensions.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L157)
|
|
213
|
-
|
|
214
|
-
___
|
|
215
|
-
|
|
216
|
-
### getCustomProps
|
|
217
|
-
|
|
218
|
-
▸ **getCustomProps**(`online`, `offline`): `object`
|
|
219
|
-
|
|
220
|
-
#### Parameters
|
|
221
|
-
|
|
222
|
-
| Name | Type |
|
|
223
|
-
| :------ | :------ |
|
|
224
|
-
| `online` | `boolean` \| `object` \| `undefined` |
|
|
225
|
-
| `offline` | `boolean` \| `object` \| `undefined` |
|
|
226
|
-
|
|
227
|
-
#### Returns
|
|
228
|
-
|
|
229
|
-
`object`
|
|
230
|
-
|
|
231
|
-
#### Defined in
|
|
232
|
-
|
|
233
|
-
[helpers.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/helpers.ts#L17)
|
|
234
|
-
|
|
235
|
-
___
|
|
236
|
-
|
|
237
|
-
### getExtensionNameFromId
|
|
238
|
-
|
|
239
|
-
▸ **getExtensionNameFromId**(`extensionId`): `string`
|
|
240
|
-
|
|
241
|
-
#### Parameters
|
|
242
|
-
|
|
243
|
-
| Name | Type |
|
|
244
|
-
| :------ | :------ |
|
|
245
|
-
| `extensionId` | `string` |
|
|
246
|
-
|
|
247
|
-
#### Returns
|
|
248
|
-
|
|
249
|
-
`string`
|
|
250
|
-
|
|
251
|
-
#### Defined in
|
|
252
|
-
|
|
253
|
-
[extensions.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L29)
|
|
254
|
-
|
|
255
|
-
___
|
|
256
|
-
|
|
257
|
-
### getExtensionRegistration
|
|
258
|
-
|
|
259
|
-
▸ **getExtensionRegistration**(`extensionId`): [`ExtensionRegistration`](interfaces/ExtensionRegistration.md) \| `undefined`
|
|
260
|
-
|
|
261
|
-
#### Parameters
|
|
262
|
-
|
|
263
|
-
| Name | Type |
|
|
264
|
-
| :------ | :------ |
|
|
265
|
-
| `extensionId` | `string` |
|
|
266
|
-
|
|
267
|
-
#### Returns
|
|
268
|
-
|
|
269
|
-
[`ExtensionRegistration`](interfaces/ExtensionRegistration.md) \| `undefined`
|
|
270
|
-
|
|
271
|
-
#### Defined in
|
|
272
|
-
|
|
273
|
-
[extensions.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L42)
|
|
274
|
-
|
|
275
|
-
___
|
|
276
|
-
|
|
277
|
-
### getExtensionRegistrationFrom
|
|
278
|
-
|
|
279
|
-
▸ **getExtensionRegistrationFrom**(`state`, `extensionId`): [`ExtensionRegistration`](interfaces/ExtensionRegistration.md) \| `undefined`
|
|
280
|
-
|
|
281
|
-
#### Parameters
|
|
282
|
-
|
|
283
|
-
| Name | Type |
|
|
284
|
-
| :------ | :------ |
|
|
285
|
-
| `state` | [`ExtensionStore`](interfaces/ExtensionStore.md) |
|
|
286
|
-
| `extensionId` | `string` |
|
|
287
|
-
|
|
288
|
-
#### Returns
|
|
289
|
-
|
|
290
|
-
[`ExtensionRegistration`](interfaces/ExtensionRegistration.md) \| `undefined`
|
|
291
|
-
|
|
292
|
-
#### Defined in
|
|
293
|
-
|
|
294
|
-
[extensions.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L34)
|
|
295
|
-
|
|
296
|
-
___
|
|
297
|
-
|
|
298
|
-
### getExtensionSlotsForModule
|
|
299
|
-
|
|
300
|
-
▸ **getExtensionSlotsForModule**(`moduleName`): `string`[]
|
|
301
|
-
|
|
302
|
-
#### Parameters
|
|
303
|
-
|
|
304
|
-
| Name | Type |
|
|
305
|
-
| :------ | :------ |
|
|
306
|
-
| `moduleName` | `string` |
|
|
307
|
-
|
|
308
|
-
#### Returns
|
|
309
|
-
|
|
310
|
-
`string`[]
|
|
311
|
-
|
|
312
|
-
#### Defined in
|
|
313
|
-
|
|
314
|
-
[extensions.ts:269](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L269)
|
|
315
|
-
|
|
316
|
-
___
|
|
317
|
-
|
|
318
|
-
### getUpdatedExtensionSlotInfo
|
|
319
|
-
|
|
320
|
-
▸ **getUpdatedExtensionSlotInfo**(`slotName`, `moduleName`, `extensionSlot`): [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
|
|
321
|
-
|
|
322
|
-
Returns information describing all extensions which can be rendered into an extension slot with
|
|
323
|
-
the specified name.
|
|
324
|
-
The returned information describe the extension itself, as well as the extension slot name(s)
|
|
325
|
-
with which it has been attached.
|
|
326
|
-
|
|
327
|
-
#### Parameters
|
|
328
|
-
|
|
329
|
-
| Name | Type | Description |
|
|
330
|
-
| :------ | :------ | :------ |
|
|
331
|
-
| `slotName` | `string` | The extension slot name for which matching extension info should be returned. |
|
|
332
|
-
| `moduleName` | `string` | The module name. Used for applying extension-specific config values to the result. |
|
|
333
|
-
| `extensionSlot` | [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md) | The extension slot information object. |
|
|
334
|
-
|
|
335
|
-
#### Returns
|
|
336
|
-
|
|
337
|
-
[`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
|
|
338
|
-
|
|
339
|
-
#### Defined in
|
|
340
|
-
|
|
341
|
-
[extensions.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L296)
|
|
342
|
-
|
|
343
|
-
___
|
|
344
|
-
|
|
345
|
-
### pushNavigationContext
|
|
346
|
-
|
|
347
|
-
▸ **pushNavigationContext**(`_context`): () => `void`
|
|
348
|
-
|
|
349
|
-
**`deprecated`** don't use
|
|
350
|
-
|
|
351
|
-
#### Parameters
|
|
352
|
-
|
|
353
|
-
| Name | Type |
|
|
354
|
-
| :------ | :------ |
|
|
355
|
-
| `_context` | [`NavigationContext`](interfaces/NavigationContext.md) |
|
|
356
|
-
|
|
357
|
-
#### Returns
|
|
358
|
-
|
|
359
|
-
`fn`
|
|
360
|
-
|
|
361
|
-
▸ (): `void`
|
|
362
|
-
|
|
363
|
-
##### Returns
|
|
364
|
-
|
|
365
|
-
`void`
|
|
366
|
-
|
|
367
|
-
#### Defined in
|
|
368
|
-
|
|
369
|
-
[contexts.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L24)
|
|
370
|
-
|
|
371
|
-
___
|
|
372
|
-
|
|
373
|
-
### registerExtension
|
|
374
|
-
|
|
375
|
-
▸ `Const` **registerExtension**(`name`, `details`): `void`
|
|
376
|
-
|
|
377
|
-
#### Parameters
|
|
378
|
-
|
|
379
|
-
| Name | Type |
|
|
380
|
-
| :------ | :------ |
|
|
381
|
-
| `name` | `string` |
|
|
382
|
-
| `details` | [`ExtensionDetails`](interfaces/ExtensionDetails.md) |
|
|
383
|
-
|
|
384
|
-
#### Returns
|
|
385
|
-
|
|
386
|
-
`void`
|
|
387
|
-
|
|
388
|
-
#### Defined in
|
|
389
|
-
|
|
390
|
-
[extensions.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L58)
|
|
391
|
-
|
|
392
|
-
___
|
|
393
|
-
|
|
394
|
-
### registerExtensionSlot
|
|
395
|
-
|
|
396
|
-
▸ **registerExtensionSlot**(`moduleName`, `slotName`): `void`
|
|
397
|
-
|
|
398
|
-
#### Parameters
|
|
399
|
-
|
|
400
|
-
| Name | Type | Description |
|
|
401
|
-
| :------ | :------ | :------ |
|
|
402
|
-
| `moduleName` | `string` | The name of the module that contains the extension slot |
|
|
403
|
-
| `slotName` | `string` | The extension slot name that is actually used |
|
|
404
|
-
|
|
405
|
-
#### Returns
|
|
406
|
-
|
|
407
|
-
`void`
|
|
408
|
-
|
|
409
|
-
#### Defined in
|
|
410
|
-
|
|
411
|
-
[extensions.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L222)
|
|
412
|
-
|
|
413
|
-
___
|
|
414
|
-
|
|
415
|
-
### renderExtension
|
|
416
|
-
|
|
417
|
-
▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): [`CancelLoading`](interfaces/CancelLoading.md)
|
|
418
|
-
|
|
419
|
-
Mounts into a DOM node (representing an extension slot)
|
|
420
|
-
a lazy-loaded component from *any* frontend module
|
|
421
|
-
that registered an extension component for this slot.
|
|
422
|
-
|
|
423
|
-
#### Parameters
|
|
424
|
-
|
|
425
|
-
| Name | Type |
|
|
426
|
-
| :------ | :------ |
|
|
427
|
-
| `domElement` | `HTMLElement` |
|
|
428
|
-
| `extensionSlotName` | `string` |
|
|
429
|
-
| `extensionSlotModuleName` | `string` |
|
|
430
|
-
| `extensionId` | `string` |
|
|
431
|
-
| `renderFunction` | (`lifecycle`: [`Lifecycle`](interfaces/Lifecycle.md)) => [`Lifecycle`](interfaces/Lifecycle.md) |
|
|
432
|
-
| `additionalProps` | `Record`<`string`, `any`\> |
|
|
433
|
-
|
|
434
|
-
#### Returns
|
|
435
|
-
|
|
436
|
-
[`CancelLoading`](interfaces/CancelLoading.md)
|
|
437
|
-
|
|
438
|
-
#### Defined in
|
|
439
|
-
|
|
440
|
-
[render.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L23)
|
|
441
|
-
|
|
442
|
-
___
|
|
443
|
-
|
|
444
|
-
### switchTo
|
|
445
|
-
|
|
446
|
-
▸ **switchTo**<`T`\>(`_type`, `link`, `_state?`): `void`
|
|
447
|
-
|
|
448
|
-
**`deprecated`** use `navigate` directly
|
|
449
|
-
|
|
450
|
-
#### Type parameters
|
|
451
|
-
|
|
452
|
-
| Name |
|
|
453
|
-
| :------ |
|
|
454
|
-
| `T` |
|
|
455
|
-
|
|
456
|
-
#### Parameters
|
|
457
|
-
|
|
458
|
-
| Name | Type |
|
|
459
|
-
| :------ | :------ |
|
|
460
|
-
| `_type` | [`NavigationContextType`](API.md#navigationcontexttype) |
|
|
461
|
-
| `link` | `string` |
|
|
462
|
-
| `_state?` | `T` |
|
|
463
|
-
|
|
464
|
-
#### Returns
|
|
465
|
-
|
|
466
|
-
`void`
|
|
467
|
-
|
|
468
|
-
#### Defined in
|
|
469
|
-
|
|
470
|
-
[contexts.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L13)
|
|
471
|
-
|
|
472
|
-
___
|
|
473
|
-
|
|
474
|
-
### unregisterExtensionSlot
|
|
475
|
-
|
|
476
|
-
▸ **unregisterExtensionSlot**(`moduleName`, `slotName`): `void`
|
|
477
|
-
|
|
478
|
-
#### Parameters
|
|
479
|
-
|
|
480
|
-
| Name | Type |
|
|
481
|
-
| :------ | :------ |
|
|
482
|
-
| `moduleName` | `string` |
|
|
483
|
-
| `slotName` | `string` |
|
|
484
|
-
|
|
485
|
-
#### Returns
|
|
486
|
-
|
|
487
|
-
`void`
|
|
488
|
-
|
|
489
|
-
#### Defined in
|
|
490
|
-
|
|
491
|
-
[extensions.ts:245](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L245)
|
|
492
|
-
|
|
493
|
-
___
|
|
494
|
-
|
|
495
|
-
### updateExtensionStore
|
|
496
|
-
|
|
497
|
-
▸ **updateExtensionStore**(`updater`): `void`
|
|
498
|
-
|
|
499
|
-
#### Parameters
|
|
500
|
-
|
|
501
|
-
| Name | Type |
|
|
502
|
-
| :------ | :------ |
|
|
503
|
-
| `updater` | (`state`: [`ExtensionStore`](interfaces/ExtensionStore.md)) => [`MaybeAsync`](API.md#maybeasync)<[`ExtensionStore`](interfaces/ExtensionStore.md)\> |
|
|
504
|
-
|
|
505
|
-
#### Returns
|
|
506
|
-
|
|
507
|
-
`void`
|
|
508
|
-
|
|
509
|
-
#### Defined in
|
|
510
|
-
|
|
511
|
-
[store.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L87)
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / CancelLoading
|
|
2
|
-
|
|
3
|
-
# Interface: CancelLoading
|
|
4
|
-
|
|
5
|
-
## Callable
|
|
6
|
-
|
|
7
|
-
### CancelLoading
|
|
8
|
-
|
|
9
|
-
▸ **CancelLoading**(): `void`
|
|
10
|
-
|
|
11
|
-
#### Returns
|
|
12
|
-
|
|
13
|
-
`void`
|
|
14
|
-
|
|
15
|
-
#### Defined in
|
|
16
|
-
|
|
17
|
-
[render.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L15)
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / ExtensionDetails
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionDetails
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [meta](ExtensionDetails.md#meta)
|
|
10
|
-
- [moduleName](ExtensionDetails.md#modulename)
|
|
11
|
-
- [offline](ExtensionDetails.md#offline)
|
|
12
|
-
- [online](ExtensionDetails.md#online)
|
|
13
|
-
- [order](ExtensionDetails.md#order)
|
|
14
|
-
|
|
15
|
-
### Methods
|
|
16
|
-
|
|
17
|
-
- [load](ExtensionDetails.md#load)
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### meta
|
|
22
|
-
|
|
23
|
-
• **meta**: `Record`<`string`, `any`\>
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[extensions.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L52)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### moduleName
|
|
32
|
-
|
|
33
|
-
• **moduleName**: `string`
|
|
34
|
-
|
|
35
|
-
#### Defined in
|
|
36
|
-
|
|
37
|
-
[extensions.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L50)
|
|
38
|
-
|
|
39
|
-
___
|
|
40
|
-
|
|
41
|
-
### offline
|
|
42
|
-
|
|
43
|
-
• `Optional` **offline**: `boolean` \| `object`
|
|
44
|
-
|
|
45
|
-
#### Defined in
|
|
46
|
-
|
|
47
|
-
[extensions.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L54)
|
|
48
|
-
|
|
49
|
-
___
|
|
50
|
-
|
|
51
|
-
### online
|
|
52
|
-
|
|
53
|
-
• `Optional` **online**: `boolean` \| `object`
|
|
54
|
-
|
|
55
|
-
#### Defined in
|
|
56
|
-
|
|
57
|
-
[extensions.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L53)
|
|
58
|
-
|
|
59
|
-
___
|
|
60
|
-
|
|
61
|
-
### order
|
|
62
|
-
|
|
63
|
-
• `Optional` **order**: `number`
|
|
64
|
-
|
|
65
|
-
#### Defined in
|
|
66
|
-
|
|
67
|
-
[extensions.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L55)
|
|
68
|
-
|
|
69
|
-
## Methods
|
|
70
|
-
|
|
71
|
-
### load
|
|
72
|
-
|
|
73
|
-
▸ **load**(): `Promise`<`any`\>
|
|
74
|
-
|
|
75
|
-
#### Returns
|
|
76
|
-
|
|
77
|
-
`Promise`<`any`\>
|
|
78
|
-
|
|
79
|
-
#### Defined in
|
|
80
|
-
|
|
81
|
-
[extensions.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L51)
|
|
@@ -1,140 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / ExtensionInfo
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionInfo
|
|
4
|
-
|
|
5
|
-
## Hierarchy
|
|
6
|
-
|
|
7
|
-
- [`ExtensionRegistration`](ExtensionRegistration.md)
|
|
8
|
-
|
|
9
|
-
↳ **`ExtensionInfo`**
|
|
10
|
-
|
|
11
|
-
## Table of contents
|
|
12
|
-
|
|
13
|
-
### Properties
|
|
14
|
-
|
|
15
|
-
- [instances](ExtensionInfo.md#instances)
|
|
16
|
-
- [meta](ExtensionInfo.md#meta)
|
|
17
|
-
- [moduleName](ExtensionInfo.md#modulename)
|
|
18
|
-
- [name](ExtensionInfo.md#name)
|
|
19
|
-
- [offline](ExtensionInfo.md#offline)
|
|
20
|
-
- [online](ExtensionInfo.md#online)
|
|
21
|
-
- [order](ExtensionInfo.md#order)
|
|
22
|
-
|
|
23
|
-
### Methods
|
|
24
|
-
|
|
25
|
-
- [load](ExtensionInfo.md#load)
|
|
26
|
-
|
|
27
|
-
## Properties
|
|
28
|
-
|
|
29
|
-
### instances
|
|
30
|
-
|
|
31
|
-
• **instances**: `Record`<`string`, `Record`<`string`, [`ExtensionInstance`](ExtensionInstance.md)\>\>
|
|
32
|
-
|
|
33
|
-
The instances where the extension has been rendered using `renderExtension`,
|
|
34
|
-
indexed by slotModuleName and slotName.
|
|
35
|
-
|
|
36
|
-
#### Defined in
|
|
37
|
-
|
|
38
|
-
[store.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L27)
|
|
39
|
-
|
|
40
|
-
___
|
|
41
|
-
|
|
42
|
-
### meta
|
|
43
|
-
|
|
44
|
-
• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
|
|
45
|
-
|
|
46
|
-
#### Inherited from
|
|
47
|
-
|
|
48
|
-
[ExtensionRegistration](ExtensionRegistration.md).[meta](ExtensionRegistration.md#meta)
|
|
49
|
-
|
|
50
|
-
#### Defined in
|
|
51
|
-
|
|
52
|
-
[store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L16)
|
|
53
|
-
|
|
54
|
-
___
|
|
55
|
-
|
|
56
|
-
### moduleName
|
|
57
|
-
|
|
58
|
-
• **moduleName**: `string`
|
|
59
|
-
|
|
60
|
-
#### Inherited from
|
|
61
|
-
|
|
62
|
-
[ExtensionRegistration](ExtensionRegistration.md).[moduleName](ExtensionRegistration.md#modulename)
|
|
63
|
-
|
|
64
|
-
#### Defined in
|
|
65
|
-
|
|
66
|
-
[store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L15)
|
|
67
|
-
|
|
68
|
-
___
|
|
69
|
-
|
|
70
|
-
### name
|
|
71
|
-
|
|
72
|
-
• **name**: `string`
|
|
73
|
-
|
|
74
|
-
#### Inherited from
|
|
75
|
-
|
|
76
|
-
[ExtensionRegistration](ExtensionRegistration.md).[name](ExtensionRegistration.md#name)
|
|
77
|
-
|
|
78
|
-
#### Defined in
|
|
79
|
-
|
|
80
|
-
[store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L13)
|
|
81
|
-
|
|
82
|
-
___
|
|
83
|
-
|
|
84
|
-
### offline
|
|
85
|
-
|
|
86
|
-
• `Optional` **offline**: `boolean` \| `object`
|
|
87
|
-
|
|
88
|
-
#### Inherited from
|
|
89
|
-
|
|
90
|
-
[ExtensionRegistration](ExtensionRegistration.md).[offline](ExtensionRegistration.md#offline)
|
|
91
|
-
|
|
92
|
-
#### Defined in
|
|
93
|
-
|
|
94
|
-
[store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
|
|
95
|
-
|
|
96
|
-
___
|
|
97
|
-
|
|
98
|
-
### online
|
|
99
|
-
|
|
100
|
-
• `Optional` **online**: `boolean` \| `object`
|
|
101
|
-
|
|
102
|
-
#### Inherited from
|
|
103
|
-
|
|
104
|
-
[ExtensionRegistration](ExtensionRegistration.md).[online](ExtensionRegistration.md#online)
|
|
105
|
-
|
|
106
|
-
#### Defined in
|
|
107
|
-
|
|
108
|
-
[store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L18)
|
|
109
|
-
|
|
110
|
-
___
|
|
111
|
-
|
|
112
|
-
### order
|
|
113
|
-
|
|
114
|
-
• `Optional` **order**: `number`
|
|
115
|
-
|
|
116
|
-
#### Inherited from
|
|
117
|
-
|
|
118
|
-
[ExtensionRegistration](ExtensionRegistration.md).[order](ExtensionRegistration.md#order)
|
|
119
|
-
|
|
120
|
-
#### Defined in
|
|
121
|
-
|
|
122
|
-
[store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L17)
|
|
123
|
-
|
|
124
|
-
## Methods
|
|
125
|
-
|
|
126
|
-
### load
|
|
127
|
-
|
|
128
|
-
▸ **load**(): `Promise`<`any`\>
|
|
129
|
-
|
|
130
|
-
#### Returns
|
|
131
|
-
|
|
132
|
-
`Promise`<`any`\>
|
|
133
|
-
|
|
134
|
-
#### Inherited from
|
|
135
|
-
|
|
136
|
-
[ExtensionRegistration](ExtensionRegistration.md).[load](ExtensionRegistration.md#load)
|
|
137
|
-
|
|
138
|
-
#### Defined in
|
|
139
|
-
|
|
140
|
-
[store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / ExtensionInstance
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionInstance
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [id](ExtensionInstance.md#id)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### id
|
|
14
|
-
|
|
15
|
-
• **id**: `string`
|
|
16
|
-
|
|
17
|
-
#### Defined in
|
|
18
|
-
|
|
19
|
-
[store.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L31)
|
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / ExtensionRegistration
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionRegistration
|
|
4
|
-
|
|
5
|
-
## Hierarchy
|
|
6
|
-
|
|
7
|
-
- **`ExtensionRegistration`**
|
|
8
|
-
|
|
9
|
-
↳ [`ExtensionInfo`](ExtensionInfo.md)
|
|
10
|
-
|
|
11
|
-
## Table of contents
|
|
12
|
-
|
|
13
|
-
### Properties
|
|
14
|
-
|
|
15
|
-
- [meta](ExtensionRegistration.md#meta)
|
|
16
|
-
- [moduleName](ExtensionRegistration.md#modulename)
|
|
17
|
-
- [name](ExtensionRegistration.md#name)
|
|
18
|
-
- [offline](ExtensionRegistration.md#offline)
|
|
19
|
-
- [online](ExtensionRegistration.md#online)
|
|
20
|
-
- [order](ExtensionRegistration.md#order)
|
|
21
|
-
|
|
22
|
-
### Methods
|
|
23
|
-
|
|
24
|
-
- [load](ExtensionRegistration.md#load)
|
|
25
|
-
|
|
26
|
-
## Properties
|
|
27
|
-
|
|
28
|
-
### meta
|
|
29
|
-
|
|
30
|
-
• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
|
|
31
|
-
|
|
32
|
-
#### Defined in
|
|
33
|
-
|
|
34
|
-
[store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L16)
|
|
35
|
-
|
|
36
|
-
___
|
|
37
|
-
|
|
38
|
-
### moduleName
|
|
39
|
-
|
|
40
|
-
• **moduleName**: `string`
|
|
41
|
-
|
|
42
|
-
#### Defined in
|
|
43
|
-
|
|
44
|
-
[store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L15)
|
|
45
|
-
|
|
46
|
-
___
|
|
47
|
-
|
|
48
|
-
### name
|
|
49
|
-
|
|
50
|
-
• **name**: `string`
|
|
51
|
-
|
|
52
|
-
#### Defined in
|
|
53
|
-
|
|
54
|
-
[store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L13)
|
|
55
|
-
|
|
56
|
-
___
|
|
57
|
-
|
|
58
|
-
### offline
|
|
59
|
-
|
|
60
|
-
• `Optional` **offline**: `boolean` \| `object`
|
|
61
|
-
|
|
62
|
-
#### Defined in
|
|
63
|
-
|
|
64
|
-
[store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
|
|
65
|
-
|
|
66
|
-
___
|
|
67
|
-
|
|
68
|
-
### online
|
|
69
|
-
|
|
70
|
-
• `Optional` **online**: `boolean` \| `object`
|
|
71
|
-
|
|
72
|
-
#### Defined in
|
|
73
|
-
|
|
74
|
-
[store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L18)
|
|
75
|
-
|
|
76
|
-
___
|
|
77
|
-
|
|
78
|
-
### order
|
|
79
|
-
|
|
80
|
-
• `Optional` **order**: `number`
|
|
81
|
-
|
|
82
|
-
#### Defined in
|
|
83
|
-
|
|
84
|
-
[store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L17)
|
|
85
|
-
|
|
86
|
-
## Methods
|
|
87
|
-
|
|
88
|
-
### load
|
|
89
|
-
|
|
90
|
-
▸ **load**(): `Promise`<`any`\>
|
|
91
|
-
|
|
92
|
-
#### Returns
|
|
93
|
-
|
|
94
|
-
`Promise`<`any`\>
|
|
95
|
-
|
|
96
|
-
#### Defined in
|
|
97
|
-
|
|
98
|
-
[store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / ExtensionSlotInfo
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionSlotInfo
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [attachedIds](ExtensionSlotInfo.md#attachedids)
|
|
10
|
-
- [instances](ExtensionSlotInfo.md#instances)
|
|
11
|
-
- [name](ExtensionSlotInfo.md#name)
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### attachedIds
|
|
16
|
-
|
|
17
|
-
• **attachedIds**: `string`[]
|
|
18
|
-
|
|
19
|
-
The set of extension IDs which have been attached to this slot.
|
|
20
|
-
This is essentially a complete history of `attach` calls to this specific slot.
|
|
21
|
-
However, not all of these extension IDs should be rendered.
|
|
22
|
-
`assignedIds` is the set defining those.
|
|
23
|
-
|
|
24
|
-
#### Defined in
|
|
25
|
-
|
|
26
|
-
[store.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L75)
|
|
27
|
-
|
|
28
|
-
___
|
|
29
|
-
|
|
30
|
-
### instances
|
|
31
|
-
|
|
32
|
-
• **instances**: `Record`<`string`, [`ExtensionSlotInstance`](ExtensionSlotInstance.md)\>
|
|
33
|
-
|
|
34
|
-
The mapping of modules / extension slot instances where the extension slot has been used.
|
|
35
|
-
|
|
36
|
-
#### Defined in
|
|
37
|
-
|
|
38
|
-
[store.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L68)
|
|
39
|
-
|
|
40
|
-
___
|
|
41
|
-
|
|
42
|
-
### name
|
|
43
|
-
|
|
44
|
-
• **name**: `string`
|
|
45
|
-
|
|
46
|
-
The name under which the extension slot has been registered.
|
|
47
|
-
|
|
48
|
-
#### Defined in
|
|
49
|
-
|
|
50
|
-
[store.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L64)
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / ExtensionSlotInstance
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionSlotInstance
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [addedIds](ExtensionSlotInstance.md#addedids)
|
|
10
|
-
- [idOrder](ExtensionSlotInstance.md#idorder)
|
|
11
|
-
- [removedIds](ExtensionSlotInstance.md#removedids)
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### addedIds
|
|
16
|
-
|
|
17
|
-
• **addedIds**: `string`[]
|
|
18
|
-
|
|
19
|
-
A set of additional extension IDs which have been added to to this slot despite not being
|
|
20
|
-
explicitly `attach`ed to it.
|
|
21
|
-
An example may be an extension which is added to the slot via the configuration.
|
|
22
|
-
|
|
23
|
-
#### Defined in
|
|
24
|
-
|
|
25
|
-
[store.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L47)
|
|
26
|
-
|
|
27
|
-
___
|
|
28
|
-
|
|
29
|
-
### idOrder
|
|
30
|
-
|
|
31
|
-
• **idOrder**: `string`[]
|
|
32
|
-
|
|
33
|
-
A set allowing explicit ordering of the `assignedIds`.
|
|
34
|
-
|
|
35
|
-
#### Defined in
|
|
36
|
-
|
|
37
|
-
[store.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L57)
|
|
38
|
-
|
|
39
|
-
___
|
|
40
|
-
|
|
41
|
-
### removedIds
|
|
42
|
-
|
|
43
|
-
• **removedIds**: `string`[]
|
|
44
|
-
|
|
45
|
-
A set of extension IDs which have been removed/hidden from this slot, even though they have
|
|
46
|
-
previously been `attach`ed/added to it.
|
|
47
|
-
An example may be an extension which is removed from the slot via the configuration.
|
|
48
|
-
|
|
49
|
-
#### Defined in
|
|
50
|
-
|
|
51
|
-
[store.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L53)
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / ExtensionStore
|
|
2
|
-
|
|
3
|
-
# Interface: ExtensionStore
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [extensions](ExtensionStore.md#extensions)
|
|
10
|
-
- [slots](ExtensionStore.md#slots)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### extensions
|
|
15
|
-
|
|
16
|
-
• **extensions**: `Record`<`string`, [`ExtensionInfo`](ExtensionInfo.md)\>
|
|
17
|
-
|
|
18
|
-
Extensions indexed by name
|
|
19
|
-
|
|
20
|
-
#### Defined in
|
|
21
|
-
|
|
22
|
-
[store.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L38)
|
|
23
|
-
|
|
24
|
-
___
|
|
25
|
-
|
|
26
|
-
### slots
|
|
27
|
-
|
|
28
|
-
• **slots**: `Record`<`string`, [`ExtensionSlotInfo`](ExtensionSlotInfo.md)\>
|
|
29
|
-
|
|
30
|
-
Slots indexed by name
|
|
31
|
-
|
|
32
|
-
#### Defined in
|
|
33
|
-
|
|
34
|
-
[store.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L36)
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / Lifecycle
|
|
2
|
-
|
|
3
|
-
# Interface: Lifecycle
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Methods
|
|
8
|
-
|
|
9
|
-
- [bootstrap](Lifecycle.md#bootstrap)
|
|
10
|
-
- [mount](Lifecycle.md#mount)
|
|
11
|
-
- [unmount](Lifecycle.md#unmount)
|
|
12
|
-
- [update](Lifecycle.md#update)
|
|
13
|
-
|
|
14
|
-
## Methods
|
|
15
|
-
|
|
16
|
-
### bootstrap
|
|
17
|
-
|
|
18
|
-
▸ **bootstrap**(): `void`
|
|
19
|
-
|
|
20
|
-
#### Returns
|
|
21
|
-
|
|
22
|
-
`void`
|
|
23
|
-
|
|
24
|
-
#### Defined in
|
|
25
|
-
|
|
26
|
-
[render.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L8)
|
|
27
|
-
|
|
28
|
-
___
|
|
29
|
-
|
|
30
|
-
### mount
|
|
31
|
-
|
|
32
|
-
▸ **mount**(): `void`
|
|
33
|
-
|
|
34
|
-
#### Returns
|
|
35
|
-
|
|
36
|
-
`void`
|
|
37
|
-
|
|
38
|
-
#### Defined in
|
|
39
|
-
|
|
40
|
-
[render.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L9)
|
|
41
|
-
|
|
42
|
-
___
|
|
43
|
-
|
|
44
|
-
### unmount
|
|
45
|
-
|
|
46
|
-
▸ **unmount**(): `void`
|
|
47
|
-
|
|
48
|
-
#### Returns
|
|
49
|
-
|
|
50
|
-
`void`
|
|
51
|
-
|
|
52
|
-
#### Defined in
|
|
53
|
-
|
|
54
|
-
[render.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L10)
|
|
55
|
-
|
|
56
|
-
___
|
|
57
|
-
|
|
58
|
-
### update
|
|
59
|
-
|
|
60
|
-
▸ `Optional` **update**(): `void`
|
|
61
|
-
|
|
62
|
-
#### Returns
|
|
63
|
-
|
|
64
|
-
`void`
|
|
65
|
-
|
|
66
|
-
#### Defined in
|
|
67
|
-
|
|
68
|
-
[render.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L11)
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-extensions](../API.md) / NavigationContext
|
|
2
|
-
|
|
3
|
-
# Interface: NavigationContext
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [type](NavigationContext.md#type)
|
|
10
|
-
|
|
11
|
-
### Methods
|
|
12
|
-
|
|
13
|
-
- [handler](NavigationContext.md#handler)
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
### type
|
|
18
|
-
|
|
19
|
-
• **type**: [`NavigationContextType`](../API.md#navigationcontexttype)
|
|
20
|
-
|
|
21
|
-
#### Defined in
|
|
22
|
-
|
|
23
|
-
[contexts.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L6)
|
|
24
|
-
|
|
25
|
-
## Methods
|
|
26
|
-
|
|
27
|
-
### handler
|
|
28
|
-
|
|
29
|
-
▸ **handler**<`T`\>(`link`, `state`): `boolean`
|
|
30
|
-
|
|
31
|
-
#### Type parameters
|
|
32
|
-
|
|
33
|
-
| Name | Type |
|
|
34
|
-
| :------ | :------ |
|
|
35
|
-
| `T` | `any` |
|
|
36
|
-
|
|
37
|
-
#### Parameters
|
|
38
|
-
|
|
39
|
-
| Name | Type |
|
|
40
|
-
| :------ | :------ |
|
|
41
|
-
| `link` | `string` |
|
|
42
|
-
| `state` | `T` |
|
|
43
|
-
|
|
44
|
-
#### Returns
|
|
45
|
-
|
|
46
|
-
`boolean`
|
|
47
|
-
|
|
48
|
-
#### Defined in
|
|
49
|
-
|
|
50
|
-
[contexts.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L7)
|