diff options
author | Nik Nyby <nnyby@columbia.edu> | 2015-10-24 11:50:56 -0400 |
---|---|---|
committer | Nik Nyby <nnyby@columbia.edu> | 2015-10-24 11:50:56 -0400 |
commit | af0fdf2afd5b42a041d97f33170d17d6f18253af (patch) | |
tree | b31f8c59c4ed9d05fa5eaa2f95a204a1f46787f6 /packages/notificationbox/doc/main.md | |
parent | da101e8eb9da3808b3bd75d571e40d5c2f139d9d (diff) | |
parent | 59597067c21e52ae94340801d4bf6e3a9825c7a3 (diff) | |
download | librejsxul-af0fdf2afd5b42a041d97f33170d17d6f18253af.tar.lz librejsxul-af0fdf2afd5b42a041d97f33170d17d6f18253af.tar.xz librejsxul-af0fdf2afd5b42a041d97f33170d17d6f18253af.zip |
Merge pull request #5 from nikolas/jpm
jpm
Diffstat (limited to 'packages/notificationbox/doc/main.md')
-rw-r--r-- | packages/notificationbox/doc/main.md | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/packages/notificationbox/doc/main.md b/packages/notificationbox/doc/main.md deleted file mode 100644 index 2c28c3a..0000000 --- a/packages/notificationbox/doc/main.md +++ /dev/null @@ -1,46 +0,0 @@ -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', - '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 - - 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: - - -When using 'INFO_LOW' for the priority instead, you would see: - - -For more information on notificationbox: https://developer.mozilla.org/en-US/docs/XUL/notificationbox |