Banners
Summary
Banners appear at the very top of the screen, within the application header, and are reserved for system-level messaging about loss of data or functionality.
Status
| API status: | general |
|---|---|
| Web resource key: |
com.atlassian.auiplugin:aui-banner
|
| AMD Module key: |
require('aui/banner')
|
| Experimental API: | 5.7 |
| General API: | 6 |
Examples
Code
A banner can be created either through Application Header soy template or the Javascript API.
Soy
Javascript
The Javascript API is intended for use when HTTP 5xx errors are received from the server.
Options
JavaScript options
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 |