@openmrs/esm-framework 5.7.2 → 5.7.3-pre.2113
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 +6 -6
- package/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +12 -24
- package/docs/interfaces/CloseWorkspaceOptions.md +6 -6
- package/docs/interfaces/DefaultWorkspaceProps.md +4 -4
- package/docs/interfaces/FeatureFlagDefinition.md +11 -3
- package/docs/interfaces/OpenWorkspace.md +54 -54
- package/docs/interfaces/OpenmrsAppRoutes.md +20 -7
- package/docs/interfaces/Prompt.md +5 -5
- package/docs/interfaces/ResourceLoader.md +1 -1
- package/docs/interfaces/WorkspaceRegistration.md +16 -16
- package/docs/interfaces/WorkspacesInfo.md +4 -4
- package/package.json +19 -18
package/docs/API.md
CHANGED
|
@@ -541,7 +541,7 @@ A definition of an extension as extracted from an app's routes.json
|
|
|
541
541
|
|
|
542
542
|
#### Defined in
|
|
543
543
|
|
|
544
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
544
|
+
[packages/framework/esm-globals/src/types.ts:182](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L182)
|
|
545
545
|
|
|
546
546
|
___
|
|
547
547
|
|
|
@@ -571,7 +571,7 @@ A definition of a modal as extracted from an app's routes.json
|
|
|
571
571
|
|
|
572
572
|
#### Defined in
|
|
573
573
|
|
|
574
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
574
|
+
[packages/framework/esm-globals/src/types.ts:247](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L247)
|
|
575
575
|
|
|
576
576
|
___
|
|
577
577
|
|
|
@@ -581,7 +581,7 @@ ___
|
|
|
581
581
|
|
|
582
582
|
#### Defined in
|
|
583
583
|
|
|
584
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
584
|
+
[packages/framework/esm-globals/src/types.ts:396](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L396)
|
|
585
585
|
|
|
586
586
|
___
|
|
587
587
|
|
|
@@ -594,13 +594,13 @@ Basically, this is the same as the app routes, with each routes definition keyed
|
|
|
594
594
|
|
|
595
595
|
#### Defined in
|
|
596
596
|
|
|
597
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
597
|
+
[packages/framework/esm-globals/src/types.ts:387](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L387)
|
|
598
598
|
|
|
599
599
|
___
|
|
600
600
|
|
|
601
601
|
### PageDefinition
|
|
602
602
|
|
|
603
|
-
Ƭ **PageDefinition**: { `component`: `string` ; `offline?`: `boolean` ; `online?`: `boolean` ; `order?`: `number` } & { `route`: `string` \| `boolean` ; `routeRegex?`: `never` } \| { `route?`: `never` ; `routeRegex`: `string` }
|
|
603
|
+
Ƭ **PageDefinition**: { `component`: `string` ; `featureFlag?`: `string` ; `offline?`: `boolean` ; `online?`: `boolean` ; `order?`: `number` } & { `route`: `string` \| `boolean` ; `routeRegex?`: `never` } \| { `route?`: `never` ; `routeRegex`: `string` }
|
|
604
604
|
|
|
605
605
|
A definition of a page extracted from an app's routes.json
|
|
606
606
|
|
|
@@ -644,18 +644,6 @@ ___
|
|
|
644
644
|
|
|
645
645
|
___
|
|
646
646
|
|
|
647
|
-
### RegisteredPageDefinition
|
|
648
|
-
|
|
649
|
-
Ƭ **RegisteredPageDefinition**: `Omit`<[`PageDefinition`](API.md#pagedefinition), ``"order"``\> & `AppComponent` & { `order`: `number` }
|
|
650
|
-
|
|
651
|
-
A definition of a page after the app has been registered.
|
|
652
|
-
|
|
653
|
-
#### Defined in
|
|
654
|
-
|
|
655
|
-
[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)
|
|
656
|
-
|
|
657
|
-
___
|
|
658
|
-
|
|
659
647
|
### SpaEnvironment
|
|
660
648
|
|
|
661
649
|
Ƭ **SpaEnvironment**: ``"production"`` \| ``"development"`` \| ``"test"``
|
|
@@ -766,7 +754,7 @@ A definition of a workspace as extracted from an app's routes.json
|
|
|
766
754
|
|
|
767
755
|
#### Defined in
|
|
768
756
|
|
|
769
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
757
|
+
[packages/framework/esm-globals/src/types.ts:281](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L281)
|
|
770
758
|
|
|
771
759
|
___
|
|
772
760
|
|
|
@@ -776,7 +764,7 @@ ___
|
|
|
776
764
|
|
|
777
765
|
#### Defined in
|
|
778
766
|
|
|
779
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
767
|
+
[packages/framework/esm-globals/src/types.ts:276](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L276)
|
|
780
768
|
|
|
781
769
|
___
|
|
782
770
|
|
|
@@ -6203,7 +6191,7 @@ The dispose function to force closing the modal dialog.
|
|
|
6203
6191
|
|
|
6204
6192
|
#### Defined in
|
|
6205
6193
|
|
|
6206
|
-
[packages/framework/esm-styleguide/src/modals/index.tsx:
|
|
6194
|
+
[packages/framework/esm-styleguide/src/modals/index.tsx:207](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L207)
|
|
6207
6195
|
|
|
6208
6196
|
___
|
|
6209
6197
|
|
|
@@ -7043,7 +7031,7 @@ Function to close an opened workspace
|
|
|
7043
7031
|
|
|
7044
7032
|
#### Defined in
|
|
7045
7033
|
|
|
7046
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
7034
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:282](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L282)
|
|
7047
7035
|
|
|
7048
7036
|
___
|
|
7049
7037
|
|
|
@@ -7094,7 +7082,7 @@ prop named `workspaceTitle` will override the title of the workspace.
|
|
|
7094
7082
|
|
|
7095
7083
|
#### Defined in
|
|
7096
7084
|
|
|
7097
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
7085
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:165](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L165)
|
|
7098
7086
|
|
|
7099
7087
|
___
|
|
7100
7088
|
|
|
@@ -7120,7 +7108,7 @@ Use this function to navigate to a new page and launch a workspace on that page.
|
|
|
7120
7108
|
|
|
7121
7109
|
#### Defined in
|
|
7122
7110
|
|
|
7123
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
7111
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:245](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L245)
|
|
7124
7112
|
|
|
7125
7113
|
___
|
|
7126
7114
|
|
|
@@ -7134,4 +7122,4 @@ ___
|
|
|
7134
7122
|
|
|
7135
7123
|
#### Defined in
|
|
7136
7124
|
|
|
7137
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
7125
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:384](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L384)
|
|
@@ -4,15 +4,15 @@
|
|
|
4
4
|
|
|
5
5
|
## Table of contents
|
|
6
6
|
|
|
7
|
-
### Properties
|
|
7
|
+
### Workspace Properties
|
|
8
8
|
|
|
9
9
|
- [ignoreChanges](CloseWorkspaceOptions.md#ignorechanges)
|
|
10
10
|
|
|
11
|
-
### Methods
|
|
11
|
+
### Workspace Methods
|
|
12
12
|
|
|
13
13
|
- [onWorkspaceClose](CloseWorkspaceOptions.md#onworkspaceclose)
|
|
14
14
|
|
|
15
|
-
## Properties
|
|
15
|
+
## Workspace Properties
|
|
16
16
|
|
|
17
17
|
### ignoreChanges
|
|
18
18
|
|
|
@@ -25,9 +25,9 @@ even if the `testFcn` passed to `promptBeforeClosing` returns `true`.
|
|
|
25
25
|
|
|
26
26
|
#### Defined in
|
|
27
27
|
|
|
28
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
28
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L18)
|
|
29
29
|
|
|
30
|
-
## Methods
|
|
30
|
+
## Workspace Methods
|
|
31
31
|
|
|
32
32
|
### onWorkspaceClose
|
|
33
33
|
|
|
@@ -45,4 +45,4 @@ void
|
|
|
45
45
|
|
|
46
46
|
#### Defined in
|
|
47
47
|
|
|
48
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
48
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L25)
|
|
@@ -43,7 +43,7 @@ closed, given the user forcefully closes the workspace.
|
|
|
43
43
|
|
|
44
44
|
#### Defined in
|
|
45
45
|
|
|
46
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
46
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L37)
|
|
47
47
|
|
|
48
48
|
___
|
|
49
49
|
|
|
@@ -66,7 +66,7 @@ will directly close the workspace without any prompt
|
|
|
66
66
|
|
|
67
67
|
#### Defined in
|
|
68
68
|
|
|
69
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
69
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L47)
|
|
70
70
|
|
|
71
71
|
___
|
|
72
72
|
|
|
@@ -89,7 +89,7 @@ this workspace is closed; e.g. if there is unsaved data.
|
|
|
89
89
|
|
|
90
90
|
#### Defined in
|
|
91
91
|
|
|
92
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
92
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L42)
|
|
93
93
|
|
|
94
94
|
___
|
|
95
95
|
|
|
@@ -117,4 +117,4 @@ title needs to be set dynamically.
|
|
|
117
117
|
|
|
118
118
|
#### Defined in
|
|
119
119
|
|
|
120
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
120
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L62)
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: FeatureFlagDefinition
|
|
4
4
|
|
|
5
|
+
A definition of a feature flag extracted from the routes.json
|
|
6
|
+
|
|
5
7
|
## Table of contents
|
|
6
8
|
|
|
7
9
|
### Properties
|
|
@@ -16,9 +18,11 @@
|
|
|
16
18
|
|
|
17
19
|
• **description**: `string`
|
|
18
20
|
|
|
21
|
+
An explanation of what the flag does, which will be displayed in the Implementer Tools
|
|
22
|
+
|
|
19
23
|
#### Defined in
|
|
20
24
|
|
|
21
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
25
|
+
[packages/framework/esm-globals/src/types.ts:350](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L350)
|
|
22
26
|
|
|
23
27
|
___
|
|
24
28
|
|
|
@@ -26,9 +30,11 @@ ___
|
|
|
26
30
|
|
|
27
31
|
• **flagName**: `string`
|
|
28
32
|
|
|
33
|
+
A code-friendly name for the flag, which will be used to reference it in code
|
|
34
|
+
|
|
29
35
|
#### Defined in
|
|
30
36
|
|
|
31
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
37
|
+
[packages/framework/esm-globals/src/types.ts:346](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L346)
|
|
32
38
|
|
|
33
39
|
___
|
|
34
40
|
|
|
@@ -36,6 +42,8 @@ ___
|
|
|
36
42
|
|
|
37
43
|
• **label**: `string`
|
|
38
44
|
|
|
45
|
+
A human-friendly name which will be displayed in the Implementer Tools
|
|
46
|
+
|
|
39
47
|
#### Defined in
|
|
40
48
|
|
|
41
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
49
|
+
[packages/framework/esm-globals/src/types.ts:348](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L348)
|
|
@@ -12,9 +12,8 @@
|
|
|
12
12
|
|
|
13
13
|
## Table of contents
|
|
14
14
|
|
|
15
|
-
###
|
|
15
|
+
### Other Properties
|
|
16
16
|
|
|
17
|
-
- [additionalProps](OpenWorkspace.md#additionalprops)
|
|
18
17
|
- [canHide](OpenWorkspace.md#canhide)
|
|
19
18
|
- [canMaximize](OpenWorkspace.md#canmaximize)
|
|
20
19
|
- [hasOwnSidebar](OpenWorkspace.md#hasownsidebar)
|
|
@@ -27,28 +26,19 @@
|
|
|
27
26
|
- [type](OpenWorkspace.md#type)
|
|
28
27
|
- [width](OpenWorkspace.md#width)
|
|
29
28
|
|
|
30
|
-
###
|
|
29
|
+
### Workspace Properties
|
|
30
|
+
|
|
31
|
+
- [additionalProps](OpenWorkspace.md#additionalprops)
|
|
32
|
+
|
|
33
|
+
### Methods
|
|
31
34
|
|
|
32
35
|
- [closeWorkspace](OpenWorkspace.md#closeworkspace)
|
|
33
36
|
- [closeWorkspaceWithSavedChanges](OpenWorkspace.md#closeworkspacewithsavedchanges)
|
|
37
|
+
- [load](OpenWorkspace.md#load)
|
|
34
38
|
- [promptBeforeClosing](OpenWorkspace.md#promptbeforeclosing)
|
|
35
39
|
- [setTitle](OpenWorkspace.md#settitle)
|
|
36
40
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
- [load](OpenWorkspace.md#load)
|
|
40
|
-
|
|
41
|
-
## Workspace Properties
|
|
42
|
-
|
|
43
|
-
### additionalProps
|
|
44
|
-
|
|
45
|
-
• **additionalProps**: `object`
|
|
46
|
-
|
|
47
|
-
#### Defined in
|
|
48
|
-
|
|
49
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L47)
|
|
50
|
-
|
|
51
|
-
___
|
|
41
|
+
## Other Properties
|
|
52
42
|
|
|
53
43
|
### canHide
|
|
54
44
|
|
|
@@ -60,7 +50,7 @@ ___
|
|
|
60
50
|
|
|
61
51
|
#### Defined in
|
|
62
52
|
|
|
63
|
-
[packages/framework/esm-
|
|
53
|
+
[packages/framework/esm-extensions/src/workspaces.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L14)
|
|
64
54
|
|
|
65
55
|
___
|
|
66
56
|
|
|
@@ -74,7 +64,7 @@ ___
|
|
|
74
64
|
|
|
75
65
|
#### Defined in
|
|
76
66
|
|
|
77
|
-
[packages/framework/esm-
|
|
67
|
+
[packages/framework/esm-extensions/src/workspaces.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L15)
|
|
78
68
|
|
|
79
69
|
___
|
|
80
70
|
|
|
@@ -88,7 +78,7 @@ ___
|
|
|
88
78
|
|
|
89
79
|
#### Defined in
|
|
90
80
|
|
|
91
|
-
[packages/framework/esm-
|
|
81
|
+
[packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L17)
|
|
92
82
|
|
|
93
83
|
___
|
|
94
84
|
|
|
@@ -102,7 +92,7 @@ ___
|
|
|
102
92
|
|
|
103
93
|
#### Defined in
|
|
104
94
|
|
|
105
|
-
[packages/framework/esm-
|
|
95
|
+
[packages/framework/esm-extensions/src/workspaces.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L21)
|
|
106
96
|
|
|
107
97
|
___
|
|
108
98
|
|
|
@@ -116,7 +106,7 @@ ___
|
|
|
116
106
|
|
|
117
107
|
#### Defined in
|
|
118
108
|
|
|
119
|
-
[packages/framework/esm-
|
|
109
|
+
[packages/framework/esm-extensions/src/workspaces.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L10)
|
|
120
110
|
|
|
121
111
|
___
|
|
122
112
|
|
|
@@ -130,7 +120,7 @@ ___
|
|
|
130
120
|
|
|
131
121
|
#### Defined in
|
|
132
122
|
|
|
133
|
-
[packages/framework/esm-
|
|
123
|
+
[packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L19)
|
|
134
124
|
|
|
135
125
|
___
|
|
136
126
|
|
|
@@ -144,7 +134,7 @@ ___
|
|
|
144
134
|
|
|
145
135
|
#### Defined in
|
|
146
136
|
|
|
147
|
-
[packages/framework/esm-
|
|
137
|
+
[packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L18)
|
|
148
138
|
|
|
149
139
|
___
|
|
150
140
|
|
|
@@ -158,7 +148,7 @@ ___
|
|
|
158
148
|
|
|
159
149
|
#### Defined in
|
|
160
150
|
|
|
161
|
-
[packages/framework/esm-
|
|
151
|
+
[packages/framework/esm-extensions/src/workspaces.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L11)
|
|
162
152
|
|
|
163
153
|
___
|
|
164
154
|
|
|
@@ -172,7 +162,7 @@ ___
|
|
|
172
162
|
|
|
173
163
|
#### Defined in
|
|
174
164
|
|
|
175
|
-
[packages/framework/esm-
|
|
165
|
+
[packages/framework/esm-extensions/src/workspaces.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L12)
|
|
176
166
|
|
|
177
167
|
___
|
|
178
168
|
|
|
@@ -186,7 +176,7 @@ ___
|
|
|
186
176
|
|
|
187
177
|
#### Defined in
|
|
188
178
|
|
|
189
|
-
[packages/framework/esm-
|
|
179
|
+
[packages/framework/esm-extensions/src/workspaces.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L13)
|
|
190
180
|
|
|
191
181
|
___
|
|
192
182
|
|
|
@@ -200,9 +190,21 @@ ___
|
|
|
200
190
|
|
|
201
191
|
#### Defined in
|
|
202
192
|
|
|
203
|
-
[packages/framework/esm-
|
|
193
|
+
[packages/framework/esm-extensions/src/workspaces.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L16)
|
|
194
|
+
|
|
195
|
+
___
|
|
196
|
+
|
|
197
|
+
## Workspace Properties
|
|
198
|
+
|
|
199
|
+
### additionalProps
|
|
200
|
+
|
|
201
|
+
• **additionalProps**: `object`
|
|
202
|
+
|
|
203
|
+
#### Defined in
|
|
204
|
+
|
|
205
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:97](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L97)
|
|
204
206
|
|
|
205
|
-
##
|
|
207
|
+
## Methods
|
|
206
208
|
|
|
207
209
|
### closeWorkspace
|
|
208
210
|
|
|
@@ -230,7 +232,7 @@ closed, given the user forcefully closes the workspace.
|
|
|
230
232
|
|
|
231
233
|
#### Defined in
|
|
232
234
|
|
|
233
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
235
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L37)
|
|
234
236
|
|
|
235
237
|
___
|
|
236
238
|
|
|
@@ -257,7 +259,25 @@ will directly close the workspace without any prompt
|
|
|
257
259
|
|
|
258
260
|
#### Defined in
|
|
259
261
|
|
|
260
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
262
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L47)
|
|
263
|
+
|
|
264
|
+
___
|
|
265
|
+
|
|
266
|
+
### load
|
|
267
|
+
|
|
268
|
+
▸ **load**(): `Promise`<{ `default?`: `LifeCycles`<{}\> } & `LifeCycles`<{}\>\>
|
|
269
|
+
|
|
270
|
+
#### Returns
|
|
271
|
+
|
|
272
|
+
`Promise`<{ `default?`: `LifeCycles`<{}\> } & `LifeCycles`<{}\>\>
|
|
273
|
+
|
|
274
|
+
#### Inherited from
|
|
275
|
+
|
|
276
|
+
[WorkspaceRegistration](WorkspaceRegistration.md).[load](WorkspaceRegistration.md#load)
|
|
277
|
+
|
|
278
|
+
#### Defined in
|
|
279
|
+
|
|
280
|
+
[packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L20)
|
|
261
281
|
|
|
262
282
|
___
|
|
263
283
|
|
|
@@ -284,7 +304,7 @@ this workspace is closed; e.g. if there is unsaved data.
|
|
|
284
304
|
|
|
285
305
|
#### Defined in
|
|
286
306
|
|
|
287
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
307
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L42)
|
|
288
308
|
|
|
289
309
|
___
|
|
290
310
|
|
|
@@ -316,24 +336,4 @@ title needs to be set dynamically.
|
|
|
316
336
|
|
|
317
337
|
#### Defined in
|
|
318
338
|
|
|
319
|
-
[packages/framework/esm-styleguide/src/workspaces/
|
|
320
|
-
|
|
321
|
-
___
|
|
322
|
-
|
|
323
|
-
## Workspace Methods
|
|
324
|
-
|
|
325
|
-
### load
|
|
326
|
-
|
|
327
|
-
▸ **load**(): `Promise`<{ `default?`: `LifeCycles`<{}\> } & `LifeCycles`<{}\>\>
|
|
328
|
-
|
|
329
|
-
#### Returns
|
|
330
|
-
|
|
331
|
-
`Promise`<{ `default?`: `LifeCycles`<{}\> } & `LifeCycles`<{}\>\>
|
|
332
|
-
|
|
333
|
-
#### Inherited from
|
|
334
|
-
|
|
335
|
-
[WorkspaceRegistration](WorkspaceRegistration.md).[load](WorkspaceRegistration.md#load)
|
|
336
|
-
|
|
337
|
-
#### Defined in
|
|
338
|
-
|
|
339
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L42)
|
|
339
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L62)
|
|
@@ -10,6 +10,7 @@ This interface describes the format of the routes provided by an app
|
|
|
10
10
|
|
|
11
11
|
- [backendDependencies](OpenmrsAppRoutes.md#backenddependencies)
|
|
12
12
|
- [extensions](OpenmrsAppRoutes.md#extensions)
|
|
13
|
+
- [featureFlags](OpenmrsAppRoutes.md#featureflags)
|
|
13
14
|
- [modals](OpenmrsAppRoutes.md#modals)
|
|
14
15
|
- [optionalBackendDependencies](OpenmrsAppRoutes.md#optionalbackenddependencies)
|
|
15
16
|
- [pages](OpenmrsAppRoutes.md#pages)
|
|
@@ -26,7 +27,7 @@ A list of backend modules necessary for this frontend module and the correspondi
|
|
|
26
27
|
|
|
27
28
|
#### Defined in
|
|
28
29
|
|
|
29
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
30
|
+
[packages/framework/esm-globals/src/types.ts:358](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L358)
|
|
30
31
|
|
|
31
32
|
___
|
|
32
33
|
|
|
@@ -38,7 +39,19 @@ An array of all extensions supported by this frontend module. Extensions can be
|
|
|
38
39
|
|
|
39
40
|
#### Defined in
|
|
40
41
|
|
|
41
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
42
|
+
[packages/framework/esm-globals/src/types.ts:374](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L374)
|
|
43
|
+
|
|
44
|
+
___
|
|
45
|
+
|
|
46
|
+
### featureFlags
|
|
47
|
+
|
|
48
|
+
• `Optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
|
|
49
|
+
|
|
50
|
+
An array of all feature flags for any beta-stage features this module provides.
|
|
51
|
+
|
|
52
|
+
#### Defined in
|
|
53
|
+
|
|
54
|
+
[packages/framework/esm-globals/src/types.ts:376](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L376)
|
|
42
55
|
|
|
43
56
|
___
|
|
44
57
|
|
|
@@ -50,7 +63,7 @@ An array of all modals supported by this frontend module. Modals can be launched
|
|
|
50
63
|
|
|
51
64
|
#### Defined in
|
|
52
65
|
|
|
53
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
66
|
+
[packages/framework/esm-globals/src/types.ts:378](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L378)
|
|
54
67
|
|
|
55
68
|
___
|
|
56
69
|
|
|
@@ -68,7 +81,7 @@ The name of the backend dependency and either the required version or an object
|
|
|
68
81
|
|
|
69
82
|
#### Defined in
|
|
70
83
|
|
|
71
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
84
|
+
[packages/framework/esm-globals/src/types.ts:360](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L360)
|
|
72
85
|
|
|
73
86
|
___
|
|
74
87
|
|
|
@@ -80,7 +93,7 @@ An array of all pages supported by this frontend module. Pages are automatically
|
|
|
80
93
|
|
|
81
94
|
#### Defined in
|
|
82
95
|
|
|
83
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
96
|
+
[packages/framework/esm-globals/src/types.ts:372](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L372)
|
|
84
97
|
|
|
85
98
|
___
|
|
86
99
|
|
|
@@ -92,7 +105,7 @@ The version of this frontend module.
|
|
|
92
105
|
|
|
93
106
|
#### Defined in
|
|
94
107
|
|
|
95
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
108
|
+
[packages/framework/esm-globals/src/types.ts:356](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L356)
|
|
96
109
|
|
|
97
110
|
___
|
|
98
111
|
|
|
@@ -104,4 +117,4 @@ An array of all workspaces supported by this frontend module. Workspaces can be
|
|
|
104
117
|
|
|
105
118
|
#### Defined in
|
|
106
119
|
|
|
107
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
120
|
+
[packages/framework/esm-globals/src/types.ts:380](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L380)
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
|
|
24
24
|
#### Defined in
|
|
25
25
|
|
|
26
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
26
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L81)
|
|
27
27
|
|
|
28
28
|
___
|
|
29
29
|
|
|
@@ -35,7 +35,7 @@ Defaults to "Cancel"
|
|
|
35
35
|
|
|
36
36
|
#### Defined in
|
|
37
37
|
|
|
38
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
38
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L86)
|
|
39
39
|
|
|
40
40
|
___
|
|
41
41
|
|
|
@@ -47,7 +47,7 @@ Defaults to "Confirm"
|
|
|
47
47
|
|
|
48
48
|
#### Defined in
|
|
49
49
|
|
|
50
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
50
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L83)
|
|
51
51
|
|
|
52
52
|
___
|
|
53
53
|
|
|
@@ -57,7 +57,7 @@ ___
|
|
|
57
57
|
|
|
58
58
|
#### Defined in
|
|
59
59
|
|
|
60
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
60
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L80)
|
|
61
61
|
|
|
62
62
|
## Methods
|
|
63
63
|
|
|
@@ -71,4 +71,4 @@ ___
|
|
|
71
71
|
|
|
72
72
|
#### Defined in
|
|
73
73
|
|
|
74
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
|
74
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L84)
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
|
|
21
21
|
#### Defined in
|
|
22
22
|
|
|
23
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
23
|
+
[packages/framework/esm-globals/src/types.ts:390](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L390)
|