Banner
A toned notice with a title, a message and an optional dismiss button.
A toned notice with a title, a message and an optional dismiss button.
Add it to an app
- Open the app builder and find Banner in the component palette.
- Insert it into the intended region or container.
- Set its properties in the inspector. Use a literal for a fixed value or a binding for a value supplied by the app.
- Connect its events where the app should respond to a user gesture.
- Preview with representative data and save after resolving validation problems.
The type name in the builder’s code view is banner.
Settings
| Setting | Accepted value | Required | Default | What it controls |
|---|---|---|---|---|
dismissLabel (dismissLabel) | string | No | "Dismiss" | — |
dismissible (dismissible) | boolean | No | false | — |
message (message) | string | No | "" | — |
title (title) | string | No | "" | — |
tone (tone) | string | No | "info" | — |
Values available to bindings
This component declares no published values. Use its settings and any events to configure its behaviour.
Events
onDismiss— Available to connect to an action in the event editor.
Connect only the actions the app needs. An event can fetch results, run an enabled data source, set state, update another component, show a notification, or navigate where supported.
Example: A starting configuration
| Setting | Example value |
|---|---|
dismissible | true |
message | "The workspace is read-only between 22:00 and 23:00 UTC." |
title | "Scheduled maintenance" |
tone | "warning" |
If it is empty or unavailable
Check the source binding, the selected item, and the app’s access. A hosted document, table, review, or storage component needs the corresponding app capability; an offline preview cannot supply live private data. A source running with no results is different from an invalid binding. Inspect the app’s workflow and data source before changing the presentation.