@openmrs/esm-framework 9.0.3-pre.4786 → 9.0.3-pre.4807
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/API.md +1 -1
- package/docs/functions/EmptyCardIllustration.md +1 -1
- package/docs/functions/closeWorkspaceGroup2.md +1 -3
- package/docs/functions/getRegisteredWorkspace2Names.md +1 -1
- package/docs/functions/getVisitsForPatient.md +1 -1
- package/docs/functions/launchWorkspace2.md +1 -3
- package/docs/functions/launchWorkspaceGroup2.md +1 -3
- package/docs/functions/saveVisit.md +1 -1
- package/docs/functions/setCurrentVisit.md +7 -2
- package/docs/functions/updateVisit.md +1 -1
- package/docs/functions/useVisit.md +1 -1
- package/docs/functions/useWorkspace2Context.md +1 -1
- package/docs/interfaces/EmptyCardProps.md +4 -4
- package/docs/interfaces/VisitReturnType.md +15 -5
- package/docs/interfaces/Workspace2DefinitionProps.md +10 -30
- package/docs/type-aliases/ErrorCardProps.md +1 -1
- package/docs/type-aliases/Workspace2Definition.md +1 -3
- package/docs/variables/ActionMenuButton2.md +1 -3
- package/docs/variables/EmptyCard.md +1 -1
- package/docs/variables/ErrorCard.md +1 -1
- package/docs/variables/Workspace2.md +1 -3
- package/docs/variables/getStartedVisit.md +1 -1
- package/package.json +20 -20
package/.turbo/turbo-build.log
CHANGED
package/docs/API.md
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
- [PatientWithFullResponse](interfaces/PatientWithFullResponse.md)
|
|
20
20
|
- [OnlyThePatient](interfaces/OnlyThePatient.md)
|
|
21
21
|
- [getVisitStore](functions/getVisitStore.md)
|
|
22
|
-
- [setCurrentVisit](functions/setCurrentVisit.md)
|
|
22
|
+
- [~~setCurrentVisit~~](functions/setCurrentVisit.md)
|
|
23
23
|
- [saveVisit](functions/saveVisit.md)
|
|
24
24
|
- [updateVisit](functions/updateVisit.md)
|
|
25
25
|
- [~~getVisitsForPatient~~](functions/getVisitsForPatient.md)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **EmptyCardIllustration**(`__namedParameters`): `Element`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L16)
|
|
8
8
|
|
|
9
9
|
## Parameters
|
|
10
10
|
|
|
@@ -4,9 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **closeWorkspaceGroup2**(`discardUnsavedChanges?`): `Promise`\<`boolean`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:
|
|
8
|
-
|
|
9
|
-
**`Experimental`**
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L73)
|
|
10
8
|
|
|
11
9
|
Closes the workspace group that is currently opened. Note that only one workspace group
|
|
12
10
|
may be opened at any given time
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **getRegisteredWorkspace2Names**(): `string`[]
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:600](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L600)
|
|
8
8
|
|
|
9
9
|
## Returns
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<\{ `results`: [`Visit`](../interfaces/Visit.md)[]; \}\>\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:183](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L183)
|
|
8
8
|
|
|
9
9
|
## Parameters
|
|
10
10
|
|
|
@@ -4,9 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **launchWorkspace2**\<`WorkspaceProps`, `WindowProps`, `GroupProp`\>(`workspaceName`, `workspaceProps`, `windowProps`, `groupProps`): `Promise`\<`boolean`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:
|
|
8
|
-
|
|
9
|
-
**`Experimental`**
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:132](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L132)
|
|
10
8
|
|
|
11
9
|
Attempts to launch the specified workspace with the given workspace props. This also implicitly opens
|
|
12
10
|
the workspace window to which the workspace belongs (if it's not opened already),
|
|
@@ -4,9 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **launchWorkspaceGroup2**\<`GroupProps`\>(`groupName`, `groupProps`): `Promise`\<`boolean`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:
|
|
8
|
-
|
|
9
|
-
**`Experimental`**
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L31)
|
|
10
8
|
|
|
11
9
|
Attempts to launch the specified workspace group with the given group props. Note that only one workspace group
|
|
12
10
|
may be opened at any given time. If a workspace group is already opened, calling `launchWorkspaceGroup2` with
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **saveVisit**(`payload`, `abortController`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<[`Visit`](../interfaces/Visit.md)\>\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:137](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L137)
|
|
8
8
|
|
|
9
9
|
Creates a new visit by sending a POST request to the OpenMRS REST API.
|
|
10
10
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
[O3 Framework](../API.md) / setCurrentVisit
|
|
2
2
|
|
|
3
|
-
# Function: setCurrentVisit()
|
|
3
|
+
# Function: ~~setCurrentVisit()~~
|
|
4
4
|
|
|
5
5
|
> **setCurrentVisit**(`patientUuid`, `visitUuid`): `void`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L98)
|
|
8
8
|
|
|
9
9
|
Sets the current visit for a patient in the global visit store. This is used
|
|
10
10
|
to manually specify which visit should be considered "active" for the given patient.
|
|
@@ -33,3 +33,8 @@ The UUID of the visit to set as the current visit.
|
|
|
33
33
|
import { setCurrentVisit } from '@openmrs/esm-framework';
|
|
34
34
|
setCurrentVisit('patient-uuid', 'visit-uuid');
|
|
35
35
|
```
|
|
36
|
+
|
|
37
|
+
## Deprecated
|
|
38
|
+
|
|
39
|
+
"current visit" is not well defined outside of the patient chart.
|
|
40
|
+
Use `visitContext` in the patient chart instead.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<[`Visit`](../interfaces/Visit.md)\>\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:165](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L165)
|
|
8
8
|
|
|
9
9
|
Updates an existing visit by sending a POST request to the OpenMRS REST API.
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **useVisit**(`patientUuid`, `representation`): [`VisitReturnType`](../interfaces/VisitReturnType.md)
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L52)
|
|
8
8
|
|
|
9
9
|
This React hook returns visit information if the patient UUID is not null. There are
|
|
10
10
|
potentially two relevant visits at a time: "active" and "current".
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **useWorkspace2Context**(): [`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`object`, `object`, `object`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:594](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L594)
|
|
8
8
|
|
|
9
9
|
Returns the react Context containing props passed into a workspace.
|
|
10
10
|
This hook MUST be called inside a child of <Workspace2>
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: EmptyCardProps
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:
|
|
5
|
+
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L7)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.compone
|
|
|
10
10
|
|
|
11
11
|
> **displayText**: `string`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:
|
|
13
|
+
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L9)
|
|
14
14
|
|
|
15
15
|
The name of the type of item that would be displayed here if not empty. This must be a pre-translated string.
|
|
16
16
|
|
|
@@ -20,7 +20,7 @@ The name of the type of item that would be displayed here if not empty. This mus
|
|
|
20
20
|
|
|
21
21
|
> **headerTitle**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:
|
|
23
|
+
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L11)
|
|
24
24
|
|
|
25
25
|
The title to use for this empty component. This must be a pre-translated string.
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ The title to use for this empty component. This must be a pre-translated string.
|
|
|
30
30
|
|
|
31
31
|
> `optional` **launchForm**(): `void`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:
|
|
33
|
+
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L13)
|
|
34
34
|
|
|
35
35
|
A callback to invoke when the user tries to record a new item.
|
|
36
36
|
|
|
@@ -14,19 +14,29 @@ Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:16](https://gith
|
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
### currentVisit
|
|
17
|
+
### ~~currentVisit~~
|
|
18
18
|
|
|
19
19
|
> **currentVisit**: `null` \| [`Visit`](Visit.md)
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L22)
|
|
22
|
+
|
|
23
|
+
#### Deprecated
|
|
24
|
+
|
|
25
|
+
"current visit" is not well defined outside of the patient chart.
|
|
26
|
+
Use `visitContext` in the patient chart instead.
|
|
22
27
|
|
|
23
28
|
***
|
|
24
29
|
|
|
25
|
-
### currentVisitIsRetrospective
|
|
30
|
+
### ~~currentVisitIsRetrospective~~
|
|
26
31
|
|
|
27
32
|
> **currentVisitIsRetrospective**: `boolean`
|
|
28
33
|
|
|
29
|
-
Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:
|
|
34
|
+
Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L28)
|
|
35
|
+
|
|
36
|
+
#### Deprecated
|
|
37
|
+
|
|
38
|
+
"current visit" is not well defined outside of the patient chart.
|
|
39
|
+
Use `visitContext` in the patient chart instead.
|
|
30
40
|
|
|
31
41
|
***
|
|
32
42
|
|
|
@@ -42,7 +52,7 @@ Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:13](https://gith
|
|
|
42
52
|
|
|
43
53
|
> **isLoading**: `boolean`
|
|
44
54
|
|
|
45
|
-
Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:
|
|
55
|
+
Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L29)
|
|
46
56
|
|
|
47
57
|
***
|
|
48
58
|
|
|
@@ -2,9 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: Workspace2DefinitionProps\<WorkspaceProps, WindowProps, GroupProps\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
6
|
-
|
|
7
|
-
**`Experimental`**
|
|
5
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L18)
|
|
8
6
|
|
|
9
7
|
## Type Parameters
|
|
10
8
|
|
|
@@ -26,9 +24,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
26
24
|
|
|
27
25
|
> **groupProps**: `null` \| `GroupProps`
|
|
28
26
|
|
|
29
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
30
|
-
|
|
31
|
-
**`Experimental`**
|
|
27
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L43)
|
|
32
28
|
|
|
33
29
|
***
|
|
34
30
|
|
|
@@ -36,9 +32,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
36
32
|
|
|
37
33
|
> **isRootWorkspace**: `boolean`
|
|
38
34
|
|
|
39
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
40
|
-
|
|
41
|
-
**`Experimental`**
|
|
35
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L46)
|
|
42
36
|
|
|
43
37
|
***
|
|
44
38
|
|
|
@@ -46,9 +40,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
46
40
|
|
|
47
41
|
> **showActionMenu**: `boolean`
|
|
48
42
|
|
|
49
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
50
|
-
|
|
51
|
-
**`Experimental`**
|
|
43
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L47)
|
|
52
44
|
|
|
53
45
|
***
|
|
54
46
|
|
|
@@ -56,9 +48,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
56
48
|
|
|
57
49
|
> **windowName**: `string`
|
|
58
50
|
|
|
59
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
60
|
-
|
|
61
|
-
**`Experimental`**
|
|
51
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L45)
|
|
62
52
|
|
|
63
53
|
***
|
|
64
54
|
|
|
@@ -66,9 +56,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
66
56
|
|
|
67
57
|
> **windowProps**: `null` \| `WindowProps`
|
|
68
58
|
|
|
69
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
70
|
-
|
|
71
|
-
**`Experimental`**
|
|
59
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L42)
|
|
72
60
|
|
|
73
61
|
***
|
|
74
62
|
|
|
@@ -76,9 +64,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
76
64
|
|
|
77
65
|
> **workspaceName**: `string`
|
|
78
66
|
|
|
79
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
80
|
-
|
|
81
|
-
**`Experimental`**
|
|
67
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L44)
|
|
82
68
|
|
|
83
69
|
***
|
|
84
70
|
|
|
@@ -86,9 +72,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
86
72
|
|
|
87
73
|
> **workspaceProps**: `null` \| `WorkspaceProps`
|
|
88
74
|
|
|
89
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
90
|
-
|
|
91
|
-
**`Experimental`**
|
|
75
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L41)
|
|
92
76
|
|
|
93
77
|
## Methods
|
|
94
78
|
|
|
@@ -96,9 +80,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
|
|
|
96
80
|
|
|
97
81
|
> **closeWorkspace**(`options?`): `Promise`\<`boolean`\>
|
|
98
82
|
|
|
99
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
100
|
-
|
|
101
|
-
**`Experimental`**
|
|
83
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L39)
|
|
102
84
|
|
|
103
85
|
closes the current workspace, along with its children.
|
|
104
86
|
|
|
@@ -132,9 +114,7 @@ a Promise that resolves to true if the workspace is closed, false otherwise.
|
|
|
132
114
|
|
|
133
115
|
> **launchChildWorkspace**\<`Props`\>(`workspaceName`, `workspaceProps?`): `Promise`\<`void`\>
|
|
134
116
|
|
|
135
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
136
|
-
|
|
137
|
-
**`Experimental`**
|
|
117
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L30)
|
|
138
118
|
|
|
139
119
|
This function launches a child workspace. Unlike `launchWorkspace()`, this function is meant
|
|
140
120
|
to be called from the a workspace, and it does not allow passing (or changing)
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **ErrorCardProps** = [`ErrorStateProps`](../interfaces/ErrorStateProps.md)
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L34)
|
|
@@ -4,9 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **Workspace2Definition**\<`WorkspaceProps`, `WindowProps`, `GroupProps`\> = `React.FC`\<[`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`WorkspaceProps`, `WindowProps`, `GroupProps`\>\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
8
|
-
|
|
9
|
-
**`Experimental`**
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L50)
|
|
10
8
|
|
|
11
9
|
## Type Parameters
|
|
12
10
|
|
|
@@ -4,9 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **ActionMenuButton2**: `React.FC`\<`ActionMenuButtonProps2`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/action-menu2/action-menu-button2.component.tsx:
|
|
8
|
-
|
|
9
|
-
**`Experimental`**
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/action-menu2/action-menu-button2.component.tsx:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/action-menu2/action-menu-button2.component.tsx#L66)
|
|
10
8
|
|
|
11
9
|
The ActionMenuButton2 component is used to render a button in the action menu of a workspace group.
|
|
12
10
|
The button is associated with a specific workspace window, defined in routes.json of the app with the button.
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **EmptyCard**: `React.FC`\<[`EmptyCardProps`](../interfaces/EmptyCardProps.md)\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/empty-card/empty-card.component.tsx#L27)
|
|
8
8
|
|
|
9
9
|
Re-usable card for displaying an empty state
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **ErrorCard**: `FC`\<[`ErrorStateProps`](../interfaces/ErrorStateProps.md)\> = `ErrorState`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L33)
|
|
@@ -4,9 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **Workspace2**: `React.FC`\<`Workspace2Props`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:
|
|
8
|
-
|
|
9
|
-
**`Experimental`**
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L62)
|
|
10
8
|
|
|
11
9
|
The Workspace2 component is used as a top-level container to render
|
|
12
10
|
its children as content within a workspace. When creating a workspace
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **getStartedVisit**: `BehaviorSubject`\<`null` \| [`VisitItem`](../interfaces/VisitItem.md)\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:200](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L200)
|
|
8
8
|
|
|
9
9
|
## Deprecated
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "9.0.3-pre.
|
|
3
|
+
"version": "9.0.3-pre.4807",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -59,24 +59,24 @@
|
|
|
59
59
|
"access": "public"
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
|
-
"@openmrs/esm-api": "9.0.3-pre.
|
|
63
|
-
"@openmrs/esm-config": "9.0.3-pre.
|
|
64
|
-
"@openmrs/esm-context": "9.0.3-pre.
|
|
65
|
-
"@openmrs/esm-dynamic-loading": "9.0.3-pre.
|
|
66
|
-
"@openmrs/esm-emr-api": "9.0.3-pre.
|
|
67
|
-
"@openmrs/esm-error-handling": "9.0.3-pre.
|
|
68
|
-
"@openmrs/esm-expression-evaluator": "9.0.3-pre.
|
|
69
|
-
"@openmrs/esm-extensions": "9.0.3-pre.
|
|
70
|
-
"@openmrs/esm-feature-flags": "9.0.3-pre.
|
|
71
|
-
"@openmrs/esm-globals": "9.0.3-pre.
|
|
72
|
-
"@openmrs/esm-navigation": "9.0.3-pre.
|
|
73
|
-
"@openmrs/esm-offline": "9.0.3-pre.
|
|
74
|
-
"@openmrs/esm-react-utils": "9.0.3-pre.
|
|
75
|
-
"@openmrs/esm-routes": "9.0.3-pre.
|
|
76
|
-
"@openmrs/esm-state": "9.0.3-pre.
|
|
77
|
-
"@openmrs/esm-styleguide": "9.0.3-pre.
|
|
78
|
-
"@openmrs/esm-translations": "9.0.3-pre.
|
|
79
|
-
"@openmrs/esm-utils": "9.0.3-pre.
|
|
62
|
+
"@openmrs/esm-api": "9.0.3-pre.4807",
|
|
63
|
+
"@openmrs/esm-config": "9.0.3-pre.4807",
|
|
64
|
+
"@openmrs/esm-context": "9.0.3-pre.4807",
|
|
65
|
+
"@openmrs/esm-dynamic-loading": "9.0.3-pre.4807",
|
|
66
|
+
"@openmrs/esm-emr-api": "9.0.3-pre.4807",
|
|
67
|
+
"@openmrs/esm-error-handling": "9.0.3-pre.4807",
|
|
68
|
+
"@openmrs/esm-expression-evaluator": "9.0.3-pre.4807",
|
|
69
|
+
"@openmrs/esm-extensions": "9.0.3-pre.4807",
|
|
70
|
+
"@openmrs/esm-feature-flags": "9.0.3-pre.4807",
|
|
71
|
+
"@openmrs/esm-globals": "9.0.3-pre.4807",
|
|
72
|
+
"@openmrs/esm-navigation": "9.0.3-pre.4807",
|
|
73
|
+
"@openmrs/esm-offline": "9.0.3-pre.4807",
|
|
74
|
+
"@openmrs/esm-react-utils": "9.0.3-pre.4807",
|
|
75
|
+
"@openmrs/esm-routes": "9.0.3-pre.4807",
|
|
76
|
+
"@openmrs/esm-state": "9.0.3-pre.4807",
|
|
77
|
+
"@openmrs/esm-styleguide": "9.0.3-pre.4807",
|
|
78
|
+
"@openmrs/esm-translations": "9.0.3-pre.4807",
|
|
79
|
+
"@openmrs/esm-utils": "9.0.3-pre.4807"
|
|
80
80
|
},
|
|
81
81
|
"peerDependencies": {
|
|
82
82
|
"dayjs": "1.x",
|
|
@@ -89,7 +89,7 @@
|
|
|
89
89
|
"swr": "2.x"
|
|
90
90
|
},
|
|
91
91
|
"devDependencies": {
|
|
92
|
-
"@openmrs/typedoc-plugin-file-categories": "9.0.3-pre.
|
|
92
|
+
"@openmrs/typedoc-plugin-file-categories": "9.0.3-pre.4807",
|
|
93
93
|
"@swc/cli": "0.8.1",
|
|
94
94
|
"@swc/core": "1.15.21",
|
|
95
95
|
"@vitest/coverage-v8": "^4.1.2",
|