LogoLogo
HomepageYouTube ChannelInstall from the AppExchange
  • Home
  • Dynamic Components
  • Flow Components
  • Experience Components
  • Projects
  • 👋Welcome
  • Getting Started
    • Product Tour
    • Quickstart Tutorial
    • Understanding The Essentials
      • Component Builder
      • Component Visibility
      • Target Page Object
      • Using Variables and Component Data
      • Publishing your Dynamic Components
      • Dynamic vs. Flow Components
    • Avonni Components App
      • Accessing the App
      • Folders
      • Templates
      • Version management
    • AppExchange Listing Page
    • Installation & Licenses Management
  • Tutorials
    • Projects
    • Components
      • Calendar
        • How to Create Events Quickly by Dragging
        • How to Add an Edit Action to Calendar Events
        • How to Add a New Event Button to the Calendar Header
        • How to Customize the Right-Click Menu
        • How to Reschedule Events with Drag and Drop
      • Columns
        • Creating a Responsive 3-Column Layout
      • Data Table
        • How to customize Data Table style
        • How to make a field editable
        • How to add clickable buttons
        • How to color-code badges
        • How to export data
        • How to configure search
        • How to set columns visibility
      • Kanban
        • Saving Changes on Drag-and-Drop
      • List
      • Metric
      • Record Detail
        • Saving Changes
    • Interactions
      • How to create an interaction to navigate to an object page
      • How to create an interaction to navigate to a record page
      • How to Pass Multiple Selected Records from a Dynamic Component to a Screen Flow
    • Reactive Components
      • Reactive Map and Data Table
      • Master-Detail Relationship with Data Tables
      • Vertical Tabs with Reactive Data Table
    • Style
      • How do you add space or a break between sections or fields?
    • Tips and Tricks
      • Using the Dynamic Component component
  • Component Builder
    • Overview
    • Configuring Components
      • Properties
      • Fields
      • Style
    • Data & Interactions
      • Data Sources
        • Manual
        • Picklist
      • Resources
        • Constant
        • Formula
        • Nested Queries
        • Query
        • Variable
      • Interactions
        • CRUD from Record Variable
        • Download
        • Execute Flow
        • Navigate
        • On Load
        • Open Alert Modal
        • Open Confirm
        • Open Dynamic Component Dialog
        • Open Dynamic Component Panel
        • Open Flow Panel
        • Open Flow Dialog
        • Show Toast
    • Advanced Topics
      • Undo / Redo
      • Copy and Paste
      • Keyboard Shortcut
  • Components
    • Explore All Components
    • Accordion
    • Alert
    • Audio Player
    • Avatar
    • Avatar Group
    • Badge
    • Barcode
    • Blockquote
    • Button
    • Button Group
    • Button Icon
    • Button Menu
    • Button Stateful
    • Calendar
    • Camera 🆕
    • Card
    • Carousel
    • Chart
    • Checkbox
    • Checkbox Button
    • Chip Container
    • Color Picker
    • Columns
    • Combobox
    • Container
    • Counter
    • Data LWC Container
    • Data Table
    • Date Picker
    • Date
    • Date Range
    • Dual Listbox
    • Dynamic Component
    • Formatted Address
    • Formatted Name
    • Formatted Value
    • Header
    • Icon
    • Icon Picker
    • Illustration
    • Image
    • Input Color
    • Input Date
    • Input Pen (Signature)
    • Input Text
    • Kanban
    • List
    • LWC Container
    • Map
    • Media Object
    • Metric
    • PDF Viewer
    • Pivot Table
    • Progress Bar
    • Progress Circle
    • Progress Indicator
    • Rating
    • Record Detail
    • Relationship Graph
    • Scope Notification
    • Section
    • Separator
    • Slider
    • Status
    • Tabbed Container
    • Tabs
    • Text
    • Text Area
    • Timeline
    • Toggle
    • Tree
    • Vertical Visual Picker
    • Video Player
    • Visual Picker
    • Visual Picker Link
  • Help
    • Contact Support
    • Security
    • Performance Guide
    • Deployment Process
    • Release Notes
    • Report Bugs
Powered by GitBook
LogoLogo

Company

  • About Us
  • Pricing

Policies

  • Privacy Policy
  • Terms of Service
On this page
  • Overview
  • Use Cases
  • Properties
  • API Name
  • Caption (Optional)
  • Title
  • Subtitle (Optional)
  • Icon Name (Optional)
  • Background Image (Optional)
  • Is Joined (Optional)
  • Examples
  • Example 1: Static Header
  • Example 2: Dynamic Header (on an Account Record Page)
  • Example 3: Dynamic Header (background image)
  • In Summary

