mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
* ACS-3640 Increasing time of autoclosing snackbar and adding possibility to add icon to snackbar content * ACS-3640 Fix lint issues * ACS-3640 Addressing PR comments and adding possibility to display icon together with label * ACS-3640 Fix lint issues * ACS-3640 Added possibility to change showAction for different types of notifications * ACS-3640 Addressed PR comments * ACS-3640 Corrected title for snackbar content md file and remove redundant test for snackbar content * ACS-3640 Fixed lint issues * ACS-3640 Fixed unit tests * ACS-3640 Fixed e2e tests * ACS-3640 Correction after rebasing * ACS-3640 Use data automation id * ACS-3640 Corrected one more selector * ACS-3640 Added spaces * ACS-3640 Added spaces * ACS-3640 Added spaces * ACS-3640 Added spaces
47 lines
2.0 KiB
Markdown
47 lines
2.0 KiB
Markdown
---
|
|
Title: Snackbar Content Component
|
|
Added: v5.1.0
|
|
Status: Active
|
|
Last reviewed: 2022-11-08
|
|
---
|
|
|
|
# [Snackbar Content Component](lib/core/src/lib/snackbar-content/snackbar-content.component.ts "Defined in snackbar-content.component.ts")
|
|
|
|
Custom content for Snackbar which allows use icon as action.
|
|
|
|
## Basic Usage
|
|
|
|
```ts
|
|
snackBar.openFromComponent(SnackbarContentComponent, {
|
|
data: {
|
|
message: 'Some message',
|
|
actionLabel: "Some action label",
|
|
showAction: true
|
|
}
|
|
});
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
|------|----------------|---------------|------------------------------------------------------------------|
|
|
| data | `SnackbarData` | false | Object which is injected into snackbar's content with it's data. |
|
|
|
|
### Snackbar Data
|
|
|
|
| Name | Type | Default value | Description |
|
|
|-------------|-----------|---------------|-------------------------------------------------------------------------|
|
|
| actionLabel | `string` | false | Displayed action as a text. |
|
|
| actionIcon | `string` | false | Displayed action as an material icon. |
|
|
| actionIconAriaLabel | `string` | false | Sets aria-label attribute for button with icon action. |
|
|
| message | `string` | false | Visible snackbar's message for user. |
|
|
| showAction | `boolean` | false | True if action should be visible, false in other case. |
|
|
| callActionOnIconClick | `boolean` | false | True if clicking on icon should to trigger action, false in other case. |
|
|
|
|
## Details
|
|
|
|
Snackbar allows using action as string by default which causes that there is no possibility to use mat-icon inside snackbar's content.
|
|
That custom content for Angular material Snackbar allows for that.
|