@openmrs/esm-framework
Version:
168 lines (88 loc) • 4.62 kB
Markdown
[@openmrs/esm-framework](../API.md) / SnackbarMeta
# Interface: SnackbarMeta
## Hierarchy
- [`SnackbarDescriptor`](SnackbarDescriptor.md)
↳ **`SnackbarMeta`**
## Table of contents
### UI Properties
- [actionButtonLabel](SnackbarMeta.md#actionbuttonlabel)
- [autoClose](SnackbarMeta.md#autoclose)
- [id](SnackbarMeta.md#id)
- [isLowContrast](SnackbarMeta.md#islowcontrast)
- [kind](SnackbarMeta.md#kind)
- [progressActionLabel](SnackbarMeta.md#progressactionlabel)
- [subtitle](SnackbarMeta.md#subtitle)
- [timeoutInMs](SnackbarMeta.md#timeoutinms)
- [title](SnackbarMeta.md#title)
### UI Methods
- [onActionButtonClick](SnackbarMeta.md#onactionbuttonclick)
## UI Properties
### actionButtonLabel
• `Optional` **actionButtonLabel**: `string`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[actionButtonLabel](SnackbarDescriptor.md#actionbuttonlabel)
#### 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`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[autoClose](SnackbarDescriptor.md#autoclose)
#### 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)
___
### id
• **id**: `number`
#### Defined in
[packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L26)
___
### isLowContrast
• `Optional` **isLowContrast**: `boolean`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[isLowContrast](SnackbarDescriptor.md#islowcontrast)
#### 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`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[kind](SnackbarDescriptor.md#kind)
#### 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`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[progressActionLabel](SnackbarDescriptor.md#progressactionlabel)
#### 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`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[subtitle](SnackbarDescriptor.md#subtitle)
#### 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`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[timeoutInMs](SnackbarDescriptor.md#timeoutinms)
#### 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`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[title](SnackbarDescriptor.md#title)
#### 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`
#### Inherited from
[SnackbarDescriptor](SnackbarDescriptor.md).[onActionButtonClick](SnackbarDescriptor.md#onactionbuttonclick)
#### 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)