Retired Documentation
You are using the documentation for version 2.11.9. Go here for the latest version or check here for your available upgrades to the latest version.
Javascript Notification Plugin¶
The javascript notification plugin provides a unified way to notify users of javascript triggered control panel events.
Showing a Notification¶
-
$.ee_notice(message, params)¶ The notification plugin is loaded automatically. To show a notification, simply call the plugin with your notice text.
$.ee_notice("Igor, set up program five!");
Arguments: - message (mixed) – The message to show, or an array containing objects that hold messages (see Multiple Notifications below)
- params (object) – Object containing parameters for the notice (see Parameters below)
Returns: The object that sent the notice
Return type: $.ee_notice
Multiple Notifications¶
The plugin can show multiple notifications at once. Notifications will be grouped by type, and consecutive notifications with identical messages will increment a counter next to the first message. You can either call the plugin multiple times, or you can provide an array of messages:
$.ee_notice([
{message:"Show me First"},
{message:"Show me Second"}
]);
Parameters¶
The plugin also accepts a second argument that you can use to control the behavior of the notification. These parameters must be passed in the form of a javascript object.
$.ee_notice("I'm here to stay", {open: true});
Hiding the Notifications¶
-
$.ee_notice.destroy()¶ The notification can be manually hidden either by hitting the x in the top right corner of the dropdown, or by clicking anywhere on the notification and moving the mouse off the notification body. You can also hide the notification programmatically using the destroy function.
To avoid overriding important system notifications, this function should only be used in your own module control panel. Never from an accessory.
$.ee_notice.destroy();
Return type: Void