@openmrs/esm-framework 4.0.3-pre.379 → 4.0.3-pre.389

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.
Files changed (10) hide show
  1. package/.turbo/turbo-build.log +2 -2
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +42 -38
  5. package/docs/classes/OpenmrsFetchError.md +3 -3
  6. package/docs/interfaces/ActionableNotificationDescriptor.md +44 -19
  7. package/docs/interfaces/ConfigurableLinkProps.md +4122 -0
  8. package/docs/interfaces/ShowActionableNotificationEvent.md +81 -0
  9. package/docs/interfaces/ShowToastEvent.md +4 -4
  10. package/package.json +13 -13
package/docs/API.md CHANGED
@@ -158,10 +158,11 @@
158
158
 
159
159
  - [isDesktop](API.md#isdesktop)
160
160
  - [setLeftNav](API.md#setleftnav)
161
+ - [showActionableNotification](API.md#showactionablenotification)
161
162
  - [showModal](API.md#showmodal)
162
163
  - [showNotification](API.md#shownotification)
163
- - [showActionableNotification](API.md#showactionablenotification)
164
164
  - [showToast](API.md#showtoast)
165
+ - [subscribeActionableNotificationShown](API.md#subscribeactionablenotificationshown)
165
166
  - [subscribeNotificationShown](API.md#subscribenotificationshown)
166
167
  - [subscribeToastShown](API.md#subscribetoastshown)
167
168
  - [unsetLeftNav](API.md#unsetleftnav)
@@ -525,23 +526,23 @@ ___
525
526
 
526
527
  ## UI Type Aliases
527
528
 
528
- ### InlineNotificationType
529
+ ### ActionableNotificationType
529
530
 
530
- Ƭ **InlineNotificationType**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
531
+ Ƭ **ActionableNotificationType**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
531
532
 
532
533
  #### Defined in
533
534
 
534
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L22)
535
+ [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L25)
535
536
 
536
537
  ___
537
538
 
538
- ### ActionableNotificationType
539
+ ### InlineNotificationType
539
540
 
540
- Ƭ **ActionableNotificationType**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
541
+ Ƭ **InlineNotificationType**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
541
542
 
542
543
  #### Defined in
543
544
 
544
- [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L25)
545
+ [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L22)
545
546
 
546
547
  ___
547
548
 
@@ -1180,7 +1181,7 @@ ___
1180
1181
 
1181
1182
  #### Defined in
1182
1183
 
1183
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:239](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L239)
1184
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L241)
1184
1185
 
1185
1186
  ___
1186
1187
 
@@ -3858,6 +3859,28 @@ ___
3858
3859
 
3859
3860
  ___
3860
3861
 
3862
+ ### showActionableNotification
3863
+
3864
+ ▸ **showActionableNotification**(`notification`): `void`
3865
+
3866
+ Displays an actionable notification in the UI.
3867
+
3868
+ #### Parameters
3869
+
3870
+ | Name | Type | Description |
3871
+ | :------ | :------ | :------ |
3872
+ | `notification` | [`ActionableNotificationDescriptor`](interfaces/ActionableNotificationDescriptor.md) | The description of the notification to display. |
3873
+
3874
+ #### Returns
3875
+
3876
+ `void`
3877
+
3878
+ #### Defined in
3879
+
3880
+ [packages/framework/esm-styleguide/src/notifications/index.tsx:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L88)
3881
+
3882
+ ___
3883
+
3861
3884
  ### showModal
3862
3885
 
3863
3886
  ▸ **showModal**(`extensionId`, `props?`, `onClose?`): () => `void`
@@ -3908,31 +3931,10 @@ Displays an inline notification in the UI.
3908
3931
 
3909
3932
  #### Defined in
3910
3933
 
3911
- [packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L48)
3934
+ [packages/framework/esm-styleguide/src/notifications/index.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L48)
3912
3935
 
3913
3936
  ___
3914
3937
 
3915
- ### showActionableNotification
3916
-
3917
- ▸ **showActionableNotification**(`notification`): `void`
3918
-
3919
- Displays an actionable notification in the UI which takes in an action.
3920
-
3921
- #### Parameters
3922
-
3923
- | Name | Type | Description |
3924
- | :------ | :------ | :------ |
3925
- | `notification` | [`ActionableNotificationDescriptor`](interfaces/ActionableNotificationDescriptor.md) | The description of the actionable notification to display. |
3926
-
3927
- #### Returns
3928
-
3929
- `void`
3930
-
3931
- #### Defined in
3932
-
3933
- [packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L88)
3934
-
3935
- ___
3936
3938
  ### showToast
3937
3939
 
3938
3940
  ▸ **showToast**(`toast`): `void`
@@ -3955,15 +3957,15 @@ Displays a toast notification in the UI.
3955
3957
 
3956
3958
  ___
3957
3959
 
3958
- ### subscribeNotificationShown
3960
+ ### subscribeActionableNotificationShown
3959
3961
 
3960
- ▸ **subscribeNotificationShown**(`cb`): () => `void`
3962
+ ▸ **subscribeActionableNotificationShown**(`cb`): () => `void`
3961
3963
 
3962
3964
  #### Parameters
3963
3965
 
3964
3966
  | Name | Type |
3965
3967
  | :------ | :------ |
3966
- | `cb` | (`data`: [`ShowNotificationEvent`](interfaces/ShowNotificationEvent.md)) => `void` |
3968
+ | `cb` | (`data`: [`ShowActionableNotificationEvent`](interfaces/ShowActionableNotificationEvent.md)) => `void` |
3967
3969
 
3968
3970
  #### Returns
3969
3971
 
@@ -3977,17 +3979,19 @@ ___
3977
3979
 
3978
3980
  #### Defined in
3979
3981
 
3980
- [packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L117)
3982
+ [packages/framework/esm-globals/src/events.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L126)
3981
3983
 
3982
3984
  ___
3983
3985
 
3984
- ▸ **subscribeActionableNotificationShown**(`cb`): () => `void`
3986
+ ### subscribeNotificationShown
3987
+
3988
+ ▸ **subscribeNotificationShown**(`cb`): () => `void`
3985
3989
 
3986
3990
  #### Parameters
3987
3991
 
3988
3992
  | Name | Type |
3989
3993
  | :------ | :------ |
3990
- | `cb` | (`data`: [`ShowActionableNotificationEvent`](interfaces/ShowActionableNotificationEvent.md)) => `void` |
3994
+ | `cb` | (`data`: [`ShowNotificationEvent`](interfaces/ShowNotificationEvent.md)) => `void` |
3991
3995
 
3992
3996
  #### Returns
3993
3997
 
@@ -4001,7 +4005,7 @@ ___
4001
4005
 
4002
4006
  #### Defined in
4003
4007
 
4004
- [packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L126)
4008
+ [packages/framework/esm-globals/src/events.ts:117](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L117)
4005
4009
 
4006
4010
  ___
4007
4011
 
@@ -4027,7 +4031,7 @@ ___
4027
4031
 
4028
4032
  #### Defined in
4029
4033
 
4030
- [packages/framework/esm-globals/src/events.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L136)
4034
+ [packages/framework/esm-globals/src/events.ts:136](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L136)
4031
4035
 
4032
4036
  ___
4033
4037
 
package/docs/classes/OpenmrsFetchError.md CHANGED
@@ -164,7 +164,7 @@ Error.prepareStackTrace
164
164
 
165
165
  #### Defined in
166
166
 
167
- packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:11
167
+ packages/framework/esm-framework/node_modules/@types/node/ts4.8/globals.d.ts:11
168
168
 
169
169
  ___
170
170
 
@@ -178,7 +178,7 @@ Error.stackTraceLimit
178
178
 
179
179
  #### Defined in
180
180
 
181
- packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:13
181
+ packages/framework/esm-framework/node_modules/@types/node/ts4.8/globals.d.ts:13
182
182
 
183
183
  ## Methods
184
184
 
@@ -205,4 +205,4 @@ Error.captureStackTrace
205
205
 
206
206
  #### Defined in
207
207
 
208
- packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:4
208
+ packages/framework/esm-framework/node_modules/@types/node/ts4.8/globals.d.ts:4
package/docs/interfaces/ActionableNotificationDescriptor.md CHANGED
@@ -6,13 +6,18 @@
6
6
 
7
7
  ### UI Properties
8
8
 
9
- - [actionButtonLable](ActionableNotificationDescriptor.md#actionButtonLable)
9
+ - [actionButtonLabel](ActionableNotificationDescriptor.md#actionbuttonlabel)
10
10
  - [critical](ActionableNotificationDescriptor.md#critical)
11
- - [subtitle](ActionableNotificationDescriptor.md#subtitle)
12
11
  - [kind](ActionableNotificationDescriptor.md#kind)
13
- - [onActionButtonClick](ActionableNotificationDescriptor.md#onActionButtonClick)
12
+ - [progressActionLabel](ActionableNotificationDescriptor.md#progressactionlabel)
13
+ - [subtitle](ActionableNotificationDescriptor.md#subtitle)
14
14
  - [title](ActionableNotificationDescriptor.md#title)
15
15
 
16
+ ### UI Methods
17
+
18
+ - [onActionButtonClick](ActionableNotificationDescriptor.md#onactionbuttonclick)
19
+ - [onClose](ActionableNotificationDescriptor.md#onclose)
20
+
16
21
  ## UI Properties
17
22
 
18
23
  ### actionButtonLabel
@@ -25,21 +30,33 @@
25
30
 
26
31
  ___
27
32
 
28
- • **onActionButtonClick**: `void`
33
+ ### critical
34
+
35
+ • `Optional` **critical**: `boolean`
29
36
 
30
37
  #### Defined in
31
38
 
32
- [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L11)
39
+ [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L16)
33
40
 
34
41
  ___
35
42
 
36
- ### critical
43
+ ### kind
37
44
 
38
- • `Optional` **critical**: `boolean`
45
+ • `Optional` **kind**: `string`
39
46
 
40
47
  #### Defined in
41
48
 
42
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L16)
49
+ [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L15)
50
+
51
+ ___
52
+
53
+ ### progressActionLabel
54
+
55
+ • `Optional` **progressActionLabel**: `string`
56
+
57
+ #### Defined in
58
+
59
+ [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L17)
43
60
 
44
61
  ___
45
62
 
@@ -49,34 +66,42 @@ ___
49
66
 
50
67
  #### Defined in
51
68
 
52
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L13)
69
+ [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L13)
53
70
 
54
71
  ___
55
72
 
56
- ### kind
73
+ ### title
57
74
 
58
- • `Optional` **kind**: [`ActionableNotificationType`](../API.md#actionablenotificationtype)
75
+ • `Optional` **title**: `string`
59
76
 
60
77
  #### Defined in
61
78
 
62
- [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L15)
79
+ [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L14)
63
80
 
64
- ___
81
+ ## UI Methods
65
82
 
66
- ### progressActionLabel
83
+ ### onActionButtonClick
67
84
 
68
- • `Optional` **progressActionLabel**: `string`
85
+ ▸ **onActionButtonClick**(): `void`
86
+
87
+ #### Returns
88
+
89
+ `void`
69
90
 
70
91
  #### Defined in
71
92
 
72
- [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L17)
93
+ [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L11)
73
94
 
74
95
  ___
75
96
 
76
- ### title
97
+ ### onClose
77
98
 
78
- • `Optional` **title**: `string`
99
+ ▸ `Optional` **onClose**(): `void`
100
+
101
+ #### Returns
102
+
103
+ `void`
79
104
 
80
105
  #### Defined in
81
106
 
82
- [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L14)
107
+ [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L12)