Web Content Component

Web Content

Function: a!webContentField()

Displays content from an external source.

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.

Notes

  • 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/.
  • This component supports displaying external content only. Internal Appian interfaces and Appian URLs are not supported.
  • 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.

Examples

1
2
3
4
5
6
=a!webContentField(
  source: "https://www.appian.com/",
  height: "MEDIUM",
  showBorder: true,
  altText: "Appian Corporation"
)
Open in Github Built: Thu, Feb 23, 2023 (02:59:22 PM)

On This Page

FEEDBACK