GM - Object Timeline

(gmpkg:timeLineContainerLWC)

Documentation

GM - Object Timeline component is used to display a Timeline on any Lightning page (Home, App, Record). The object timeline filters can be configured through the App Builder and using the current object on a Record Page.

Use case: Display a timeline of Tasks filtered by current opportunity. See Timeline tutorial.

Specification

Property	Type	Description
Show Header	Boolean	Check this option if you wish to display the header.
Title	String	Title of the card.
Icon	String	Icon name from the Salesforce Lightning Design System to display in the header. Ex: standard:account
Timeline Configuration	String	JSON configuration describing the timeline content.
Card Variant	String	Path variant to use; linear or non-linear.

API Reference

timeLineContainerLWC.js-meta.xml

<?xml version="1.0" encoding="UTF-8" ?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>52.0</apiVersion>
    <isExposed>true</isExposed>
    <masterLabel>GM - Object Timeline</masterLabel>
    <description>GM - Object Timeline</description>
    <targets>
        <target>lightning__RecordPage</target>
        <target>lightning__AppPage</target>
        <target>lightning__HomePage</target>
    </targets>
    <targetConfigs>
        <targetConfig
            targets="lightning__RecordPage,lightning__AppPage,lightning__HomePage"
        >
            <property
                name="showHeader"
                type="Boolean"
                label="Show Header"
                description="Check to display the header"
            />
            <property
                name="headerTitle"
                type="String"
                label="Title"
                description="Title to display on the header"
            />
            <property
                name="headerIcon"
                type="String"
                label="Icon"
                description="Header icon to display on the header (SLDS Icons)"
            />
            <property
                name="jsonConfig"
                type="String"
                label="Timeline Configuration"
                description="JSON Timeline Configuration"
            />
            <property
                name="variant"
                type="String"
                label="Variant"
                description="Card Variant"
            />
        </targetConfig>
    </targetConfigs>
</LightningComponentBundle>