Was this helpful?

  1. Components

Header

The Avonni Header provides a straightforward way to add titles, subtitles, icons, images, and navigation links to create informative and visually engaging headers.

Last updated 4 days ago

Was this helpful?

Overview

The Header component is a layout element, meaning it's primarily about presentation and structure, not about displaying data from a specific Salesforce object. It's designed to draw the user's attention and provide context.

Use Cases

  • Page Headers: Use a Header at the top of a Dynamic Component placed on an App Page or Record Page. This provides a clear title for the entire page.

  • Section Headers: Within a larger Dynamic Component (e.g., inside a Card or Container), use Header components to divide content into logical sections. This improves organization and readability.

  • Form Headers: Place a Header above a group of input fields to indicate the form's purpose (e.g., "Create New Contact," "Edit Account Details," etc.).

  • Dashboard Headers: Use Headers to label different sections or charts within a dashboard.

  • Visual separation: Visually separate sections.

Choosing Between the Header and Card Components for Headings

Both components can create headings, but choose based on your needs:

  • : For simple, standalone titles. Provides basic text and icon options.

  • : For integrated headings that are visually part of the content. Allows you to include other components within the heading area. Offers more layout and styling flexibility.

Properties

The Header component has the following properties, which you can configure in the Properties Panel:

API Name

A unique identifier for the component within your Dynamic Component. This is used to reference the component in interactions, formulas, and nested components.

Caption (Optional)

A short text string displayed above the main title. Use this for brief context, a label, or a short instruction. You can enter static text directly or click the resource selector icon (usually a variable/tag icon) next to the Caption field to bind it to a Variable, Constant, or Formula resource. This allows you to change the Caption dynamically based on data or user input.

Title

The main heading text. This is the most prominent text element. Like the Caption, you can enter static text directly or bind the Title to a dynamic value (Variable, Constant, Formula, or Component Attribute). On a record page, you'll often bind the Title to a field from the current record (e.g., $Component.record.Name).

Subtitle (Optional)

Text displayed below the main title. Use this for additional information, a description, or a sub-heading. Again, this can be static text or a dynamic value.

Icon Name (Optional)

The name of an Avonni icon (or a Salesforce SLDS icon) to display next to the title. This adds a visual cue—examples: utility:info, standard:account. You can find a list of available icons in the Avonni documentation and the Salesforce Lightning Design System documentation. You can also use a dynamic value here (e.g., a Formula that returns a different icon name based on a condition).

Background Image (Optional)

Allows to set a background image.

Is Joined (Optional)

If enabled, this visually connects the header to the content below it. This is typically done by removing or modifying the bottom border of the Header. It creates a more integrated look, as if the header is part of the content area, rather than a separate section.

Examples

Example 1: Static Header

-   Caption: (Blank)
-   Title: Account Details
-   Subtitle: Information about the current Account
-   Icon Name: standard:account
-   Background Image: (None)
-   Is Joined: (Checked - to visually connect to a Data Table below)

This creates a simple, static header with a title, subtitle, and icon. It doesn't change based on data.

Example 2: Dynamic Header (on an Account Record Page)

-   Caption: Account
-   Title: $Component.record.Name (This dynamically displays the current Account's Name)
-   Subtitle: {!Industry} (This assumes you have a Formula resource or Variable named Industry that retrieves and potentially formats the Account's Industry field).
-   Icon Name: standard:account
 -  Background Image:  (None)
-   Is Joined: (Checked)

This header is dynamic. The Title will change to reflect the Name of the current Account record being viewed, and the subtitle. The Subtitle will also update dynamically based on the Industry.

Example 3: Dynamic Header (background image)

  • Caption: (Blank)

  • Title: Account Details

  • Subtitle: Information about the current Account

  • Icon Name: standard:account

  • Background Image: @backgroundImage (This assumes you have a variable that stores a URL Image).

  • Is Joined: (Checked)

Important Considerations

  • Dynamic Content: The real power of the Header component comes from using dynamic values for the Caption, Title, and Subtitle. This allows the header to adapt to the current context (e.g., the current record, user selections, etc.).

  • Icon Choice: Select icons that are relevant and visually consistent.

  • Background Images: Use background images sparingly. Ensure they don't make the text difficult to read. High-quality images are important.

  • "Is Joined": Experiment with this setting to see how it visually connects the header to the content.

  • Accessibility: Make sure your header text is clear and provides a good heading structure.

In Summary

The Header Component is helpful to display a title section within your Dynamic Componen.t

Header
Card