BYOB - List View Row(s) Highlight (GA)

Published on March 3, 2026 BYOB

List View Row Highlights: Implementation Guide

The List View Row Highlights component enables administrators to apply conditional visual highlighting to Salesforce table list views based on field values. This configuration-driven approach allows organizations to establish visual distinctions within list views without requiring custom code development, improving record visibility and accelerating user decision-making.

Supported Capabilities and Limitations:

1. Text, Picklist, and Checkbox field types are currently supported for matching rules.
2. Formula fields are not supported.
3. Target fields must appear as visible columns in the list view.
4. Highlighting applies to Table view only; Kanban and Split views are not supported.

Use Case Example: Administrators can configure highlighting to display Opportunity rows in red when Stage equals 'Closed Lost', enabling sales representatives to quickly identify lost deals within their pipeline view.

Prerequisites

Ensure the following requirements are met before configuring List View Row Highlights:

1. Build Your Own Branding (BYOB) managed package version 1.22 or later (namespace prefix: pscbyb) is installed in the Salesforce organization.
2. System Administrator access to Salesforce Setup is available.
3. The target Lightning App has been created and configured in App Manager.

Part 1: Verify BYOB Package Installation

Confirm BYOB package installation status and version compatibility before proceeding with configuration. Access the latest package installation link on the CodeyLabs help portal.

Step 1: Access Salesforce Setup

Log into your Salesforce organization and click the gear icon (⚙️) in the top-right corner, then select Setup.

Step 2: Navigate to Installed Packages

In the Setup search bar, enter 'Installed Packages' and select the corresponding search result.

Step 3: Locate BYOB Package

Locate the 'Build Your Own Branding' (BYOB) package in the list of installed managed packages.

Step 4: Verify Installation Details

Click the package name and verify the following information matches expected values:

The image above shows the BYOB package details page in the Installed Packages section of Setup.

Part 2: Deploy List View Row Highlights Utility Item to Lightning App

The List View Row Highlights component operates as a Utility Item within Lightning Apps. This configuration must be completed for each application where row highlighting functionality is required.

Step 1: Access App Manager

In Salesforce Setup, navigate to Apps > App Manager via the left sidebar.

Step 2: Select Target Lightning App

Locate and select the Lightning App for which row highlights should be configured (e.g., Sales App).

Step 3: Access Utility Items Configuration

In the Lightning App Builder, select 'Utility Items (Desktop Only)' from the left navigation panel.

Step 4: Add New Utility Item

Click 'Add Utility Item' to initiate component deployment.

Step 5: Select List View Row Highlights Component

In the component search interface, locate and select 'List View Row Highlights' from the available managed components.

Step 6: Configure Utility Item Properties

Configure the following properties for the utility item:

The image above displays the utility item configuration panel. Note that the 'Start Automatically' checkbox is critical—without this setting enabled, the row highlighting component will not activate when users access the app.

Step 7: Save Application Configuration

Click Save to apply the utility item deployment to the Lightning App.

Part 3: Identify Field API Names for Highlight Conditions

Before creating Row Highlight Rules, obtain the precise API name of the field that will serve as the matching condition for row highlighting.

Step 1: Access Object Manager

In Setup, navigate to Object Manager.

Step 2: Select Target Object

Search for and select the object you want to configure (e.g., Opportunity).

Step 3: Access Fields and Relationships

In the object's left sidebar, click 'Fields & Relationships'.

Step 4: Locate Target Field

Find the field you intend to use as a highlighting condition (e.g., StageName).

The image above shows the Fields & Relationships section in Object Manager. Note that only Text, Picklist, and Checkbox field types are supported by the Row Highlight Rule component.

Part 4: Create Row Highlight Rules via Custom Metadata Types

Row Highlight Rules are stored and managed as Custom Metadata Type records. Each rule defines a field value match condition and associated color formatting for highlighted rows.

Step 1: Access Custom Metadata Types

In Setup, enter 'Custom Metadata Type' in the search bar and navigate to the Custom Metadata Types section.

Step 2: Select Row Highlight Rule

Locate and select 'Row Highlight Rule' to access and manage highlighting rule records.

Step 3: Create New Rule Record

Click 'New' to create a new Row Highlight Rule record.

Step 4: Complete Rule Configuration Fields

Populate the following fields to define the highlighting rule:

The image above shows the Row Highlight Rule metadata record creation form with all configurable properties. Complete each field according to your highlighting requirements.

To identify the ObjectApiName and ListviewFilterName values:

1. ObjectApiName: Navigate to Setup > Object Manager and identify the API name of the target object.
2. ListviewFilterName: Open the target list view in your application and extract the FilterName parameter from the browser URL.

The image above demonstrates how to extract the ListviewFilterName from the list view URL. The FilterName parameter contains the identifier required for rule configuration.

Step 5: Save Rule Configuration

Click Save to persist the Row Highlight Rule record and activate highlighting for matching list view rows.

Part 5: Test Row Highlights in Lightning App

After rule configuration, verify that row highlighting functions correctly within your Lightning App's list views.

Step 1: Launch Lightning App

Use the App Launcher (⊞ waffle icon) to search for and open the Lightning App you configured (e.g., Sales App).

Step 2: Navigate to Target List View

Access the object's list view (e.g., Opportunities > All Opportunities).

Step 3: Verify Highlighting Application

Confirm that rows matching your rule conditions display the correct background and font colors. For example:

1. Rows with Stage = 'Closed Lost' should display with red background and white text.
2. Rows with Stage = 'Closed Won' should display with green background and dark text.
3. All other rows should display with default styling.

The image above displays an example Opportunities list view with conditional row highlighting applied. Red-highlighted rows indicate Closed Lost deals, while other rows retain default styling.

Troubleshooting: Common Issues and Solutions

Issue: Row highlights are not appearing in list view

1. Verify that the 'Start Automatically' checkbox is enabled on the List View Row Highlights utility item configuration.
2. Confirm that the 'Is Active' checkbox is checked on your Row Highlight Rule record.
3. Verify that the Lightning App was saved after adding the utility item.
4. Refresh the page and reopen the list view to trigger component initialization.

Issue: Incorrect rows are being highlighted

1. Verify that the Field API Name is exactly correct (case-sensitive), e.g., StageName instead of Stage or stage_name.
2. Confirm that the Match Value precisely matches the field value in your data, including spacing and case sensitivity.
3. If multiple rules apply to the same row, check the Priority field—lower numbers take precedence.

Issue: Field types are not supported for highlighting rules

1. Verify that your target field is one of the supported types: Text, Picklist, or Checkbox. Formula fields, Number fields, Date fields, and other types are not currently supported.

Quick Reference: Example Configuration Rules

Knowledge Article Number: KA-00214