GM - RelatedList Tabs

(gmpkg:RelatedListTabSetComponent)

Documentation

GM - RelatedList Tabs component is used to display a related list based as a Tab Set. This component is relevant for small related lists.

Use case: Display the list of payment methods as tabs on the account page.

Specification

Property	Type	Description
Related List Label *	String	The label defined on the layout page. Set it to Contacts to display the list of contacts on the Account page.
Row Limit *	Integer	The maximum number of rows to fetch. The grid will never go beyond this number of records.
Filter	String	JSON string to define filter criteria. See GM - RelatedList Grid
Sort	String	The field list to sort the related records. See GM - RelatedList Grid
Order	String	Ascending or descending order for sorting. See GM - RelatedList Grid
Label Field	String	Label Field for Tab title. If you want to display a list of contacts, set this to Name for instance. Each tab will have the name of the contact as a title.
Record Fields	String	Record Fields to display in a JSON format if you don’t want to display the whole layout. For instance, for a contact list, we can set it to: [ "FirtName", "LastName", "MailingCity" ] If this property is empty, the page layout will be used.
# of Columns	String	# of columns for the layout.
Record Related Components	String	A JSON string to add a list of inline components to display per record. Each inline component should have: component: the name of GridMate component. attributes: the list of attributes to configure, same as on the lightning app builder. See GM - RelatedList Grid
Show Border	Boolean	Check this option if you wish to add a border to the component.
Component Height	Integer	Set the component height. Set this property if you want to control the height. The user has to scroll vertically to see more records.
Actions	String	JSON string to initialize the list of available actions on each record. Custom actions are available on each tab as toolbar. You can leverage your existing quick actions. The configuration wizard can be used to build the list of actions. See Actions Configuration
Show Actions as Buttons	Boolean	Check this option if you wish to display actions as buttons instead of icons. When the actions are displayed as icons, we can define the icon on JSON actions configuration using the icon attribute.
Custom Visible Actions	Integer	Set the number of visible custom actions. All the core actions will always be displayed depending on the configuration of course. The remaining custom actions will be added as an option on the button menu.

API Reference

RelatedListTabSetComponent.design

<design:component label="GM - RelatedList Tabs">
    <design:attribute name="recordId" label="recordId" 
                      description="recordId to use. Keep this empty if you want to use the current record"/>        
    <design:attribute name="relatedListLabel" label="Related List Label" 
                      description="The label defined in the layout page. Ex. Contacts to display contact list on account page"/>    
    <design:attribute name="rowLimit" label="Row Limit" 
                      description="The maximum number of row to fetch"/>    
    <design:attribute name="filter" label="Filter" 
                      description="Json string to define filter criteria. Don’t forget __c for custom fields. Ex. {'StageName':'Needs Analysis'} to see only 'Needs Analysis' Opportunities"/>    
    <design:attribute name="sort" label="Sort" 
                      description="The field list to sort the data grid. This field is used only for the initial load. Don’t forget __c for custom fields. Ex. Amount to sort opportunities by amount"/>
    <design:attribute name="order" label="Order" 
                      description="Asc or Desc order for sorting"/>
    
    <design:attribute name="labelField" label="Label Field" 
                      description="Label Field for Tab title"/>    
    <design:attribute name="recordFields" label="Record Fields" 
                      description="Record Fields to display"/> 
    <design:attribute name="layoutColumns" label="# of Columns" 
                      description="# of Columns for record layout"/> 
    <design:attribute name="recordRelated" label="Record Related Components" 
                      description="Json string to initialize related component"/>          
    
    <design:attribute name="canUpdate" label="Can Update Object" 
                      description="Check this option if you want to update object"/>    
    <design:attribute name="canDelete" label="Can Delete Object" 
                      description="Check this option if you want to delete object"/>        
    <design:attribute name="canCreate" label="Can Create Object" 
                      description="Check this option if you want to create object"/> 
    
    <design:attribute name="recordActions" label="Actions" 
                      description="JSON Record Actions"/>        
    <design:attribute name="buttonActions" label="Show Actions as Buttons" 
                      description="Use buttons for actions instead of icons"/>
    <design:attribute name="visibleActions" label="Visible Actions" 
                      description="# of visible actions"/> 
    
    <design:attribute name="showBorder" label="Show Border" 
                      description="Show Border"/> 
    <design:attribute name="height" label="Component Height" 
                      description="Set the component height"/>     
</design:component>