@openmrs/esm-framework 8.0.1-pre.3425 → 8.0.1-pre.3433
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.
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
[O3 Framework](../API.md) / Workspace2DefinitionProps
|
|
2
|
+
|
|
3
|
+
# Interface: Workspace2DefinitionProps\<WorkspaceProps, WindowProps, GroupProps\>
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L21)
|
|
6
|
+
|
|
7
|
+
**`Experimental`**
|
|
8
|
+
|
|
9
|
+
## Type Parameters
|
|
10
|
+
|
|
11
|
+
### WorkspaceProps
|
|
12
|
+
|
|
13
|
+
`WorkspaceProps` *extends* `object` = `object`
|
|
14
|
+
|
|
15
|
+
### WindowProps
|
|
16
|
+
|
|
17
|
+
`WindowProps` *extends* `object` = `object`
|
|
18
|
+
|
|
19
|
+
### GroupProps
|
|
20
|
+
|
|
21
|
+
`GroupProps` *extends* `object` = `object`
|
|
22
|
+
|
|
23
|
+
## Properties
|
|
24
|
+
|
|
25
|
+
### groupProps
|
|
26
|
+
|
|
27
|
+
> **groupProps**: `null` \| `GroupProps`
|
|
28
|
+
|
|
29
|
+
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)
|
|
30
|
+
|
|
31
|
+
**`Experimental`**
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### windowProps
|
|
36
|
+
|
|
37
|
+
> **windowProps**: `null` \| `WindowProps`
|
|
38
|
+
|
|
39
|
+
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)
|
|
40
|
+
|
|
41
|
+
**`Experimental`**
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### workspaceName
|
|
46
|
+
|
|
47
|
+
> **workspaceName**: `string`
|
|
48
|
+
|
|
49
|
+
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)
|
|
50
|
+
|
|
51
|
+
**`Experimental`**
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### workspaceProps
|
|
56
|
+
|
|
57
|
+
> **workspaceProps**: `null` \| `WorkspaceProps`
|
|
58
|
+
|
|
59
|
+
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)
|
|
60
|
+
|
|
61
|
+
**`Experimental`**
|
|
62
|
+
|
|
63
|
+
## Methods
|
|
64
|
+
|
|
65
|
+
### closeWorkspace()
|
|
66
|
+
|
|
67
|
+
> **closeWorkspace**(`options?`): `Promise`\<`boolean`\>
|
|
68
|
+
|
|
69
|
+
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)
|
|
70
|
+
|
|
71
|
+
**`Experimental`**
|
|
72
|
+
|
|
73
|
+
closes the current workspace, along with its children.
|
|
74
|
+
|
|
75
|
+
#### Parameters
|
|
76
|
+
|
|
77
|
+
##### options?
|
|
78
|
+
|
|
79
|
+
###### closeWindow?
|
|
80
|
+
|
|
81
|
+
`boolean`
|
|
82
|
+
|
|
83
|
+
###### discardUnsavedChanges?
|
|
84
|
+
|
|
85
|
+
`boolean`
|
|
86
|
+
|
|
87
|
+
#### Returns
|
|
88
|
+
|
|
89
|
+
`Promise`\<`boolean`\>
|
|
90
|
+
|
|
91
|
+
a Promise that resolves to true if the workspace is closed, false otherwise.
|
|
92
|
+
|
|
93
|
+
***
|
|
94
|
+
|
|
95
|
+
### launchChildWorkspace()
|
|
96
|
+
|
|
97
|
+
> **launchChildWorkspace**\<`Props`\>(`workspaceName`, `workspaceProps?`): `void`
|
|
98
|
+
|
|
99
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L33)
|
|
100
|
+
|
|
101
|
+
**`Experimental`**
|
|
102
|
+
|
|
103
|
+
This function launches a child workspace. Unlike `launchWorkspace()`, this function is meant
|
|
104
|
+
to be called from the a workspace, and it does not allow passing (or changing)
|
|
105
|
+
the window props or group props
|
|
106
|
+
|
|
107
|
+
#### Type Parameters
|
|
108
|
+
|
|
109
|
+
##### Props
|
|
110
|
+
|
|
111
|
+
`Props` *extends* `object`
|
|
112
|
+
|
|
113
|
+
#### Parameters
|
|
114
|
+
|
|
115
|
+
##### workspaceName
|
|
116
|
+
|
|
117
|
+
`string`
|
|
118
|
+
|
|
119
|
+
##### workspaceProps?
|
|
120
|
+
|
|
121
|
+
`Props`
|
|
122
|
+
|
|
123
|
+
#### Returns
|
|
124
|
+
|
|
125
|
+
`void`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "8.0.1-pre.
|
|
3
|
+
"version": "8.0.1-pre.3433",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "dist/openmrs-esm-framework.js",
|
|
@@ -59,24 +59,24 @@
|
|
|
59
59
|
"access": "public"
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
|
-
"@openmrs/esm-api": "8.0.1-pre.
|
|
63
|
-
"@openmrs/esm-config": "8.0.1-pre.
|
|
64
|
-
"@openmrs/esm-context": "8.0.1-pre.
|
|
65
|
-
"@openmrs/esm-dynamic-loading": "8.0.1-pre.
|
|
66
|
-
"@openmrs/esm-emr-api": "8.0.1-pre.
|
|
67
|
-
"@openmrs/esm-error-handling": "8.0.1-pre.
|
|
68
|
-
"@openmrs/esm-expression-evaluator": "8.0.1-pre.
|
|
69
|
-
"@openmrs/esm-extensions": "8.0.1-pre.
|
|
70
|
-
"@openmrs/esm-feature-flags": "8.0.1-pre.
|
|
71
|
-
"@openmrs/esm-globals": "8.0.1-pre.
|
|
72
|
-
"@openmrs/esm-navigation": "8.0.1-pre.
|
|
73
|
-
"@openmrs/esm-offline": "8.0.1-pre.
|
|
74
|
-
"@openmrs/esm-react-utils": "8.0.1-pre.
|
|
75
|
-
"@openmrs/esm-routes": "8.0.1-pre.
|
|
76
|
-
"@openmrs/esm-state": "8.0.1-pre.
|
|
77
|
-
"@openmrs/esm-styleguide": "8.0.1-pre.
|
|
78
|
-
"@openmrs/esm-translations": "8.0.1-pre.
|
|
79
|
-
"@openmrs/esm-utils": "8.0.1-pre.
|
|
62
|
+
"@openmrs/esm-api": "8.0.1-pre.3433",
|
|
63
|
+
"@openmrs/esm-config": "8.0.1-pre.3433",
|
|
64
|
+
"@openmrs/esm-context": "8.0.1-pre.3433",
|
|
65
|
+
"@openmrs/esm-dynamic-loading": "8.0.1-pre.3433",
|
|
66
|
+
"@openmrs/esm-emr-api": "8.0.1-pre.3433",
|
|
67
|
+
"@openmrs/esm-error-handling": "8.0.1-pre.3433",
|
|
68
|
+
"@openmrs/esm-expression-evaluator": "8.0.1-pre.3433",
|
|
69
|
+
"@openmrs/esm-extensions": "8.0.1-pre.3433",
|
|
70
|
+
"@openmrs/esm-feature-flags": "8.0.1-pre.3433",
|
|
71
|
+
"@openmrs/esm-globals": "8.0.1-pre.3433",
|
|
72
|
+
"@openmrs/esm-navigation": "8.0.1-pre.3433",
|
|
73
|
+
"@openmrs/esm-offline": "8.0.1-pre.3433",
|
|
74
|
+
"@openmrs/esm-react-utils": "8.0.1-pre.3433",
|
|
75
|
+
"@openmrs/esm-routes": "8.0.1-pre.3433",
|
|
76
|
+
"@openmrs/esm-state": "8.0.1-pre.3433",
|
|
77
|
+
"@openmrs/esm-styleguide": "8.0.1-pre.3433",
|
|
78
|
+
"@openmrs/esm-translations": "8.0.1-pre.3433",
|
|
79
|
+
"@openmrs/esm-utils": "8.0.1-pre.3433"
|
|
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": "8.0.1-pre.
|
|
92
|
+
"@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3433",
|
|
93
93
|
"@rspack/cli": "^1.3.11",
|
|
94
94
|
"@rspack/core": "^1.3.11",
|
|
95
95
|
"concurrently": "^9.1.2",
|