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

📝 Note:

• Only Text, Picklist, and Checkbox field types are currently supported for matching rules.
• Formula field is not supported.
• The field should be present as a column on the listview.
• Available only for Table view, and not for Kanban and Split view of list

Example use case: Highlight all Opportunity rows in red when the Stage is 'Closed Lost', so sales reps can immediately identify lost deals in their pipeline view.

Prerequisites

Before configuring List View Row Highlights, ensure the following are in place:

• The Build Your Own Branding managed package is installed in your Salesforce org (Version 1.22 or later, namespace prefix: pscbyb).
• You have System Administrator access to Salesforce Setup.
• The Lightning App you want to apply row highlights to has already been created in App Manager.

Part 1: Verify the BYOB Package Installation

First, confirm that the BYOB package is correctly installed in your org. Get the latest package installation link here

Step 1: Setup.- Log in to Salesforce and click the gear icon in the top-right corner, then select 

Step 2: Installed Packages- In the Setup search bar, type Installed Packages

Step 3: Build Your Own Branding - Locate BYOB package installed

Step 4: Click on the package name and verify the following details:

Part 2: Add the List View Row Highlights Utility Item to Your Lightning App

The BYOB component works as a Utility Item in your Lightning App. This must be configured for each app where you want row highlights to appear.

Step 1: Apps > App Manager - In Setup, use the left sidebar to navigate to 

Step 2: Sales - Find the Lightning App you want to configure (e.g., 

Step 3: Utility Items (Desktop Only)- In the Lightning App Builder, click 

Step 4: Add Utility Item- Click 

Step 5: List View Row Highlights- In the search box that appears, scroll down or search for 

Step 6: Configure the Utility Item Properties as follows:

📝 Note: The 'Start Automatically' checkbox is critical. Without it, the row highlighting component will not activate when users open the app.

Step 7: Save Click 

Part 3: Find the Field API Name for Your Highlight Condition

Before creating a Row Highlight Rule, you need the exact API Name of the field you want to use as the match condition.

Step 1: Object Manager- In Setup, click Object Manager

Step 2: Opportunity- Search for the object you want to configure (e.g.,Opportunity) 

Step 3: Fields & Relationships- In the object's left sidebar, click Fields and Relationship

Step 4: Stage- Find the field you want to use (e.g., StageName)

📝 Note: Only Text, Picklist, and Checkbox field types are supported by the Row Highlight Rule.

Part 4: Create Row Highlight Rules in Custom Metadata Types

Row Highlight Rules are stored as Custom Metadata Type records. Each rule defines a field value to match and the colors to apply to that row.

Step 1: In Setup, type meta to search custom metadata type

Step 2: Row Highlight Rule > Find and manage records

Step 3: New - Click 

Step 4: Fill in the following fields:

Step 5: Save 

Part 5: Test the Row Highlights in Your Lightning App

Once your rules are configured, verify that they are working correctly.

Step 1: Sales > Use the App Launcher (waffle icon) to search for and open the Lightning App you configured (e.g Sales)

Step 2: Opportunities > All Opportunities Navigate to the object's list view (e.g., Opportunity) 

Step 3: Verify that rows matching your rule conditions are highlighted with the correct background and font colors.

For example, with the rules configured in this guide, you should see:

• Rows where Stage = 'Closed Lost' displayed with a red background and white text.
• Rows where Stage = 'Closed Won' displayed with a green background and dark text.
• All other rows displayed with no highlight (default styling).

Troubleshooting

Row highlights are not appearing

• Confirm the 'Start Automatically' checkbox is checked on the List View Row Highlights utility item.
• Verify that the 'Is Active' checkbox is checked on your Row Highlight Rule record.
• Ensure you saved the Lightning App after adding the utility item.
• Try refreshing the page and opening the List View again.

The wrong rows are being highlighted

• Double-check the Field API Name — it must be exact (e.g., StageName, not Stage or stage_name).
• Verify the Match Value matches the field value exactly, including case and spacing.
• Check the Priority field if multiple rules apply to the same row — the lowest number wins.

Fields are not working

• Remember: only Text, Picklist, and Checkbox field types are supported. Formula, Number, Date, and other field types are not currently supported.

Quick Reference: Example Rules