Which color band to use?
- Blue Band: To show different kinds of notification: Depending on the notification type, there will be a close button to remove the band or it might disappear after a designated time.
- Red Band: To show system alerts (for e.g.: System Shutdown / Database Not Available etc). Note: This should not be used to display the form errors and validations. This will have a 'X' button to close the band.
- Green Band: To show success messages. These will disappear after a designated time.
Usage
To display a site notification, a method of Causeway global object needs to be invoked.
Examples:
For normal(blue) site notification
Causeway.topNotification.show() // for showing
Causeway.topNotification.hide() // for hiding
You can pass Options as an object to get various type of notifications.
To show system alert - Causeway.topNotification.show({'type':'alert'})
To show success message - Causeway.topNotification.show({'type':'success'})
Options that can be used:
- autoClose | boolean | default: false
- duration | number in milliseconds | default: 5000
- type | string: alert or success | default: normal blue band
- message | string or html fragment: message | default: default type of message