Bar Overlay (a!barOverlay)

Layouts

Bar Overlay

SAIL Design System guidance available for Billboard Layout

When you need to get a user's attention, use the billboard layout. Learn how to broadcast the right message and create powerful, visual prominence for sections that shouldn't be ignored.

Function

a!barOverlay( position, contents, showWhen, style, padding )

Displays a horizontal bar overlay for use in billboard layout.

Parameters

Name	Keyword	Types	Description
Position	`position`	Text	Determines where the bar overlay appears. Valid values: `"TOP"`, `"MIDDLE"`, `"BOTTOM"` (default).
Contents	`contents`	Any Type	The interface to display in the overlay. Accepts layouts and display components. Supported layouts and components: Box, Button, Card, Columns, Image, Link, Milestone, Progress Bar, Rich Text, Section, Side By Side.
Visibility	`showWhen`	Boolean	Determines whether the overlay is displayed on the interface. When set to false, the overlay is hidden and is not evaluated. Default: true.
Style	`style`	Text	Determines the overlay style. Valid values: `"DARK"` (default), `"SEMI_DARK"`, `"NONE"`, `"SEMI_LIGHT"`, `"LIGHT"`.
Padding	`padding`	Text	Determines the space between the overlay's edges and its contents. Valid values: `"NONE"`, `"EVEN_LESS"`, `"LESS"`, `"STANDARD"`(default), `"MORE"`, `"EVEN_MORE"`.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Bar overlay with intro message

a!billboardLayout(
  backgroundcolor: "#073763",
  marginBelow: "STANDARD",
  overlay: a!barOverlay(
    position: "MIDDLE",
    contents: {
      a!richTextDisplayField(
        labelPosition: "COLLAPSED",
        value: {
          a!richTextItem(text: {"Hello, " & user(loggedinuser(), "firstName") & "."}, size: "MEDIUM"),
          char(10),
          a!richTextItem(text: {"What do you need help with?"}, size: "LARGE")
        },
        align: "CENTER"
      )
    },
    style: "DARK"
  )
)

Displays the following:

Bar Overlay Example

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Bar Overlay.

Cards as List Items Patterns (Choice Components, Images): Use the cards as list items pattern to create visually rich lists as an alternative to grids or feeds. This pattern uses a combination of cards and billboards to show lists of like items. You can easily modify the pattern to change the card content or the number of cards per row to fit your use case.