diff --git a/modules/default/alert/README.md b/modules/default/alert/README.md index 4eb1428a..756859f9 100644 --- a/modules/default/alert/README.md +++ b/modules/default/alert/README.md @@ -76,7 +76,60 @@ self.sendNotification("SHOW_NOTIFICATION", message); ``` self.sendNotification("SHOW_ALERT", {title: "Hello", message: "This is a test!", type: "success", imageUrl:"url", imageSize: "50x50", timer:1000}); ``` -All parameters exept for `title` and `message` are optional. Possible types are `error`, `warning`, `info` and `success`. If you do not use the `timer` parameter, it is your responsibility to manually hide the alert by using `self.sendNotification("HIDE_ALERT");`! +
Option | +Description | +
---|---|
title |
+ The title of the alert. + Possible values: text or html as a string
+ |
+
message |
+ The message of the alert. + Possible values: text or html as a string
+ |
+
type (optional) |
+ The type of the alert. + Possible values: error , warning , info and success
+ Default value: none
+ |
+
imageUrl (optional) |
+ Image to show in the alert + Possible values: url as string
+ Default value: none
+ |
+
imageSize (optional even with imageUrl set) |
+ Size of the image + Possible values: " width xheight " as string
+ Default value: none
+ |
+
timer (optional) |
+ How long the alert should stay visible. + Possible values: any int
+ Default value: none
+ Important: If you do not use the `timer`, it is your duty to hide the alert by using self.sendNotification("HIDE_ALERT"); !
+ |
+