BYOB - Contextual Help

Published on February 9, 2026 BYOB

Contextual Help Component

The Contextual Help component delivers actionable guidance directly on Salesforce record pages, enabling users to access critical information through hover tooltips before executing record actions. This solution enhances user comprehension and reduces support overhead by providing situational guidance at the point of decision.

Component Installation and Access

Following the installation of version 1.13 or later, the Contextual Help component is available in the Lightning App Builder's custom managed components panel. To deploy the component to a record page:

• Locate the Contextual Help component in the App Builder's left sidebar under custom managed components.
• Drag and drop the component onto the target record page to establish the location where contextual guidance will appear.

The image above shows the Contextual Help component available in the custom components library for deployment.

Component Configuration and Setup

Before configuring the component properties, you must identify the API name of the target button on which contextual guidance will appear. To obtain the button's API name:

• Navigate to Setup and access the Object Manager.
• Select the relevant object from the object list.
• Select "Buttons, Links, and Actions" from the sidebar navigation.
• Locate the target button and document its API name.

The image above demonstrates how to locate button API names in the Object Manager's Buttons, Links, and Actions section.

Component Property Configuration

Configure the following component properties to enable and customize contextual help functionality:

• Button API Name: Specify the complete button identifier in the format ObjectApiName.ButtonApiName. Examples include Case.MergeCase, Lead.Custom_Lead_Conversion, Lead.pkg__Custom_Lead_Conversion, and pkg__Lead.pkg__Custom_Lead_Conversion.
• Tooltip: Enter the contextual message that will display when users hover over the associated button. Keep the message concise and actionable.
• Background Color (Optional): Define the tooltip background color using color name, hexadecimal code, RGB, or RGBA values.
• Font Color (Optional): Define the tooltip text color using color name, hexadecimal code, RGB, or RGBA values for optimal contrast and readability.

The image above shows the component property configuration interface with all available settings.

Implementation Example: Case Merge Guidance

The following example demonstrates how to configure contextual help for a Case merge operation. By providing guidance before the merge action, support agents gain clarity on the implications and required preconditions:

The visual reference above illustrates a contextual help tooltip appearing on the Merge Cases button, providing agents with critical guidance before executing the merge operation.

Related List Button Support

The Contextual Help component also supports button guidance on related list sections within record pages. This functionality enables administrators to provide contextual assistance for actions within related object records, ensuring consistent user guidance across all operational touchpoints.

The image above demonstrates contextual help implementation on related list buttons, showing how guidance appears for actions within child object records.

Knowledge Article Number: KA-00079