Snackbar
The Ignite UI for Angular Snack Bar component provides feedback about an operation with a single-line message, which can include a link to an action such as Undo. The Snack Bar message appears above all other screen elements, located at the bottom of a mobile device screen or at the lower left of larger device screens.
Snackbar Demo
Usage
To get started with the Snack Bar component, first you need to install Ignite UI for Angular by typing the following command:
ng add igniteui-angular
For a complete introduction to the Ignite UI for Angular, read the getting started topic.
The next step is to import the IgxSnackbarModule in our app.module.ts file:
// app.module.ts
...
import { IgxSnackbarModule } from 'igniteui-angular';
@NgModule({
...
imports: [..., IgxSnackbarModule],
...
})
export class AppModule {}
Show Snackbar
In order to display the snackbar component, use its show() method and call it on a button click.
<!--sample.component.html-->
<button igxButton="raised" (click)="snackbar.show()">Delete Message</button>
<div>
<igx-snackbar #snackbar>Message deleted</igx-snackbar>
</div>
If the sample is configured properly, a snackbar appears displaying a text message when the button is clicked.
Hide/Auto Hide
Once opened, the snackbar disappears after a period specified by the displayTime input which is set initially to 4000 milliseconds. This behavior is enabled by default but you can change this by setting autoHide to false. In this way, the snackbar will remain visible. Using the snackbar hide() method, you can close the component in the code.
<!--sample.component.html-->
<button igxButton="raised" (click)="snackbar.show()">Send message</button>
<div>
<igx-snackbar #snackbar [autoHide]="false" actionText="CLOSE" (onAction)="close(snackbar)">Message sent</igx-snackbar>
</div>
// sample.component.ts
public close(element) {
element.hide();
}
If the sample is configured properly, a snackbar appears when the button is clicked showing message and action button. The auto hide feature is disabled and the snackbar disappears on 'CLOSE' button click.
Display Time
Use displayTime and set it to an interval in milliseconds to configure how long the snackbar component is visible.
<!--sample.component.html-->
<button igxButton="raised" (click)="snackbar.show()">Send message</button>
<div>
<igx-snackbar #snackbar displayTime="1000">Message sent</igx-snackbar>
</div>
If the sample is configured properly, the snackbar auto hides faster.
Customize Snackbar
We can also customize the content of the Snackbar to display more complex elements than a message and a button. If we want to show the snackbar while loading a file, for example, a loading animation could be added to its content.
<!--sample.component.html-->
<button igxButton="raised" (click)="snackbar.show()">Load file</button>
<div>
<igx-snackbar #snackbar displayTime="5000">File loading
<svg id="dots" height="20px">
<g id="dots" fill="#FFFFFF">
<circle id="dot1" cx="5" cy="18" r="2"></circle>
<circle id="dot2" cx="15" cy="18" r="2"></circle>
<circle id="dot3" cx="25" cy="18" r="2"></circle>
</g>
</svg>
</igx-snackbar>
</div>
//sample.component.scss
#dots #dot1 {
animation: load 1s infinite;
}
#dots #dot2 {
animation: load 1s infinite;
animation-delay: 0.2s;
}
#dots #dot3 {
animation: load 1s infinite;
animation-delay: 0.4s;
}
@keyframes load {
0% {
opacity: 0;
}
50% {
opacity: 1;
}
100% {
opacity: 0;
}
}
As a result, a message and three loading dots appear in the snackbar.
Snackbar in list
Having all main snackbar features covered, we can integrate this component in more interesting scenario. We can use the snackbar to provide a notification and ability to revert actions.
Let’s create a list with contacts that can be deleted. When an item is deleted, a snackbar is displayed containing a message and a button to undo the action.
<!--sample.component.html-->
<igx-list>
<igx-list-item [isHeader]="true">Contacts</igx-list-item>
<igx-list-item igxRipple="pink" igxRippleTarget=".igx-list__item" *ngFor="let item of navItems">
<div class="item-container">
<div class="contact">
<igx-avatar [src]="item.avatar" roundShape="true"></igx-avatar>
<div class="contact__info">
<span class="name">{{item.text}}</span>
</div>
</div>
<span igxButton="icon" igxRipple igxRippleCentered="true" (click)="delete(item)">
<igx-icon color="#ff5252">delete</igx-icon>
</span>
</div>
</igx-list-item>
<igx-snackbar actionText="Undo" (onAction)="restore()">Contact deleted</igx-snackbar>
</igx-list>
//sample.component.ts
import { Component, OnInit, ViewChild } from "@angular/core";
import { IgxSnackbarComponent } from 'igniteui-angular';
...
@ViewChild(IgxSnackbarComponent)
public snackbar: IgxSnackbarComponent;
public navItems: any[];
public deletedItems = [];
constructor() { }
public ngOnInit() {
this.navItems = [{
avatar: "assets/images/avatar/2.jpg",
text: "Richard Mahoney"
},
{
avatar: "assets/images/avatar/4.jpg",
text: "Lisa Landers"
},
{
avatar: "assets/images/avatar/14.jpg",
text: "Marianne Taylor"
},
{
avatar: "assets/images/avatar/17.jpg",
text: "Ward Riley"
}];
}
public delete(item) {
this.deletedItems.push([item, this.navItems.indexOf(item)]);
this.navItems.splice(this.navItems.indexOf(item), 1);
this.snackbar.show();
}
public restore() {
const [item, index] = this.deletedItems.pop();
this.navItems.splice(index, 0, item);
this.snackbar.hide();
}
Styling
To get started with styling the snackbar, we need to import the index file, where all the theme functions and component mixins live:
@import '~igniteui-angular/lib/core/styles/themes/index';
Following the simplest approach, we create a new theme that extends the igx-snackbar-theme and accepts the $text-color, $background, $button-color and the $border-radius parameters.
$dark-snackbar: igx-snackbar-theme(
$text-color: #FFCD0F,
$background: #292826,
$button-color: #FFCD0F,
$border-radius: 12px
);
The last step is to include the newly created theme.
@include igx-snackbar($dark-snackbar);
Note
If the component is using an Emulated ViewEncapsulation, it is necessary to penetrate this encapsulation using ::ng-deep:
:host {
::ng-deep {
@include igx-snackbar($dark-snackbar);
}
}
Defining a color palette
Instead of hardcoding the color values like we just did, we can achieve greater flexibility in terms of colors by using the igx-palette and igx-color functions.
igx-palette generates a color palette based on the primary and secondary colors that are passed:
$yellow-color: #FFCD0F;
$black-color: #292826;
$dark-palette: igx-palette($primary: $black-color, $secondary: $yellow-color);
And then with igx-color we can easily retrieve color from the palette.
$dark-snackbar: igx-snackbar-theme(
$text-color: igx-color($dark-palette, "secondary", 400),
$background: igx-color($dark-palette, "primary", 400),
$button-color: igx-color($dark-palette, "secondary", 400),
$border-radius: 12px
);
Note
The igx-color and igx-palette are powerful functions for generating and retrieving colors. Please refer to Palettes topic for detailed guidance on how to use them.
Using Schemas
Going further with the theming engine, you can build a robust and flexible structure that benefits from schemas. A schema is a recipe of a theme.
Extend one of the two predefined schemas, that are provided for every component, in this case - dark-snackbar schema:
// Extending the dark snackbar schema
$dark-snackbar-schema: extend($_dark-snackbar,
(
text-color:(
igx-color: ("secondary", 400)
),
background: (
igx-color: ("primary", 400)
),
button-color: (
igx-color: ("secondary", 400)
),
border-radius: 12px
)
);
In order to apply our custom schemas we have to extend one of the globals (light or dark), which is basically pointing out the components with a custom schema, and after that add it to the respective component themes:
// Extending the global dark-schema
$custom-dark-schema: extend($dark-schema,(
igx-snackbar: $dark-snackbar-schema
));
// Defining snackbar theme with the global dark schema
$dark-snackbar: igx-snackbar-theme(
$palette: $dark-palette,
$schema: $custom-dark-schema
);
Don't forget to include the themes in the same way as it was demonstrated above.
Demo
API References
In this article we learned how to use and configure the IgxSnackbarComponent. For more details in regards its API, take a look at the links below:
Styles:
