@openmrs/esm-framework
Version:
88 lines (46 loc) • 2.24 kB
Markdown
[@openmrs/esm-framework](../API.md) / ToastDescriptor
# Interface: ToastDescriptor
## Hierarchy
- **`ToastDescriptor`**
↳ [`ToastNotificationMeta`](ToastNotificationMeta.md)
## Table of contents
### UI Properties
- [actionButtonLabel](ToastDescriptor.md#actionbuttonlabel)
- [critical](ToastDescriptor.md#critical)
- [description](ToastDescriptor.md#description)
- [kind](ToastDescriptor.md#kind)
- [title](ToastDescriptor.md#title)
### UI Methods
- [onActionButtonClick](ToastDescriptor.md#onactionbuttonclick)
## UI Properties
### actionButtonLabel
• `Optional` **actionButtonLabel**: `string`
#### Defined in
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L13)
___
### critical
• `Optional` **critical**: `boolean`
#### Defined in
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
___
### description
• **description**: `ReactNode`
#### Defined in
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L11)
___
### kind
• `Optional` **kind**: [`ToastType`](../API.md#toasttype)
#### Defined in
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L14)
___
### title
• `Optional` **title**: `string`
#### Defined in
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
## UI Methods
### onActionButtonClick
▸ `Optional` **onActionButtonClick**(): `void`
#### Returns
`void`
#### Defined in
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L12)