Newer Version Available

This content describes an older version of this product. View Latest

TPM Promotion Header LWC

The tpm-promotion-header-component service component provides access to the TPM promotion header in the LWC layer. This component is part of the TPM managed package.

This component is a wrapper for accessing the entire promotion header. You can customize a specific section of the header (LWC slot)—without changing the default behavior of the other sections—through a slot-specific promotion header LWC. Customizable promotion header slots are:

  • icon: A 32x32 pixel image.
  • breadcrumbs: A component to display the page breadcrumbs.
  • title: The promotion title
  • subtitle: The promotion subtitle
  • navigation: A group of button icons.
  • left-buttons: The action buttons and components that are anchored to the left of the header toolbar.
  • right-buttons: The action buttons and components that are anchored to the right of the header toolbar.
  • fullheight-buttons: The buttons that span the complete height of the header.

For information on slot-specific promotion header LWCs, see TPM Promotion Header Slot LWCs.

Example

Here’s an example of a custom promotion header component with the default behavior.

Here’s an example of a custom promotion header component with TPM default behavior:

Here’s an example of a custom promotion header component with a custom promotion title and custom button.

If your org has Lightning Web Security enabled, the runtimeNamespace property on the metadata file isn’t required.

Lightning web security is a feature that must be tested before enabling. LWC Security

Note