@openmrs/esm-framework 10.0.1-pre.5045 → 10.0.1-pre.5066
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +1 -1
- package/docs/functions/compile.md +1 -1
- package/docs/functions/evaluate.md +1 -1
- package/docs/functions/evaluateAsBoolean.md +1 -1
- package/docs/functions/evaluateAsBooleanAsync.md +1 -1
- package/docs/functions/evaluateAsNumber.md +1 -1
- package/docs/functions/evaluateAsNumberAsync.md +1 -1
- package/docs/functions/evaluateAsType.md +1 -1
- package/docs/functions/evaluateAsTypeAsync.md +1 -1
- package/docs/functions/evaluateAsync.md +1 -1
- package/docs/functions/subscribeActionableNotificationShown.md +1 -1
- package/docs/functions/subscribeNotificationShown.md +1 -1
- package/docs/functions/subscribePrecacheStaticDependencies.md +1 -1
- package/docs/functions/subscribeSnackbarShown.md +1 -1
- package/docs/functions/subscribeToastShown.md +1 -1
- package/docs/interfaces/ClearDynamicRoutesMessage.md +1 -1
- package/docs/interfaces/FeatureFlagDefinition.md +4 -4
- package/docs/interfaces/ImportMap.md +2 -2
- package/docs/interfaces/MessageServiceWorkerResult.md +4 -4
- package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +1 -1
- package/docs/interfaces/RegisterDynamicRouteMessage.md +4 -4
- package/docs/interfaces/ResourceLoader.md +2 -2
- package/docs/interfaces/ShowActionableNotificationEvent.md +7 -7
- package/docs/interfaces/ShowNotificationEvent.md +6 -6
- package/docs/interfaces/ShowSnackbarEvent.md +9 -9
- package/docs/interfaces/ShowToastEvent.md +6 -6
- package/docs/interfaces/SpaConfig.md +6 -6
- package/docs/interfaces/User.md +1 -1
- package/docs/interfaces/WorkspaceDefinition2.md +4 -4
- package/docs/interfaces/WorkspaceGroupDefinition.md +3 -3
- package/docs/interfaces/WorkspaceGroupDefinition2.md +6 -6
- package/docs/interfaces/WorkspaceWindowDefinition2.md +7 -7
- package/docs/type-aliases/DefaultEvaluateReturnType.md +1 -1
- package/docs/type-aliases/ExtensionDefinition.md +12 -12
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +1 -1
- package/docs/type-aliases/ModalDefinition.md +3 -3
- package/docs/type-aliases/NameUse.md +1 -1
- package/docs/type-aliases/OpenmrsRoutes.md +1 -1
- package/docs/type-aliases/PageDefinition.md +1 -1
- package/docs/type-aliases/SpaEnvironment.md +1 -1
- package/docs/type-aliases/WorkspaceDefinition.md +10 -10
- package/docs/type-aliases/WorkspaceWindowState.md +1 -1
- package/package.json +21 -21
- package/src/integration-tests/extension-config-expressions.test.tsx +1 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ShowToastEvent
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L63)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:64](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **actionButtonLabel**: `any`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L67)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:68](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> **description**: `any`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L64)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:65](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L65)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:66](https://github.com
|
|
|
34
34
|
|
|
35
35
|
> `optional` **onActionButtonClick**: () => `void`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L68)
|
|
38
38
|
|
|
39
39
|
#### Returns
|
|
40
40
|
|
|
@@ -46,4 +46,4 @@ Defined in: [packages/framework/esm-globals/src/events.ts:69](https://github.com
|
|
|
46
46
|
|
|
47
47
|
> `optional` **title**: `string`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
49
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L66)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: SpaConfig
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L67)
|
|
6
6
|
|
|
7
7
|
The configuration passed to the app shell initialization function
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ The configuration passed to the app shell initialization function
|
|
|
12
12
|
|
|
13
13
|
> **apiUrl**: `string`
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L71)
|
|
16
16
|
|
|
17
17
|
The base path or URL for the OpenMRS API / endpoints.
|
|
18
18
|
|
|
@@ -22,7 +22,7 @@ The base path or URL for the OpenMRS API / endpoints.
|
|
|
22
22
|
|
|
23
23
|
> `optional` **configUrls**: `string`[]
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
25
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L84)
|
|
26
26
|
|
|
27
27
|
URLs of configurations to load in the system.
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ URLs of configurations to load in the system.
|
|
|
32
32
|
|
|
33
33
|
> `optional` **env**: [`SpaEnvironment`](../type-aliases/SpaEnvironment.md)
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
35
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L80)
|
|
36
36
|
|
|
37
37
|
The environment to use.
|
|
38
38
|
|
|
@@ -48,7 +48,7 @@ production
|
|
|
48
48
|
|
|
49
49
|
> `optional` **offline**: `boolean`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
51
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L89)
|
|
52
52
|
|
|
53
53
|
Defines if offline should be supported by installing a service worker.
|
|
54
54
|
|
|
@@ -64,6 +64,6 @@ true
|
|
|
64
64
|
|
|
65
65
|
> **spaPath**: `string`
|
|
66
66
|
|
|
67
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
67
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L75)
|
|
68
68
|
|
|
69
69
|
The base path for the SPA root path.
|
package/docs/interfaces/User.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: User
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-api/src/types/user-resource.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-api/src/types/user-resource.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L69)
|
|
6
6
|
|
|
7
7
|
Superclass for all Openmrs Resources, with strict typings.
|
|
8
8
|
If the subclass does not have all attributes (including optional ones)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WorkspaceDefinition2
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:337](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L337)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:338](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> **component**: `string`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:339](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L339)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:340](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> **name**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:338](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L338)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,4 +26,4 @@ Defined in: [packages/framework/esm-globals/src/types.ts:339](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> **window**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:340](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L340)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WorkspaceGroupDefinition
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:289](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L289)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:290](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **members**: `string`[]
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:297](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L297)
|
|
14
14
|
|
|
15
15
|
List of workspace names which are part of the workspace group.
|
|
16
16
|
|
|
@@ -20,6 +20,6 @@ List of workspace names which are part of the workspace group.
|
|
|
20
20
|
|
|
21
21
|
> **name**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
23
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:293](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L293)
|
|
24
24
|
|
|
25
25
|
Name of the workspace group. This is used to launch the workspace group
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WorkspaceGroupDefinition2
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:300](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L300)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:301](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **closeable**: `boolean`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:302](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L302)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:303](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> **name**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:301](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L301)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:302](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> `optional` **overlay**: `boolean`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:303](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L303)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:304](https://github.com
|
|
|
34
34
|
|
|
35
35
|
> `optional` **persistence**: `"app-wide"` \| `"closable"`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:314](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L314)
|
|
38
38
|
|
|
39
39
|
In app-wide persistence mode, a workspace group renders its
|
|
40
40
|
action menu without a close button. This is for
|
|
@@ -50,7 +50,7 @@ with any opened windows / workspaces.
|
|
|
50
50
|
|
|
51
51
|
> `optional` **scopePattern**: `string`
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
53
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:325](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L325)
|
|
54
54
|
|
|
55
55
|
URL pattern that defines the scope where workspaces in this group should persist.
|
|
56
56
|
- If not defined: workspaces close only when navigating to a different app
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WorkspaceWindowDefinition2
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:328](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L328)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:329](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **canMaximize**: `boolean`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:331](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L331)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:332](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> **group**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:332](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L332)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:333](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> `optional` **icon**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:330](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L330)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:331](https://github.com
|
|
|
34
34
|
|
|
35
35
|
> **name**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:329](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L329)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:330](https://github.com
|
|
|
42
42
|
|
|
43
43
|
> `optional` **order**: `number`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
45
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:333](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L333)
|
|
46
46
|
|
|
47
47
|
***
|
|
48
48
|
|
|
@@ -50,4 +50,4 @@ Defined in: [packages/framework/esm-globals/src/types.ts:334](https://github.com
|
|
|
50
50
|
|
|
51
51
|
> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
53
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:334](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L334)
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
> **DefaultEvaluateReturnType** = `string` \| `number` \| `boolean` \| `Date` \| `null` \| `undefined`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-expression-evaluator/src/evaluator.ts#L31)
|
|
8
8
|
|
|
9
9
|
The valid return types for `evaluate()` and `evaluateAsync()`
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ExtensionDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:164](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L164)
|
|
8
8
|
|
|
9
9
|
A definition of an extension as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of an extension as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> **component**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:210](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L210)
|
|
18
18
|
|
|
19
19
|
The name of the component exported by this frontend module.
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ The name of the component exported by this frontend module.
|
|
|
24
24
|
|
|
25
25
|
> `optional` **displayExpression**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
27
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:196](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L196)
|
|
28
28
|
|
|
29
29
|
The expression that determines whether the extension is displayed.
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ The expression that determines whether the extension is displayed.
|
|
|
34
34
|
|
|
35
35
|
> `optional` **featureFlag**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:200](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L200)
|
|
38
38
|
|
|
39
39
|
If supplied, the extension will only be rendered when this feature flag is enabled.
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ If supplied, the extension will only be rendered when this feature flag is enabl
|
|
|
44
44
|
|
|
45
45
|
> `optional` **meta**: `object`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
47
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:204](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L204)
|
|
48
48
|
|
|
49
49
|
Meta describes any properties that are passed down to the extension when it is loaded
|
|
50
50
|
|
|
@@ -58,7 +58,7 @@ Meta describes any properties that are passed down to the extension when it is l
|
|
|
58
58
|
|
|
59
59
|
> **name**: `string`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
61
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:168](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L168)
|
|
62
62
|
|
|
63
63
|
The name of this extension. This is used to refer to the extension in configuration.
|
|
64
64
|
|
|
@@ -68,7 +68,7 @@ The name of this extension. This is used to refer to the extension in configurat
|
|
|
68
68
|
|
|
69
69
|
> `optional` **offline**: `boolean`
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
71
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L184)
|
|
72
72
|
|
|
73
73
|
Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ Determines whether the component renders while the browser is not connected to t
|
|
|
78
78
|
|
|
79
79
|
> `optional` **online**: `boolean`
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
81
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:180](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L180)
|
|
82
82
|
|
|
83
83
|
Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ Determines whether the component renders while the browser is connected to the i
|
|
|
88
88
|
|
|
89
89
|
> `optional` **order**: `number`
|
|
90
90
|
|
|
91
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
91
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:188](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L188)
|
|
92
92
|
|
|
93
93
|
Determines the order in which this component renders in its default extension slot. Note that this can be overridden by configuration.
|
|
94
94
|
|
|
@@ -98,7 +98,7 @@ Determines the order in which this component renders in its default extension sl
|
|
|
98
98
|
|
|
99
99
|
> `optional` **privileges**: `string` \| `string`[]
|
|
100
100
|
|
|
101
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
101
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:192](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L192)
|
|
102
102
|
|
|
103
103
|
The user must have ANY of these privileges to see this extension.
|
|
104
104
|
|
|
@@ -108,7 +108,7 @@ The user must have ANY of these privileges to see this extension.
|
|
|
108
108
|
|
|
109
109
|
> `optional` **slot**: `string`
|
|
110
110
|
|
|
111
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
111
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:172](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L172)
|
|
112
112
|
|
|
113
113
|
If supplied, the slot that this extension is rendered into by default.
|
|
114
114
|
|
|
@@ -118,6 +118,6 @@ If supplied, the slot that this extension is rendered into by default.
|
|
|
118
118
|
|
|
119
119
|
> `optional` **slots**: `string`[]
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
121
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:176](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L176)
|
|
122
122
|
|
|
123
123
|
If supplied, the slots that this extension is rendered into by default.
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **KnownOmrsServiceWorkerMessages** = [`OnImportMapChangedMessage`](../interfaces/OnImportMapChangedMessage.md) \| [`ClearDynamicRoutesMessage`](../interfaces/ClearDynamicRoutesMessage.md) \| [`RegisterDynamicRouteMessage`](../interfaces/RegisterDynamicRouteMessage.md)
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L41)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ModalDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:216](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L216)
|
|
8
8
|
|
|
9
9
|
A definition of a modal as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of a modal as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> **component**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:224](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L224)
|
|
18
18
|
|
|
19
19
|
The name of the component exported by this frontend module.
|
|
20
20
|
|
|
@@ -24,6 +24,6 @@ The name of the component exported by this frontend module.
|
|
|
24
24
|
|
|
25
25
|
> **name**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
27
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L220)
|
|
28
28
|
|
|
29
29
|
The name of this modal. This is used to launch the modal.
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:409](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L409)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **OpenmrsRoutes** = `Record`\<`string`, [`OpenmrsAppRoutes`](../interfaces/OpenmrsAppRoutes.md)\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:400](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L400)
|
|
8
8
|
|
|
9
9
|
This interfaces describes the format of the overall routes.json loaded by the app shell.
|
|
10
10
|
Basically, this is the same as the app routes, with each routes definition keyed by the app's name
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **PageDefinition** = `object` & \{ `route`: `string` \| `boolean`; `routeRegex?`: `never`; \} \| \{ `route?`: `never`; `routeRegex`: `string`; \}
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L103)
|
|
8
8
|
|
|
9
9
|
A definition of a page extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **SpaEnvironment** = `"production"` \| `"development"` \| `"test"`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L58)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **WorkspaceDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:233](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L233)
|
|
8
8
|
|
|
9
9
|
A definition of a workspace as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of a workspace as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> `optional` **canHide**: `boolean`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:249](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L249)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:250](https://github.com
|
|
|
22
22
|
|
|
23
23
|
> `optional` **canMaximize**: `boolean`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
25
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:250](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L250)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:251](https://github.com
|
|
|
30
30
|
|
|
31
31
|
> **component**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
33
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:286](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L286)
|
|
34
34
|
|
|
35
35
|
The name of the component exported by this frontend module.
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ The name of the component exported by this frontend module.
|
|
|
40
40
|
|
|
41
41
|
> **groups**: `string`[]
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
43
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:282](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L282)
|
|
44
44
|
|
|
45
45
|
Workspaces can open either independently or as part of a "workspace group". A
|
|
46
46
|
"workspace group" groups related workspaces together, so that only one is visible
|
|
@@ -68,7 +68,7 @@ name, the entire workspace group will close, and the new workspace will launch i
|
|
|
68
68
|
|
|
69
69
|
> **name**: `string`
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
71
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:237](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L237)
|
|
72
72
|
|
|
73
73
|
The name of this workspace. This is used to launch the workspace.
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ The name of this workspace. This is used to launch the workspace.
|
|
|
78
78
|
|
|
79
79
|
> `optional` **preferredWindowSize**: [`WorkspaceWindowState`](WorkspaceWindowState.md)
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
81
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:260](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L260)
|
|
82
82
|
|
|
83
83
|
Launches the workspace in the preferred size, it defaults to the 'narrow' width
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ Launches the workspace in the preferred size, it defaults to the 'narrow' width
|
|
|
88
88
|
|
|
89
89
|
> **title**: `string`
|
|
90
90
|
|
|
91
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
91
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:242](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L242)
|
|
92
92
|
|
|
93
93
|
The title of the workspace. This will be looked up as a key in the translations of the module
|
|
94
94
|
defining the workspace.
|
|
@@ -99,7 +99,7 @@ defining the workspace.
|
|
|
99
99
|
|
|
100
100
|
> **type**: `string`
|
|
101
101
|
|
|
102
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
102
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:248](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L248)
|
|
103
103
|
|
|
104
104
|
The type of the workspace. Only one of each "type" of workspace is allowed to be open at a
|
|
105
105
|
time. The default is "form". If the right sidebar is in use, then the type determines which
|
|
@@ -111,7 +111,7 @@ right sidebar icon corresponds to the workspace.
|
|
|
111
111
|
|
|
112
112
|
> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
|
|
113
113
|
|
|
114
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
114
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:256](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L256)
|
|
115
115
|
|
|
116
116
|
Controls the width of the workspace. The default is "narrow" and this should only be
|
|
117
117
|
changed to "wider" if the workspace itself has internal navigation, like the form editor.
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **WorkspaceWindowState** = `"maximized"` \| `"hidden"` \| `"normal"`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L228)
|