GM - User Grid Split View

(gmpkg:UserGridSplitViewComponent)

Documentation

GM - User Grid Split View component is designed to help users achieving a clearer view of the User Grids and streamline grids management.

Use case: Display the User Grids created based on the opportunity object. see Grid - User Grid Split View

Specification

Property	Type	Description
Target Object	String	The name of the object used for displaying only its User Grids.
Split View Name	String	Unique split view name to identify the component on the page.
Default Grid	String	Developer Name of the User Grid that we want to set as the default Grid.
List Label	String	Set the label of the split view displayed on the left side.
Grid Filter	String	JSON string defining the grid filter criteria, which is applied to get the list of grids to display. { "Name": { "operator": "in", "value": "('GM Opportunity Grid','Pipeline Opportunity Grid')" } }
Inline Filter	String	Json string to define an extra filter criteria to the grid in the context of the split view. this filter gets added to the grid admin filter.
View Height	Integer	Set the grid height. Set this property if you want to control the height and show up components after the grid. The user has to scroll vertically to see more records. If the value is set 9999, The grid will use the remaining space on the page even if the user resizes the window. This behavior is relevant to build a responsive app page.
Enable Create	Boolean	Check this option if you want to create a grid.
Collapse Split View	Boolean	Check this option if you want to collapse the split view by default.
Enable Toggle Fullscreen	Boolean	Check this option if you want to enable toggle fullscreen.
Hide App Header	Boolean	Check this option if you want to hide the app page header. This option is useful only if the component is used in an App Page.
Disable Navigation	Boolean	Check this option to disable the navigation to the grid record page.

API Reference

UserGridSplitViewComponent.design

<design:component label="GM - User Grid Split View">
    <design:attribute name="targetObject" label="Target Object" 
                      description="Target Object API Name"/>                                                         
                         
    <design:attribute name="splitViewName" label="Split View Name" 
                      description="Unique split view name to identify the component on the page"/>

    <design:attribute name="defaultUserGrid" label="Default Grid" 
                      description="Default grid to load"/>    

    <design:attribute name="objectLabel" label="List Label" 
                      description="List Label"/>    

    <design:attribute name="gridFilter" label="Grid Filter" 
                      description="Json string to define user grid filter criteria"/>        

    <design:attribute name="adminFilter" label="Inline Filter" 
                      description="Json string to define inline filter criteria"/>        

    <design:attribute name="height" label="View Height" 
                      description="Set the view height"/>  

    <design:attribute name="canCreate" label="Enable Create" 
                      description="Check this option if you want to create a grid"/>

    <design:attribute name="inline" label="Disable Refresh View" 
                      description="Check this option if you want to disable the view refresh after an update"/>

    <design:attribute name="collapseSplitView" label="Collapse Split View" 
                      description="Check this option if you want to collapse the split view"/>                                                  

    <design:attribute name="noNavigation" label="Disable Navigation" 
                      description="Hide the navigation to the grid"/> 

    <design:attribute name="canToggleFullscreen" label="Enable Toggle Fullscreen" 
                      description="Check this option if you want to enable toggle fullscreen"/>   

    <design:attribute name="noLexHeader" label="Hide App Header" 
                      description="Hide the app page header"/>                         

    <design:attribute name="density" label="Density" 
                      description="Grid density : comfy | compact"/>                            
</design:component>