Permalink
cde9ab3 Nov 29, 2016
@josephperrott @TimKlein87 @metanav @feloy
38 lines (28 sloc) 1.19 KB

MdSnackBar

MdSnackBar is a service, which opens snack bar notifications in the view.

Methods

Name Description
open(message: string, actionLabel: string, config: MdSnackBarConfig): MdSnackBarRef<SimpleSnackBar> Creates and opens a simple snack bar notification matching material spec.
openFromComponent(component: ComponentType<T>, config: MdSnackBarConfig): MdSnackBarRef<T> Creates and opens a snack bar notification with a custom component as content.

Config

Key Description
viewContainerRef: ViewContainerRef The view container ref to attach the snack bar to.
role: AriaLivePoliteness = 'assertive' The politeness level to announce the snack bar with.
announcementMessage: string The message to announce with the snack bar.
duration: number The length of time in milliseconds to wait before autodismissing the snack bar.

Example

The service can be injected in a component.

@Component({
  selector: 'my-component',
  providers: [MdSnackBar]
})
export class MyComponent {

 constructor(snackBar: MdSnackBar) {}

 failedAttempt() {
   this.snackBar.open('It didn\'t quite work!', 'Try Again');
 }

}