@salesforcedevs/dx-components 0.43.3-tree-selected-scroll-6 → 0.43.3-tree-selected-scroll-9

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "0.43.3-tree-selected-scroll-6",
+    "version": "0.43.3-tree-selected-scroll-9",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {

package/src/modules/base-elements/sidebarBase/sidebarBase.ts

@@ -5,8 +5,8 @@ export const WAIT_TIME_BEFORE_SCROLL_IN_MS = 500;
 
 export class SidebarBase extends LightningElement {
     _sidebarContent: HTMLElement | null = null;
-    selectedTreeItem: HTMLElement | null = null;
 
+    selectedElement: HTMLElement | null = null;
     timerId: ReturnType<typeof setTimeout> | null = null;
 
     get sidebarContent() {
@@ -18,34 +18,48 @@ export class SidebarBase extends LightningElement {
         return this._sidebarContent;
     }
 
-    private onSelectedItemRendered(event: CustomEvent) {
-        event.stopPropagation();
-        this.selectedTreeItem = event.detail.element;
+    renderedCallback(): void {
+        /**
+         * Implementing debouncing kind of logic here to scroll to selected element once tree rendering is done
+         */
+
+        if (this.timerId) {
+            clearTimeout(this.timerId);
+        }
+        this.timerId = setTimeout(
+            this.renderedCallbackWithTimeout,
+            WAIT_TIME_BEFORE_SCROLL_IN_MS
+        );
+    }
+
+    disconnectedCallback(): void {
+        if (this.timerId) {
+            clearTimeout(this.timerId);
+        }
     }
 
+    renderedCallbackWithTimeout = () => {
+        this.scrollToSelectedItem();
+    };
+
+    private onSelectedItemRendered = (event: CustomEvent) => {
+        event.stopPropagation();
+        this.selectedElement = event.detail.element;
+    };
+
     /*Scroll to selected tree item */
-    private scrollToSelectedTreeItem() {
-        if (this.selectedTreeItem && this.sidebarContent) {
+    private scrollToSelectedItem() {
+        if (this.selectedElement && this.sidebarContent) {
             const scrollHeight: number =
-                this.selectedTreeItem.getBoundingClientRect().bottom -
+                this.selectedElement.getBoundingClientRect().bottom -
                 this.sidebarContent.getBoundingClientRect().bottom + // We need to remove parent bottom
-                HEIGHT_OF_SIDEBAR_ITEM * 3; // add height of 3 more items so that user can see at least three more items after selected item
+                HEIGHT_OF_SIDEBAR_ITEM * 3 + // add height of 3 more items so that user can see at least three more items after selected item
+                this.sidebarContent.offsetTop; // We need to add sidebar offsetTop value as scrollTo will consider it
             this.sidebarContent.scrollTo({
                 top: scrollHeight,
                 behavior: "smooth"
             });
-            this.selectedTreeItem = null;
+            this.selectedElement = null;
         }
     }
-
-    renderedCallback(): void {
-        // Implementing debouncing kind of logic here, So that multiple scrolls won't be triggered during multiple renders of selected item
-        if (this.timerId) {
-            clearTimeout(this.timerId);
-        }
-        this.timerId = setTimeout(
-            () => this.scrollToSelectedTreeItem(),
-            WAIT_TIME_BEFORE_SCROLL_IN_MS
-        );
-    }
 }

package/src/modules/dx/sidebar/sidebar.ts

@@ -160,6 +160,7 @@ export default class Sidebar extends SidebarBase {
     }
 
     disconnectedCallback() {
+        super.disconnectedCallback()
         this.matchMedia.removeEventListener("change", this.onMediaChange);
     }
 

package/src/modules/dx/sidebarOld/sidebarOld.ts

@@ -81,11 +81,12 @@ export default class Sidebar extends SidebarBase {
         this.matchMedia.addEventListener("change", this.onMediaChange);
     }
 
-    renderedCallback(): void {
+    renderedCallback() {
         super.renderedCallback();
     }
 
     disconnectedCallback() {
+        super.disconnectedCallback()
         this.matchMedia.removeEventListener("change", this.onMediaChange);
     }