Banners appear at the very top of the screen, above the application header, and are reserved for system-level messaging about loss of data or functionality.
| API status: | general |
|---|---|
| Included in AUI core? | Not in core You must explicitly require the web resource key. |
| Web resource key: |
com.atlassian.auiplugin:aui-banner
|
| AMD Module key: |
require('aui/banner')
|
| Experimental API: | 5.7 |
| General API: | 6 |
A banner can be created either through Application Header soy template or the Javascript API.
The Javascript API is intended for use when HTTP 5xx errors are received from the server.
These options are set in the options object when creating a flag with JavaScript:
| Option | Description | Possible values | Default |
|---|---|---|---|
body |
The main content of the message. | HTML | none |