Ember-frost-notifier NPM

ember-frost-notifier

Dependencies

Health

Security

Ember Observer score

A service and component for managing application notifications

Installation

ember install ember-frost-notifier

API

ember-frost-notifier registers the notifier service which can be injected into your controllers and routes to add and remove notifications. You must have only one {{frost-notifier}} in your application template to display these notifications.

Methods

addNotification

Adds a single notification to the list. Takes a single parameter options and returns the notification object.

NotificationOption:

Name	Type	Description
`message`	`String`	Message to display
`details`	`Object`	details to pass to onDetailsClick
`onDetailsClick`	`Function`	callback for when the details is clicked
`type`	`String`	type of notification (success, info, warning, error)
`autoClear`	`Boolean`	whether to dismiss notification automatically
`clearDuration`	`Number`	time in ms to dismiss if autoCleared

removeNotification

Removes a single notification from the list. Takes the instance of the notification

clearAll

Removes all notifications.

Examples

In your application/template.hbs:

{{frost-notifier}}
{{outlet}}

In your controller:

import Ember from 'ember'

export default Ember.Controller.extend({
	notifier: Ember.inject.service('notifier'),
	actions: {
		showNotification () {
			this.get('notifier').addNotification({
				message: 'Something terribly bad happened',
				details: 'It was bad. It was really really bad!',
				onDetailsClick (details) {
					console.log(details)
				},
				type: 'error',
				autoClear: false,
			})
		}
	}
})

You can also close over the context of a component to send actions, such as:

onDetailsClick: (details) => {
  this.send('someAction', details)
}

Testing with ember-hook

This addon has been optimized for use with ember-hook. You can set a hook name on your notifier template. This will allow you to access the internal notifier content for testing.