https://github.com/adopted-ember-addons/ember-cli-flash
Simple, highly configurable flash messages for ember-cli
https://github.com/adopted-ember-addons/ember-cli-flash
ember ember-addon flash-messages javascript
Last synced: 29 days ago
JSON representation
Simple, highly configurable flash messages for ember-cli
- Host: GitHub
- URL: https://github.com/adopted-ember-addons/ember-cli-flash
- Owner: adopted-ember-addons
- License: mit
- Created: 2015-02-01T09:12:17.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T18:33:52.000Z (about 1 year ago)
- Last Synced: 2025-04-30T10:34:29.946Z (11 months ago)
- Topics: ember, ember-addon, flash-messages, javascript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ember-cli-flash
- Size: 1.24 MB
- Stars: 354
- Watchers: 17
- Forks: 117
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - ember-cli-flash - Simple, highly configurable flash messages for ember-cli. (Packages / Real-time)
README
# ember-cli-flash
 [](http://badge.fury.io/js/ember-cli-flash)
[](http://emberobserver.com/addons/ember-cli-flash)
*Simple, highly configurable flash messages for ember.*
This ember addon adds a flash message service and component to your app.
## Table of Contents
- [ember-cli-flash](#ember-cli-flash)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Compatibility](#compatibility)
- [Usage](#usage)
- [Convenience methods (Bootstrap / Foundation alerts)](#convenience-methods-bootstrap--foundation-alerts)
- [Bootstrap](#bootstrap)
- [Foundation](#foundation)
- [Custom messages](#custom-messages)
- [Custom messages API](#custom-messages-api)
- [Animated example](#animated-example)
- [Arbitrary options](#arbitrary-options)
- [Example use case](#example-use-case)
- [Clearing all messages on screen](#clearing-all-messages-on-screen)
- [Returning flash object](#returning-flash-object)
- [Finding and removing messages by custom fields](#finding-and-removing-messages-by-custom-fields)
- [Service defaults](#service-defaults)
- [TypeScript](#typescript)
- [Basic Usage](#basic-usage)
- [Custom Fields with Generics](#custom-fields-with-generics)
- [Typing Dynamically Registered Methods](#typing-dynamically-registered-methods)
- [Displaying flash messages](#displaying-flash-messages)
- [Custom `close` action](#custom-close-action)
- [Styling with Foundation or Bootstrap](#styling-with-foundation-or-bootstrap)
- [Styling with user-specified message type class prefix](#styling-with-user-specified-message-type-class-prefix)
- [Sort messages by priority](#sort-messages-by-priority)
- [Rounded corners (Foundation)](#rounded-corners-foundation)
- [Custom flash message component](#custom-flash-message-component)
- [Test helpers](#test-helpers)
- [Testing](#testing)
- [Styling](#styling)
- [Upgrading](#upgrading)
- [License](#license)
- [Contributors](#contributors)
## Installation
```shell
ember install ember-cli-flash
```
## Compatibility
- Ember.js v4.12 or above
- Embroider or ember-auto-import v2
- TypeScript 5.x (optional)
This addon is tested against the Ember `release`, `beta` and `canary` channels.
## Usage
Usage is very simple. First, add one of the [template examples](#displaying-flash-messages) to your app. Then, inject the `flashMessages` service and use one of its convenience methods:
```typescript
import Component from '@glimmer/component';
import { service } from '@ember/service';
import type { FlashMessagesService } from 'ember-cli-flash';
export default class MyComponent extends Component {
@service declare flashMessages: FlashMessagesService;
}
```
Or in JavaScript:
```javascript
import Component from '@glimmer/component';
import { service } from '@ember/service';
export default class MyComponent extends Component {
@service flashMessages;
}
```
### Convenience methods (Bootstrap / Foundation alerts)
You can quickly add flash messages using these methods from the service:
#### Bootstrap
- `.success`
- `.warning`
- `.info`
- `.danger`
#### Foundation
- `.success`
- `.warning`
- `.info`
- `.alert`
- `.secondary`
These will add the appropriate classes to the flash message component for styling in Bootstrap or Foundation. For example:
```javascript
// Bootstrap: the flash message component will have 'alert alert-success' classes
// Foundation: the flash message component will have 'alert-box success' classes
this.flashMessages.success('Success!');
```
You can take advantage of Promises, and their `.then` and `.catch` methods. To add a flash message after saving a model (or when it fails):
```javascript
import { action } from '@ember/object';
// In your component or controller class...
@action
saveFoo() {
this.model
.save()
.then((res) => {
this.flashMessages.success('Successfully saved!');
doSomething(res);
})
.catch((err) => {
this.flashMessages.danger('Something went wrong!');
handleError(err);
});
}
```
Or with async/await:
```javascript
@action
async saveFoo() {
try {
const res = await this.model.save();
this.flashMessages.success('Successfully saved!');
doSomething(res);
} catch (err) {
this.flashMessages.danger('Something went wrong!');
handleError(err);
}
}
```
### Custom messages
If the convenience methods don't fit your needs, you can add custom messages with `add`:
```javascript
this.flashMessages.add({
message: 'Custom message',
});
```
#### Custom messages API
You can also pass in options to custom messages:
```javascript
this.flashMessages.add({
message: 'I like alpacas',
type: 'alpaca',
timeout: 500,
priority: 200,
sticky: true,
showProgress: true,
extendedTimeout: 500,
destroyOnClick: false,
onDestroy() {
// behavior triggered when flash is destroyed
},
});
this.flashMessages.success('This is amazing', {
timeout: 100,
priority: 100,
sticky: false,
showProgress: true,
});
```
- `message: string`
Required when `preventDuplicates` is enabled. The message that the flash message displays.
- `type?: string`
Default: `info`
This is mainly used for styling. The flash message's `type` is set as a class name on the rendered component, together with a prefix. The rendered class name depends on the message type that was passed into the component.
- `timeout?: number`
Default: `3000`
Number of milliseconds before a flash message is automatically removed.
- `priority?: number`
Default: `100`
Higher priority messages appear before low priority messages. The best practise is to use priority values in multiples of `100` (`100` being the lowest priority). Note that you will need [modify your template](#sort-messages-by-priority) for this work.
- `sticky?: boolean`
Default: `false`
By default, flash messages disappear after a certain amount of time. To disable this and make flash messages permanent (they can still be dismissed by click), set `sticky` to true.
- `showProgress?: boolean`
Default: `false`
To show a progress bar in the flash message, set this to true.
- `extendedTimeout?: number`
Default: `0`
Number of milliseconds before a flash message is removed to add the class 'exiting' to the element. This can be used to animate the removal of messages with a transition.
- `destroyOnClick?: boolean`
Default: `true`
By default, flash messages will be destroyed on click. Disabling this can be useful if the message supports user interaction.
- `onDestroy: function`
Default: `undefined`
A function to be called when the flash message is destroyed.
### Animated example
To animate messages, set `extendedTimeout` to something higher than zero when adding flash messages:
```javascript
this.flashMessages.success('Saved!', {
extendedTimeout: 500,
});
```
Then animate using CSS transitions, using the `.active` and `.active.exiting` classes.
```scss
.alert {
opacity: 0;
position: relative;
left: 100px;
transition: all 700ms cubic-bezier(0.68, -0.55, 0.265, 1.55);
&.active {
opacity: 1;
left: 0px;
&.exiting {
opacity: 0;
left: 100px;
}
}
}
```
### Arbitrary options
You can also add arbitrary options to messages:
```javascript
this.flashMessages.success('Cool story bro', {
someOption: 'hello',
});
this.flashMessages.add({
message: 'hello',
type: 'foo',
componentName: 'some-component',
content: customContent,
});
```
#### Example use case
This makes use of the [component helper](http://emberjs.com/blog/2015/03/27/ember-1-11-0-released.html#toc_component-helper), allowing the template that ultimately renders the flash to be dynamic:
```gjs
import Component from '@glimmer/component';
import { service } from '@ember/service';
import { FlashMessage } from 'ember-cli-flash';
export default class MyComponent extends Component {
@service flashMessages;
{{#each this.flashMessages.queue as |flash|}}
{{#if flash.componentName}}
{{component flash.componentName content=flash.content}}
{{else}}
{{component.flashType}}
{{flash.message}}
{{/if}}
{{/each}}
}
```
### Clearing all messages on screen
It's best practice to use flash messages sparingly, only when you need to notify the user of something. If you're sending too many messages, and need a way for your users to clear all messages from screen, you can use this method:
```javascript
this.flashMessages.clearMessages();
```
### Returning flash object
The flash message service is designed to be Fluent, allowing you to chain methods on the service easily. The service should handle most cases but if you want to access the flash object directly, you can use the `getFlashObject` method:
```javascript
const flashObject = this.flashMessages.add({
message: 'hola',
type: 'foo',
}).getFlashObject();
```
You can then manipulate the `flashObject` directly. Note that `getFlashObject` must be the last method in your chain as it returns the flash object directly.
### Finding and removing messages by custom fields
If you need to track and manage flash messages by a custom identifier (e.g., for notifications that need to be updated or dismissed programmatically), you can use `findBy` and `removeBy`:
```typescript
// Add a flash with a custom id
this.flashMessages.success('Processing...', {
id: 'upload-progress',
});
// Later, find and update or remove it
const flash = this.flashMessages.findBy('id', 'upload-progress');
if (flash) {
flash.destroyMessage();
}
// Or use removeBy for a simpler one-liner
this.flashMessages.removeBy('id', 'upload-progress');
```
This is useful for scenarios like:
- Dismissing a specific notification when an action completes
- Replacing a "loading" message with a "success" message
- Managing notifications by category or source
## Service defaults
To customize default values, extend the service and override the `flashMessageDefaults` getter:
```typescript
// app/services/flash-messages.ts
import { FlashMessagesService } from 'ember-cli-flash';
export default class MyFlashMessages extends FlashMessagesService {
get flashMessageDefaults() {
return {
...super.flashMessageDefaults,
// flash message defaults
timeout: 5000,
extendedTimeout: 0,
priority: 200,
sticky: true,
showProgress: true,
// service defaults
type: 'alpaca',
types: ['alpaca', 'notice', 'foobar'],
preventDuplicates: false,
};
}
}
```
Or in JavaScript:
```javascript
// app/services/flash-messages.js
import { FlashMessagesService } from 'ember-cli-flash';
export default class MyFlashMessages extends FlashMessagesService {
get flashMessageDefaults() {
return {
...super.flashMessageDefaults,
timeout: 5000,
extendedTimeout: 0,
priority: 200,
sticky: true,
showProgress: true,
type: 'alpaca',
types: ['alpaca', 'notice', 'foobar'],
preventDuplicates: false,
};
}
}
```
See the [options](#custom-messages-api) section for information about flash message specific options.
- `type?: string`
Default: `info`
When adding a custom message with `add`, if no `type` is specified, this default is used.
- `types?: array`
Default: `[ 'success', 'info', 'warning', 'danger', 'alert', 'secondary' ]`
This option lets you specify exactly what types you need, which means in the above example, you can do `this.flashMessages.{alpaca,notice,foobar}`.
- `preventDuplicates?: boolean`
Default: `false`
If `true`, only 1 instance of a flash message (based on its `message`) can be added at a time. For example, adding two flash messages with the message `"Great success!"` would only add the first instance into the queue, and the second is ignored.
## TypeScript
This addon is fully typed and supports TypeScript out of the box.
### Basic Usage
The service and components work seamlessly with TypeScript:
```typescript
import Component from '@glimmer/component';
import { service } from '@ember/service';
import type { FlashMessagesService } from 'ember-cli-flash';
export default class MyComponent extends Component {
@service declare flashMessages: FlashMessagesService;
showNotification() {
this.flashMessages.success('Operation completed!');
}
}
```
### Custom Fields with Generics
If your app adds custom fields to flash messages (like `id`, `category`, or `action`), you can get full type safety by using generics:
```typescript
// app/services/flash-messages.ts
import { FlashMessagesService } from 'ember-cli-flash';
interface CustomFlashFields {
id?: string;
category?: 'system' | 'user' | 'background';
action?: () => void;
}
export default class MyFlashMessages extends FlashMessagesService {
get flashMessageDefaults() {
return {
...super.flashMessageDefaults,
timeout: 5000,
};
}
}
// Don't forget to re-export the type
declare module '@ember/service' {
interface Registry {
'flash-messages': MyFlashMessages;
}
}
```
Now you get type checking for your custom fields:
```typescript
// Type-safe custom fields
this.flashMessages.success('File uploaded', {
id: 'upload-123',
category: 'user',
});
// TypeScript will catch typos
this.flashMessages.success('Oops', {
categroy: 'user', // Error: Did you mean 'category'?
});
```
Custom fields are also type-safe in templates. The `FlashMessage` component exposes the properly typed flash object with your custom fields:
```gjs
import { FlashMessage } from 'ember-cli-flash';
{{#each this.flashMessages.queue as |flash|}}
{{flash.message}}
{{flash.category}} {{! ✓ Typed as 'system' | 'user' | 'background' | undefined }}
{{#if flash.action}}
Action
{{/if}}
{{/each}}
```
### Typing Dynamically Registered Methods
When you configure custom `types` in `flashMessageDefaults`, the service dynamically creates convenience methods for each type at runtime. The base class already declares types for the default methods (`success`, `info`, `warning`, `danger`, `alert`, `secondary`), but TypeScript doesn't automatically recognize any custom types you add.
To get type safety for custom type methods, declare them explicitly in your service subclass:
```typescript
import { FlashMessagesService } from 'ember-cli-flash';
import type { FlashObjectOptions } from 'ember-cli-flash';
interface CustomFlashFields {
id?: string;
category?: string;
}
type Options = FlashObjectOptions & CustomFlashFields;
export default class MyFlashMessages extends FlashMessagesService {
// Only declare custom types not in the base class
// (success, info, warning, danger, alert, secondary are already typed)
declare error: (message: string, options?: Options) => this;
declare custom: (message: string, options?: Options) => this;
get flashMessageDefaults() {
return {
...super.flashMessageDefaults,
types: ['error', 'success', 'warning', 'custom'],
};
}
}
```
This pattern uses TypeScript's `declare` keyword to inform the type system about methods that exist at runtime but aren't defined in the base class types.
## Displaying flash messages
Then, to display somewhere in your app, add this to your component:
```gjs
import Component from '@glimmer/component';
import { service } from '@ember/service';
import { FlashMessage } from 'ember-cli-flash';
export default class MyComponent extends Component {
@service flashMessages;
{{#each this.flashMessages.queue as |flash|}}
{{/each}}
}
```
It also accepts your own template:
```gjs
import Component from '@glimmer/component';
import { service } from '@ember/service';
import { FlashMessage } from 'ember-cli-flash';
export default class MyComponent extends Component {
@service flashMessages;
{{#each this.flashMessages.queue as |flash|}}
{{component.flashType}}
{{flash.message}}
{{#if component.showProgressBar}}
{{/if}}
{{/each}}
}
```
### Custom `close` action
The `close` action is always passed to the component whether it is used or not. It can be used to implement your own close button, such as an `x` in the top-right corner.
When using a custom `close` action, you will want to set `destroyOnClick=false` to override the default (`destroyOnClick=true`). You could do this globally in `flashMessageDefaults`.
```gjs
import { on } from '@ember/modifier';
import { FlashMessage } from 'ember-cli-flash';
{{#each @flashMessages.queue as |flash|}}
{{flash.message}}
x
{{/each}}
```
### Styling with Foundation or Bootstrap
By default, flash messages will have Bootstrap style class names. If you want to use Foundation, simply specify the `messageStyle` on the component:
```gjs
import { FlashMessage } from 'ember-cli-flash';
{{#each @flashMessages.queue as |flash|}}
{{/each}}
```
### Styling with user-specified message type class prefix
If you don't wish to use the class names associated with Bootstrap / Foundation, specify the `messageStylePrefix` on the component. This will override the class name prefixes with your own. For example, `messageStylePrefix='special-alert-'` would create flash messages with the class `special-alert-succcess`
```gjs
import { FlashMessage } from 'ember-cli-flash';
{{#each @flashMessages.queue as |flash|}}
{{/each}}
```
### Sort messages by priority
To display messages sorted by priority, use `arrangedQueue` instead of `queue`:
```gjs
import { FlashMessage } from 'ember-cli-flash';
{{#each @flashMessages.arrangedQueue as |flash|}}
{{/each}}
```
### Rounded corners (Foundation)
To add `radius` or `round` type corners in Foundation:
```gjs
import { FlashMessage } from 'ember-cli-flash';
{{#each @flashMessages.arrangedQueue as |flash|}}
{{/each}}
```
```gjs
import { FlashMessage } from 'ember-cli-flash';
{{#each @flashMessages.arrangedQueue as |flash|}}
{{/each}}
```
### Custom flash message component
If the provided component isn't to your liking, you can easily create your own. All you need to do is pass in the `flash` object to that component:
```gjs
import CustomComponent from './custom-component';
{{#each @flashMessages.queue as |flash|}}
{{/each}}
```
## Test helpers
This addon provides helper functions for enabling and disabling flash message timeouts at any time during test runs.
Timeouts are initially disabled during test runs.
- `enableTimeout: () => void`
```js
import { enableTimeout } from 'ember-cli-flash/test-support';
```
Globally enables flash messages removal after `timeout`.
- `disableTimeout: () => void`
```js
import { disableTimeout } from 'ember-cli-flash/test-support';
```
Globally prevents flash messages from being removed after `timeout`.
These test helpers may be used to enable and disable timeouts granularly, or even for your entire test suite.
```javascript
// tests/acceptance/foo-page-test.js
import { module, test } from 'qunit';
import { setupApplicationTest } from 'ember-qunit';
import { click, visit } from '@ember/test-helpers';
import { enableTimeout, disableTimeout } from 'ember-cli-flash/test-support';
module('Application | Component | foo-page', function (hooks) {
setupApplicationTest(hooks);
module('with flash message timeout' function (hooks) {
hooks.before(function () {
// Enable timeout for tests within this module
enableTimeout();
});
hooks.after(function () {
// Clean up by disabling timeout again
disableTimeout();
})
test('flash message is removed after 5 seconds', async function (assert) {
assert.expect(1);
await visit('/');
await click('.button-that-opens-alert');
assert.dom('.alert.alert-success').doesNotExist(
'Timer was removed due to `timeout: 5_000`'
);
});
});
});
```
## Testing
Some example tests below, based on QUnit.
An example acceptance test:
```javascript
// tests/acceptance/foo-page-test.js
import { module, test } from 'qunit';
import { setupApplicationTest } from 'ember-qunit';
import { click, visit } from '@ember/test-helpers';
module('Application | Component | foo-page', function (hooks) {
setupApplicationTest(hooks);
test('flash message is rendered', async function (assert) {
assert.expect(1);
await visit('/');
await click('.button-that-opens-alert');
assert.dom('.alert.alert-success').exists({ count: 1 });
});
});
```
An example integration test:
```javascript
// tests/integration/components/x-foo-test.js
import { module, test } from 'qunit';
import { setupRenderingTest } from 'ember-qunit';
import { render } from '@ember/test-helpers';
import { hbs } from 'ember-cli-htmlbars';
module('Integration | Component | x-foo', function (hooks) {
setupRenderingTest(hooks);
hooks.beforeEach(function () {
// Register any types you expect to use in this component
const typesUsed = ['info', 'warning', 'success'];
this.owner.lookup('service:flash-messages').registerTypes(typesUsed);
});
test('it renders', async function (assert) {
await render(hbs``);
// ...
});
});
```
For unit tests that require the `flashMessages` service:
```js
import { module, test } from 'qunit';
import { setupTest } from 'ember-qunit';
module('Unit | Route | foo', function (hooks) {
setupTest(hooks);
hooks.beforeEach(function () {
const typesUsed = ['info', 'warning', 'success'];
this.owner.lookup('service:flash-messages').registerTypes(typesUsed);
});
test('it does the thing', function (assert) {
const subject = this.owner.lookup('route:foo');
// ...
});
});
```
## Styling
This addon is minimal and does not currently ship with a stylesheet. You can style flash messages by targeting the appropriate alert classes in your CSS.
## Upgrading
See [UPGRADING.md](UPGRADING.md) for migration guides between major versions.
## License
[MIT](LICENSE.md)
## Contributors
We're grateful to these wonderful contributors who've contributed to `ember-cli-flash`:
[//]: contributor-faces
[//]: contributor-faces