@salesforcedevs/docs-components 0.66.4 → 0.67.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.66.4",
+    "version": "0.67.0",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -24,5 +24,5 @@
         "@types/lodash.orderby": "^4.6.7",
         "@types/lodash.uniqby": "^4.7.7"
     },
-    "gitHead": "14d718be69bd8599b9ce3520a65dc8f0cb5f17de"
+    "gitHead": "187d8abcbea7dd2ec9f0352c3563662c44abbde8"
 }

package/src/modules/doc/amfReference/amfReference.ts

@@ -138,6 +138,7 @@ export default class AmfReference extends LightningElement {
     protected _amfConfigMap: Map<string, AmfConfig> = new Map();
     protected _referenceSetConfig!: ReferenceSetConfig;
     protected _currentReferenceId = "";
+    protected _scrollInterval = 0;
 
     protected parentReferenceUrls = [];
     protected amfMap: Record<string, AmfModelRecord> = {};
@@ -165,6 +166,7 @@ export default class AmfReference extends LightningElement {
 
     constructor() {
         super();
+
         this._boundOnApiNavigationChanged =
             this.onApiNavigationChanged.bind(this);
         this._boundUpdateSelectedItemFromUrlQuery =
@@ -180,6 +182,9 @@ export default class AmfReference extends LightningElement {
             "popstate",
             this._boundUpdateSelectedItemFromUrlQuery
         );
+        this._scrollInterval = window.setInterval(() => {
+            this.saveScroll();
+          }, 1000);
     }
 
     disconnectedCallback(): void {
@@ -191,6 +196,15 @@ export default class AmfReference extends LightningElement {
             "popstate",
             this._boundUpdateSelectedItemFromUrlQuery
         );
+        window.clearInterval(this._scrollInterval);
+    }
+
+    saveScroll() {
+        window.history.replaceState({ scrollValue: document.body.scrollTop }, "", window.location.href);
+    }
+
+    restoreScroll() {
+        document.body.scrollTop = document.documentElement.scrollTop = window.history.state.scrollValue;
     }
 
     renderedCallback(): void {
@@ -760,8 +774,9 @@ export default class AmfReference extends LightningElement {
         if (meta) {
             // update the encoded url meta param
             const encodedMeta = this.getUrlEncoded(meta);
+
             window.history.pushState(
-                {},
+                { },
                 "",
                 `${parentReferencePath}?meta=${encodedMeta}`
             );
@@ -779,7 +794,7 @@ export default class AmfReference extends LightningElement {
             // update the encoded url meta param
             const encodedMeta = this.getUrlEncoded(meta);
             window.history.replaceState(
-                {},
+                window.history.state,
                 "",
                 `${parentReferencePath}?meta=${encodedMeta}`
             );
@@ -820,6 +835,8 @@ export default class AmfReference extends LightningElement {
         } else {
             this.loadMarkdownBasedReference();
         }
+
+        this.restoreScroll();
     }
 
     /**
@@ -827,6 +844,9 @@ export default class AmfReference extends LightningElement {
      * @param event
      */
     protected onApiNavigationChanged(): void {
+        this.saveScroll();
+        document.body.scrollTop = document.documentElement.scrollTop = 0;
+
         const specBasedReference = this.isSpecBasedReference(
             this._currentReferenceId
         );
@@ -866,6 +886,7 @@ export default class AmfReference extends LightningElement {
         elementId: string,
         meta: string
     ): void {
+
         this.selectedTopic = {
             referenceId,
             parentReferencePath,
@@ -1207,7 +1228,8 @@ export default class AmfReference extends LightningElement {
                     window.location.href = redirectReferenceUrl;
                 } else {
                     // This is for CASE 1,3 and 4 mentioned above, Where we need to update the browser history
-                    window.history.replaceState({}, "", redirectReferenceUrl);
+                    window.history.replaceState(window.history.state, "", redirectReferenceUrl);
+
                 }
             }
         }
@@ -1252,6 +1274,9 @@ export default class AmfReference extends LightningElement {
     }
 
     onNavSelect(event: CustomEvent): void {
+        this.saveScroll();
+        document.body.scrollTop = document.documentElement.scrollTop = 0;
+        
         const name = event.detail.name;
         if (name) {
             const urlReferenceId = this.getReferenceIdFromUrl(name);
@@ -1327,7 +1352,5 @@ export default class AmfReference extends LightningElement {
             parser: this.amfMap[referenceId].parser,
             id: amfId
         };
-
-        window.scrollTo({ top: 0, behavior: "smooth" });
     }
 }

package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts

@@ -58,8 +58,7 @@ export default class BreadcrumbItem extends LightningElement {
         track(event.target!, this.analyticsEvent, {
             ...this.analyticsBasePayload,
             clickText: this.label,
-            itemTitle: this.label,
-            pageLocation: window.location.pathname
+            clickUrl: this.href
         });
     }
 }

package/src/modules/doc/breadcrumbs/breadcrumbs.ts

@@ -21,8 +21,7 @@ export const ANALYTICS_EVENT_NAME = "custEv_breadcrumbClick";
 export const ANALYTICS_BASE_PAYLOAD = {
     elementType: "breadcrumb",
     locationOnPage: "breadcrumb",
-    ctaClick: true,
-    pageLocation: window.location.pathname
+    ctaClick: true
 };
 
 export default class Breadcrumbs extends LightningElement {
@@ -110,7 +109,10 @@ export default class Breadcrumbs extends LightningElement {
     }
 
     private get analyticsBasePayload() {
-        return ANALYTICS_BASE_PAYLOAD;
+        return {
+            ...ANALYTICS_BASE_PAYLOAD,
+            itemTitle: this.breadcrumbs.map((crumb) => crumb.label).join("/")
+        };
     }
 
     renderedCallback(): void {

package/src/modules/doc/contentLayout/contentLayout.ts

@@ -98,6 +98,7 @@ export default class ContentLayout extends LightningElement {
     private tocValue?: string = undefined;
     private observerTimerId = null;
     private didScrollToSelectedHash = false;
+    private _scrollInterval = 0;
 
     get showToc(): boolean {
         return this.tocOptions && this.tocOptions.length > 0;
@@ -120,6 +121,11 @@ export default class ContentLayout extends LightningElement {
             );
             this.searchSyncer.init();
         }
+
+        this._scrollInterval = window.setInterval(() => {
+            this.saveScroll();
+          }, 1000);
+          
     }
 
     renderedCallback(): void {
@@ -132,6 +138,7 @@ export default class ContentLayout extends LightningElement {
             this.attachInteractionObserver,
             OBSERVER_ATTACH_WAIT_TIME
         );
+        this.restoreScroll();
     }
 
     disconnectedCallback(): void {
@@ -142,6 +149,16 @@ export default class ContentLayout extends LightningElement {
         );
         this.searchSyncer.dispose();
         this.clearRenderObserverTimer();
+
+        window.clearInterval(this._scrollInterval);
+    }
+
+    saveScroll() {
+        window.history.replaceState({ scrollValue: document.body.scrollTop }, "", window.location.href);
+    }
+
+    restoreScroll() {
+        document.body.scrollTop = document.documentElement.scrollTop = window.history.state.scrollValue;
     }
 
     clearRenderObserverTimer = () => {