Skip to content

Page contexts

Add the Highlight Badges component in Lightning App Builder, Flow Builder or Experience Builder. It can be displayed on:

  • Record Pages
  • Flow Screens
  • App Pages
  • Experience Cloud pages

Record pages

When displaying Highlight Badges on record pages, the Display Record is the current record.

Component properties (1)

Flow screens

Add Highlight Badges to Flow screens and provide a record ID from Flow context.

Component properties (2)

If alerts and confetti don’t make sense for this context, check the Disable Alerts checkbox.

App pages

Highlight Badges on App Pages are displayed based on a record ID provided via a URL parameter. When adding the Highlight Badges for App Pages component to an App Page, set the Record ID URL Parameter in Lightning App Builder.

Component properties (3)

Provide the name of your URL parameter to the Record ID URL Parameter property. In this example, the ID is passed to the c__recordId parameter.

e.g. https://mysite.lightning.force.com/lightning/n/my_app_page?c__recordId=001000000000000AAA

If alerts and confetti don’t make sense for this context, check the Disable Alerts checkbox.

Experience Cloud

Add Highlight Badges to Experience Cloud pages to display highlights to external users. There are five supported ways to define the Display Record for the component.

  • Page Context
  • URL Parameter
  • Current User
  • Current User’s Account
  • Current User’s Contact

NOTE: A Highlight Badge Definition is shown to logged-in external users only when it is marked Visible to External Users, and to unauthenticated guest users only when it is marked Visible to Guest Users. Each checkbox covers its own audience. A badge in System Mode that is visible to guests shows its label and merge-field values to anyone who can open the page.

Page Context

Component properties (4)

Use the Display Record Source of “Page Context” to pass a page context value to the component. Enter this value in the Display Record ID.

For example, when displaying the component on an Object Record Page, use {!recordId} to pass in the Record ID of the context record.

URL Parameter

Component properties (5)

Use the Display Record Source of “URL Parameter” to pass the Display Record ID through a URL parameter.

Define the name of the parameter in Record ID URL Parameter.

Current User

Component properties (6)

For authenticated users, you can choose to display badges based on the current user, the current user’s contact, or the current user’s account.

Set the Display Record Source to the desired setting to set this as the Display Record.

Disable alerts

Embedded in an app page or screen flow, alerts and confetti may not make sense for the context. Set the Disable Alerts flag when adding the Highlight Badges component to a lightning page or Flow screen to ensure these are not displayed. Badges still appear and the details modal is still presented when a badge is clicked.