Headline Component

1. Overview

The HEADLINE component provides styled text headings within forms to organize content into sections. Supports h1, h2, and h3 heading levels, with h1 optionally including a subline.

🛝 Use the Dynamic Form Playground to see the Headline component in action and try out different configurations

2. Key Features

  • Three heading levels: h1, h2, and h3
  • Optional subline text for h1 headings only
  • Translation and string interpolation support
  • Semantic HTML structure for accessibility

3. Configuration Properties

Base Properties

PropertyTypeRequiredDescription
type'HEADLINE'YesSpecifies the field type as HEADLINE.
idstringYesUnique identifier for the field.
renderNamestringNoOptional name added as data-render-name attribute to locate the rendered element in the DOM.
labelstringYesThe headline text content. Supports translation and string interpolation.
testIdstringNoTest identifier for automated testing. Set as data-testid attribute.
aclarrayNoAccess control rules for field visibility/editability. Each rule has state ('hidden', 'readonly', 'disabled', 'visible', 'editable') and optional condition (Filtrex expression).
columnSpannumberNoNumber of columns to span (1-12) in CUSTOM_COLUMN layout. Default: 12 (full width). See Overriding the number of grid columns when using --df-custom-columns. Only effective when headlineWidthMatchesLayoutType is set to true in the form layout; otherwise the headline always spans the full width regardless.
spacingstringNoMargin spacing before next field: 'NONE' (0px), 'XS' (8px), 'S' (16px), 'M' (24px), 'L' (32px), 'XL' (40px), 'XXL' (48px).

Component Specific Properties

PropertyTypeRequiredDescription
headerTypestringYesDefines the level of the HTML heading element and the visual appearance of the headline.
sublinestringNoAn optional subline only for headlines with headerType h1

4. Configuration Examples

H1 with Subline

Example :
{
  "id": "headline-h1-subline",
  "type": "HEADLINE",
  "label": "Insurance Application",
  "headerType": "h1",
  "subline": "Complete the form below to apply for coverage"
}

H2 Section Heading

Example :
{
  "id": "headline-h2-section",
  "type": "HEADLINE",
  "label": "Personal Information",
  "headerType": "h2"
}

H3 Subsection Heading

Example :
{
  "id": "headline-h3-subsection",
  "type": "HEADLINE",
  "label": "Contact Details",
  "headerType": "h3"
}

5. API Reference

For complete API documentation, see DfHeadlineConfig.

For Aquila component documentation and design guidelines, see Headline - Aquila Design System.

results matching ""

    No results matching ""