Heading Component

Function

a!headingField()( text, size, headingTag, color, fontWeight, Link, showWhen, align, marginAbove, marginBelow ) The headings component is a way to intuitively structure and easily organize your interface with both visual and non-visual indicators to help all users quickly understand your content. Headings are flexible and can be used inside layouts, forms, columns, and overlays, excluding grids.

Displays a heading with configurations for the color, size, and font weight. Also supports heading accessibility tags, which are used by screen readers and produce no visible change.

Parameters

Name	Keyword	Types	Description
Text	`text`	Text	Text to display in the header
Size	`size`	Text	Determines the text size. Valid values: `"LARGE_PLUS"`, `"LARGE"`, `"MEDIUM_PLUS"` (default), `"MEDIUM"`, `"SMALL"`, `"EXTRA_SMALL"`.
Accessibility Heading Tag	`headingTag`	Text	Determines the heading tag associated with the text for use by screen readers; produces no visible change. Valid values: `"H1"`, `"H2"`, `"H3"`, `"H4"`, `"H5"`, `"H6"`. The default is dependent on the chosen label size. For more information on heading tags, see our heading accessibility guidance.
Color	`color`	Text	Determines the label color. Valid values: Any valid hex color or `"ACCENT"`, `"STANDARD"` (default), and `"SECONDARY"`.
Font Weight	`fontWeight`	Text	Determines the thickness to apply to the text value. Valid values include `"LIGHT"`, `"REGULAR"` (Default), `"SEMI_BOLD"`, and `"BOLD"`.
Link	`Link`	Any Type	Link to apply to the text. Create a link with: a!authorizationLink() a!documentDownloadLink() a!dynamicLink() a!newsEntryLink() a!processTaskLink() a!recordLink() a!reportLink() a!startProcessLink() a!submitLink() a!userRecordLink() a!safeLink() If more than one link is provided, only the first will be used.
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`.
Alignment	`align`	Text	Determines alignment of the text. Valid values: `"START"` (default), `"CENTER"`, `"END"`.
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"`, `"MORE"` (default), `"EVEN_MORE"`.

Examples

Use the interactive editor below to test out your code in the provided examples.

Full interface with cards and multiple heading components

Screenshot of a full campsite interface with cards and multiple heading components

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.
Process Autoscaling	Compatible

Feedback

Was this page helpful?

Heading Component

Function

Parameters

Examples