UNPKG

@openmrs/esm-framework

Version:
121 lines (64 loc) 3.35 kB
[@openmrs/esm-framework](../API.md) / SnackbarDescriptor # Interface: SnackbarDescriptor ## Hierarchy - **`SnackbarDescriptor`** ↳ [`SnackbarMeta`](SnackbarMeta.md) ## Table of contents ### UI Properties - [actionButtonLabel](SnackbarDescriptor.md#actionbuttonlabel) - [autoClose](SnackbarDescriptor.md#autoclose) - [isLowContrast](SnackbarDescriptor.md#islowcontrast) - [kind](SnackbarDescriptor.md#kind) - [progressActionLabel](SnackbarDescriptor.md#progressactionlabel) - [subtitle](SnackbarDescriptor.md#subtitle) - [timeoutInMs](SnackbarDescriptor.md#timeoutinms) - [title](SnackbarDescriptor.md#title) ### UI Methods - [onActionButtonClick](SnackbarDescriptor.md#onactionbuttonclick) ## UI Properties ### actionButtonLabel`Optional` **actionButtonLabel**: `string` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L14) ___ ### autoClose`Optional` **autoClose**: `boolean` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L21) ___ ### isLowContrast`Optional` **isLowContrast**: `boolean` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L15) ___ ### kind`Optional` **kind**: `string` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L16) ___ ### progressActionLabel`Optional` **progressActionLabel**: `string` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L18) ___ ### subtitle`Optional` **subtitle**: `ReactNode` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L19) ___ ### timeoutInMs`Optional` **timeoutInMs**: `number` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L20) ___ ### title • **title**: `string` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L22) ## UI Methods ### onActionButtonClick`Optional` **onActionButtonClick**(): `void` #### Returns `void` #### Defined in [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L17)