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

package/docs/API.md

@@ -158,9 +158,11 @@
 
 - [isDesktop](API.md#isdesktop)
 - [setLeftNav](API.md#setleftnav)
+- [showActionableNotification](API.md#showactionablenotification)
 - [showModal](API.md#showmodal)
 - [showNotification](API.md#shownotification)
 - [showToast](API.md#showtoast)
+- [subscribeActionableNotificationShown](API.md#subscribeactionablenotificationshown)
 - [subscribeNotificationShown](API.md#subscribenotificationshown)
 - [subscribeToastShown](API.md#subscribetoastshown)
 - [unsetLeftNav](API.md#unsetleftnav)
@@ -524,6 +526,16 @@ ___
 
 ## UI Type Aliases
 
+### ActionableNotificationType
+
+Ƭ **ActionableNotificationType**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
+
+#### Defined in
+
+[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)
+
+___
+
 ### InlineNotificationType
 
 Ƭ **InlineNotificationType**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
@@ -1169,7 +1181,7 @@ ___
 
 #### Defined in
 
-[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)
+[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)
 
 ___
 
@@ -3847,6 +3859,28 @@ ___
 
 ___
 
+### showActionableNotification
+
+▸ **showActionableNotification**(`notification`): `void`
+
+Displays an actionable notification in the UI.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `notification` | [`ActionableNotificationDescriptor`](interfaces/ActionableNotificationDescriptor.md) | The description of the notification to display. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[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)
+
+___
+
 ### showModal
 
 ▸ **showModal**(`extensionId`, `props?`, `onClose?`): () => `void`
@@ -3897,7 +3931,7 @@ Displays an inline notification in the UI.
 
 #### Defined in
 
-[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#L40)
+[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)
 
 ___
 
@@ -3923,6 +3957,32 @@ Displays a toast notification in the UI.
 
 ___
 
+### subscribeActionableNotificationShown
+
+▸ **subscribeActionableNotificationShown**(`cb`): () => `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `cb` | (`data`: [`ShowActionableNotificationEvent`](interfaces/ShowActionableNotificationEvent.md)) => `void` |
+
+#### Returns
+
+`fn`
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[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)
+
+___
+
 ### subscribeNotificationShown
 
 ▸ **subscribeNotificationShown**(`cb`): () => `void`
@@ -3945,7 +4005,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L93)
+[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)
 
 ___
 
@@ -3971,7 +4031,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-globals/src/events.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L102)
+[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)
 
 ___
 

package/docs/classes/OpenmrsFetchError.md

@@ -164,7 +164,7 @@ Error.prepareStackTrace
 
 #### Defined in
 
-packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:11
+packages/framework/esm-framework/node_modules/@types/node/ts4.8/globals.d.ts:11
 
 ___
 
@@ -178,7 +178,7 @@ Error.stackTraceLimit
 
 #### Defined in
 
-packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:13
+packages/framework/esm-framework/node_modules/@types/node/ts4.8/globals.d.ts:13
 
 ## Methods
 
@@ -205,4 +205,4 @@ Error.captureStackTrace
 
 #### Defined in
 
-packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:4
+packages/framework/esm-framework/node_modules/@types/node/ts4.8/globals.d.ts:4

package/docs/interfaces/ActionableNotificationDescriptor.md

@@ -0,0 +1,107 @@
+[@openmrs/esm-framework](../API.md) / ActionableNotificationDescriptor
+
+# Interface: ActionableNotificationDescriptor
+
+## Table of contents
+
+### UI Properties
+
+- [actionButtonLabel](ActionableNotificationDescriptor.md#actionbuttonlabel)
+- [critical](ActionableNotificationDescriptor.md#critical)
+- [kind](ActionableNotificationDescriptor.md#kind)
+- [progressActionLabel](ActionableNotificationDescriptor.md#progressactionlabel)
+- [subtitle](ActionableNotificationDescriptor.md#subtitle)
+- [title](ActionableNotificationDescriptor.md#title)
+
+### UI Methods
+
+- [onActionButtonClick](ActionableNotificationDescriptor.md#onactionbuttonclick)
+- [onClose](ActionableNotificationDescriptor.md#onclose)
+
+## UI Properties
+
+### actionButtonLabel
+
+• **actionButtonLabel**: `string`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L10)
+
+___
+
+### critical
+
+• `Optional` **critical**: `boolean`
+
+#### Defined in
+
+[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)
+
+___
+
+### kind
+
+• `Optional` **kind**: `string`
+
+#### Defined in
+
+[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)
+
+___
+
+### progressActionLabel
+
+• `Optional` **progressActionLabel**: `string`
+
+#### Defined in
+
+[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)
+
+___
+
+### subtitle
+
+• **subtitle**: `string`
+
+#### Defined in
+
+[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)
+
+___
+
+### title
+
+• `Optional` **title**: `string`
+
+#### Defined in
+
+[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)
+
+## UI Methods
+
+### onActionButtonClick
+
+▸ **onActionButtonClick**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[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)
+
+___
+
+### onClose
+
+▸ `Optional` **onClose**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[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)