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 requires no custom code, improves record visibility, and speeds up user decision-making.

Supported Capabilities and Limitations

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

Prerequisites

1. Build Your Own Branding (BYOB) managed package version 1.22 or later (namespace prefix: pscbyb) is installed. The latest installation link is on the CodeyLabs help portal.
2. System Administrator access to Salesforce Setup.
3. The target Lightning App is created and configured in App Manager.

Part 1: Verify BYOB Package Installation

Confirm the package installation status and version before configuring anything.

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

Step 2: In the Setup search bar, enter 'Installed Packages' and select the result.

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

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

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

Part 2: Deploy the Utility Item to a Lightning App

The component runs as a Utility Item within Lightning Apps. Complete this configuration for every app where row highlighting is required.

Step 1: In Setup, navigate to Apps > App Manager.

Step 2: Locate and edit the target Lightning App (e.g., Sales App).

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

Step 4: Click 'Add Utility Item'.

Step 5: Search for and select 'List View Row Highlights' from the managed components.

Step 6: Configure the utility item properties:

The utility item configuration panel.

Step 7: Click Save to apply the utility item to the Lightning App.

Part 3: Identify Field API Names for Highlight Conditions

Before creating rules, obtain the exact API name of the field used as the matching condition.

Step 1: In Setup, navigate to Object Manager.

Step 2: Search for and select the target object (e.g., Opportunity).

Step 3: In the left sidebar, click 'Fields & Relationships'.

Step 4: Find the field to use as the condition (e.g., StageName) and note its API name.

Fields & Relationships in Object Manager. Only Text, Picklist, and Checkbox fields are supported.

Part 4: Create Row Highlight Rules via Custom Metadata Types

Rules are stored as Custom Metadata Type records. Each rule defines a field value match condition and the colors applied to matching rows.

Step 1: In Setup, enter 'Custom Metadata Type' in the search bar and open Custom Metadata Types.

Step 2: Select 'Row Highlight Rule' to manage rule records.

Step 3: Click 'New' to create a rule record.

Step 4: Complete the rule fields:

The Row Highlight Rule record creation form with all configurable properties.

To find the ObjectApiName and ListviewFilterName values:

1. ObjectApiName: In Setup > Object Manager, identify the API name of the target object.
2. ListviewFilterName: Open the target list view and copy the FilterName parameter from the browser URL.

Extracting the ListviewFilterName from the list view URL.

Step 5: Click Save to activate highlighting for matching list view rows.

Part 5: Test Row Highlights in the Lightning App

Step 1: Use the App Launcher to open the Lightning App you configured (e.g., Sales App).

Step 2: Open the target list view (e.g., Opportunities > All Opportunities).

Step 3: Confirm that matching rows display the correct colors:

• Stage = 'Closed Lost': red background with white text.
• Stage = 'Closed Won': green background with dark text.
• All other rows: default styling.

An Opportunities list view with conditional row highlighting. Red rows are Closed Lost deals.

Troubleshooting: Common Issues and Solutions

Quick Reference: Example Configuration Rules

Example Row Highlight Rule configuration.

Knowledge Article Number: KA-00214