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. It enhances user comprehension and reduces support overhead by providing situational guidance at the point of decision.
Key Benefits: Point-of-action guidance, fewer support requests, and consistent instructions for standard, custom, and related list buttons.
Overview of the Contextual Help component.
Prerequisites
- Package version 1.13 or later installed.
- Access to Lightning App Builder and Setup.
- The API name of the button you want to annotate.
Step 1: Component Installation and Access
After installing version 1.13 or later, the Contextual Help component is available in the Lightning App Builder custom managed components panel. To deploy it to a record page:
- Locate the Contextual Help component in the App Builder left sidebar under custom managed components.
- Drag and drop the component onto the target record page to set where contextual guidance will appear.
The Contextual Help component in the custom components library, ready for deployment.
Step 2: Find the Button API Name
Before configuring the component, identify the API name of the button that will show the guidance:
- Go to Setup and open Object Manager.
- Select the relevant object from the list.
- Select "Buttons, Links, and Actions" in the sidebar.
- Locate the target button and note its API name.
Locating button API names in Object Manager under Buttons, Links, and Actions.
Step 3: Configure Component Properties
Set the following properties to enable and customize contextual help:
| Property | Required | Description |
| Button API Name | Yes | Complete button identifier in the format ObjectApiName.ButtonApiName. |
| Tooltip | Yes | Message shown when users hover over the button. Keep it concise and actionable. |
| Background Color | Optional | Tooltip background as a color name, hex code, RGB, or RGBA value. |
| Font Color | Optional | Tooltip text color as a color name, hex code, RGB, or RGBA value. Choose good contrast for readability. |
Button API Name examples: Case.MergeCase, Lead.Custom_Lead_Conversion, Lead.pkg__Custom_Lead_Conversion, pkg__Lead.pkg__Custom_Lead_Conversion
Component property configuration with all available settings.
Implementation Example: Case Merge Guidance
The example below configures contextual help for a Case merge operation. Guidance shown before the merge action tells support agents the implications and required preconditions.
A contextual help tooltip on the Merge Cases button, guiding agents before they merge.
Related List Button Support
The component also supports button guidance on related list sections within record pages. Administrators can give contextual assistance for actions on related object records, keeping guidance consistent across every operational touchpoint.
Contextual help on related list buttons, showing guidance for actions within child object records.
Tip: If a tooltip does not appear, confirm the Button API Name uses the exact ObjectApiName.ButtonApiName format, including any package namespace prefix.
Knowledge Article Number: KA-00079