BYOB - Contextual Help

Contextual Help Component

This powerful component is designed to equip users with all the critical information they need directly on the Salesforce record page. Before clicking any header button, users can easily access contextual guidance through hover tooltips, ensuring they understand the action they are about to take.

Accessing the Contextual Help Component

• After Installation of version 1.13, you will notice a new component 'Contextual Help' in the App Builder, under the custom managed components on the left side bar.
• Simply drag and drop the component onto the page where you'd like the tooltip to appear for a header button.

Configuring the component

• Before we start configuring the component, capture the api name of the displayed button on which you intended to display contextual help tooltip.
  • Go to Object Manager
  • Select the related object.
  • Select Button, Links, and Actions in the side bar.
  • Find your button and its api name.

• Provide a value in Button Api Name property. Button Api Name is a combination of ObjectApiName.ButtonApiName. Make sure you capture the correct api names for object and button; For reference, some of the sample button api names below:
  • Case.MergeCase
  • Lead.Custom_Lead_Conversion
  • Lead.pkg__Custom_Lead_Conversion
  • pkg__Lead.pkg__Custom_Lead_Conversion
• Tool Tip: The message that will be displayed on the hover of button.
• Background Color: Optional. Set the background color of tool tip message. Supports name, hex, rgb, rgba.
• Font Color: Optional. Set the font color of text in tool tip message. Supports name, hex, rgb, rgba.

Use case: A hint to the agent, before pushing Merge Cases button.

Support for Related List Button within Contextual Help Component