Web Content Component (a!webContentField)

Display

Web Content Component

Function

a!webContentField( label, labelPosition, instructions, helpTooltip, showWhen, source, showBorder, height, altText, disabled, accessibilityText, marginAbove, marginBelow )

Displays content inline from an external source.

Note: To protect users from how Safari handles memory, the Web Content component will display as an inline link when viewed in those browsers.

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Text to display as the field label.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"ABOVE"` (default) Displays the label above the component. `"ADJACENT"` Displays the label to the left of the component. `"COLLAPSED"` Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. `"JUSTIFIED"` Aligns the label alongside the component starting at the edge of the page.
Instructions	`instructions`	Text	Supplemental text about this field.
Help Tooltip	`helpTooltip`	Text	Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is `"COLLAPSED"`.
Visibility	`showWhen`	Boolean	Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.
Source	`source`	Safe URI	Location of the external content.
Show Border	`showBorder`	Boolean	Determines whether the field has an outer border. Default: false.
Height	`height`	Text	Determines the layout height. Valid values: `"SHORT"`, `"MEDIUM"` (default), `"TALL"`.
Alternative Text	`altText`	Text	Equivalent alternate text provided to assistive technology.
Disabled	`disabled`	Boolean	Determines if the user is prevented from interacting with the web content. Default: false.
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Margin Above	`marginAbove`	Text	Determines how much space is added above the layout. Valid values: `"NONE"` (default), `"EVEN_LESS"`, `"LESS"`, `"STANDARD"`, `"MORE"`, `"EVEN_MORE"`.
Margin Below	`marginBelow`	Text	Determines how much space is added below the layout. Valid values: `"NONE"`, `"EVEN_LESS"`, `"LESS"`, `"STANDARD"` (default), `"MORE"`, `"EVEN_MORE"`.

Usage considerations

Embedding content

Not all content can be embedded. The best way to know if your content can be embedded or not is to test it. If it can't be embedded, the component will be empty. Some sources explicitly prevent being embedded, such as https://www.google.com and https://www.yahoo.com/.
Screen readers will typically announce the embedded page's title (found in the <title> attribute). When no title is provided, the altText value is used.

Supported content

This component supports displaying external content only. Internal Appian interfaces and Appian URLs are not supported.

Examples

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

Web content

a!webContentField(
  source: "https://example.com",
  height: "MEDIUM",
  showBorder: true,
  altText: "Example Domain"
)

Feature compatibility

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

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Incompatible
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.

Web Content Component