Merge pull request #6 from mickaelgudin/master

fixes #5 :  optional icon  + autoretrieve of the icon name based on s…

Author: Sarveshgithub

README.md

@@ -16,6 +16,10 @@ The data table has following features.
 - Row action, like : show detail, edit record, delete record
 
 ## Steps to Customization through Design Attribute
+
+**Icon name :** <br/>
+Only specify the icon name if you wish to override the default icon of the object.
+<br/><br/>
 Design Attribute
 
 | Label           | Type       | Value                        | Example             |

main/default/classes/IconUtils.cls

@@ -0,0 +1,30 @@
+public class IconUtils {
+    
+    public static String getIconName(String sObjectName){
+        String u;
+        List<Schema.DescribeTabSetResult> tabSetDesc = Schema.describeTabs();
+        List<Schema.DescribeTabResult> tabDesc = new List<Schema.DescribeTabResult>();
+        List<Schema.DescribeIconResult> iconDesc = new List<Schema.DescribeIconResult>();
+
+        for(Schema.DescribeTabSetResult tsr : tabSetDesc) { tabDesc.addAll(tsr.getTabs()); }
+
+        for(Schema.DescribeTabResult tr : tabDesc) {
+            if( sObjectName == tr.getSobjectName() ) {
+                if( tr.isCustom() == true ) {
+                    iconDesc.addAll(tr.getIcons());
+                } else {
+                    u = 'standard:' + sObjectName.toLowerCase();
+                }
+            }
+        }
+        for (Schema.DescribeIconResult ir : iconDesc) {
+            if (ir.getContentType() == 'image/svg+xml'){
+                u = 'custom:' + ir.getUrl().substringBetween('custom/','.svg').substringBefore('_');
+                break;
+            }
+        }
+        
+        return u;
+    }
+
+}

main/default/classes/IconUtils.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>48.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

main/default/classes/RelatedList.cls

@@ -1,7 +1,26 @@
 public with sharing class RelatedList {
+  
+  public class ListResults {
+      @AuraEnabled
+      public List<SObject> records;
+      @AuraEnabled
+      public String iconName;
+  	
+      public ListResults(List<SObject> records, String iconName) {
+          this.records = records;
+          this.iconName = iconName;
+      } 
+  }  
+    
+    
   @AuraEnabled
-  public static List<SObject> getRecords(String soql) {
-    return Database.query(soql);
+  public static ListResults getRecords(String soql, String SObjectName, String iconName) {
+      //autoretrieve of the icon name based on sobject name if no icon is specified
+      if(String.isBlank(iconName) ) {
+          iconName = IconUtils.getIconName(SObjectName);
+      }  
+      
+      return new ListResults(Database.query(soql), iconName);
   }
 
   @AuraEnabled(cacheable=true)
@@ -15,4 +34,5 @@ public with sharing class RelatedList {
     }
     return 0;
   }
-}
+    
+}

main/default/classes/RelatedList_Test.cls

@@ -2,12 +2,16 @@
 public with sharing class RelatedList_Test {
     @IsTest
     static void getRecords_Test(){
-        
         Test.startTest();
         User testUser = [Select id from user where id = :UserInfo.getUserId()];
+        RelatedList.ListResults results = null;
         System.runAs(testUser){
-            RelatedList.getRecords('Select id from contact limit 10');
+            results = RelatedList.getRecords('Select id from contact limit 10', 'Contact', '');
         }
+        
+        //checking if the SObject icon name is well retrieved
+        System.assertEquals('standard:contact', results.iconName);
+        
         Test.stopTest();
 
     }
@@ -23,4 +27,4 @@ public with sharing class RelatedList_Test {
         Test.stopTest();
 
     }
-}
+}

main/default/lwc/lwcRelatedList/lwcRelatedList.js

@@ -53,10 +53,16 @@ export default class LightningDatatable extends NavigationMixin(
   }
 
   fetchRecords() {
-    getRecords({ soql: this.soql })
+    getRecords({ soql: this.soql, SObjectName: this.objectName, iconName: this.iconName })
       .then((data) => {
         if (data) {
-          data.map((e) => {
+          if( !this.iconName)  {
+            this.iconName = data.iconName;
+          }
+
+          let records = data.records;
+
+          records.map((e) => {
             for (let key in e) {
               if (typeof e[key] === "object") {
                 for (let onLevel in e[key]) {
@@ -65,7 +71,7 @@ export default class LightningDatatable extends NavigationMixin(
               }
             }
           });
-          this.data = data;
+          this.data = records;
         }
       })
       .catch((error) => {
@@ -252,4 +258,4 @@ export default class LightningDatatable extends NavigationMixin(
       })
     );
   }
-}
+}

main/default/lwc/lwcRelatedList/lwcRelatedList.js-meta.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
-  <apiVersion>48.0</apiVersion>
+  <apiVersion>51.0</apiVersion>
   <isExposed>true</isExposed>
   <targets>
     <target>lightning__RecordPage</target>
@@ -10,7 +10,7 @@
   <!-- Configuring the design attributes -->
   <targetConfigs>
     <targetConfig targets="lightning__RecordPage, lightning__HomePage, lightning__AppPage">
-      <property name="iconName" type="String" required="true" label="Enter Icon Name" default="standard:account" />
+      <property name="iconName" type="String" label="Enter Icon Name" />
       <property name="title" type="String" required="true" label="Enter Title" default="LWC Table" />
       <property name="objectName" type="String" required="true" label="Enter Object API Name" />
       <property name="columns" type="String" required="true" label="Enter Columns JSON" />