summaryrefslogtreecommitdiff
path: root/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/notification-box/doc/main.md
diff options
context:
space:
mode:
Diffstat (limited to 'data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/notification-box/doc/main.md')
-rw-r--r--data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/notification-box/doc/main.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/notification-box/doc/main.md b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/notification-box/doc/main.md
new file mode 100644
index 0000000..3888af0
--- /dev/null
+++ b/data/extensions/jid1-KtlZuoiikVfFew@jetpack/node_modules/notification-box/doc/main.md
@@ -0,0 +1,53 @@
+NotificationBox implements some of the notificationbox element functionality in Firefox and Mozilla-based browsers using the Addon SDK. For any question or feedback please email lduros--at--member.fsf.org
+
+You can create a notification as follows:
+```javascript
+var self = require("self");
+var notification = require("notification-box").NotificationBox({
+ 'value': 'important-message',
+ 'label': 'This is a very important message!',
+ 'priority': 'CRITICAL_BLOCK',
+ // Automatically close notification in 5s
+ 'timeout': 5000,
+ // How many page changes the notification will stay active for
+ 'persistence': 2,
+ 'image': self.data.url("gnu-icon.png"),
+ 'buttons': [{'label': "Do something about it!",
+ 'onClick': function () { console.log("You clicked the important button!"); }}]
+});
+```
+
+It implements the following options:
+
+ - value: value used to identify the notification
+ - label: label to appear on the notification
+ - image: URL of image to appear on the notification. You can also
+ load a local image from the data folder, like in the example
+ - timeout: How many milliseconds until the notification will automatically close
+ - persistence: How many page changes the notification will stay active for
+ - eventCallback: Function to call when notification closes (arg1: reason)
+ - priority: notification priority. Use one of the following:
+ - INFO_LOW
+ - INFO_MEDIUM
+ - INFO_HIGH
+ - WARNING_LOW
+ - WARNING_MEDIUM
+ - WARNING_HIGH
+ - CRITICAL_LOW
+ - CRITICAL_MEDIUM
+ - CRITICAL_HIGH
+ - CRITICAL_BLOCK
+ - buttons: array of buttons to appear on the notification.
+ You can use the following options:
+ - accessKey: the accesskey to appear on the button
+ - onClick: the callback function to trigger when button is activated.
+ - label: the text to display on the button
+
+
+Here is an overview of what the example above with the critical notification looks like:
+![The Critical notification](https://raw.github.com/lduros/notificationbox/master/doc/images/critical-notification.png)
+
+When using 'INFO_LOW' for the priority instead, you would see:
+![Info Low notification](https://raw.github.com/lduros/notificationbox/master/doc/images/info-low-priority.png)
+
+For more information on notificationbox: https://developer.mozilla.org/en-US/docs/XUL/notificationbox