@salesforcedevs/docs-components 1.20.3 → 1.20.6-sticky-banner

package/package.json

@@ -1,11 +1,12 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.20.3",
+    "version": "1.20.6-sticky-banner",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
     "engines": {
-        "node": "20.x"
+        "node": "20.x",
+        "yarn": "1.22.19"
     },
     "publishConfig": {
         "access": "public"
@@ -25,5 +26,9 @@
         "@types/lodash.orderby": "4.6.9",
         "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "53341fe3e51cffb3368cbf3fbea5ef382250ce9e"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad",
+    "volta": {
+        "node": "20.19.0",
+        "yarn": "1.22.19"
+    }
 }

package/src/modules/doc/breadcrumbs/breadcrumbs.html

@@ -11,7 +11,6 @@
                 <template if:true={renderDropdown}>
                     <dx-dropdown
                         analytics-event="custEv_breadcrumbClick"
-                        analytics-payload={ANALYTICS_PAYLOAD}
                         if:true={renderDropdown}
                         options={dropdownOptions}
                         open-on-hover

package/src/modules/doc/contentLayout/contentLayout.html

@@ -17,8 +17,12 @@
             <slot name="sidebar-header" slot="version-picker"></slot>
         </dx-sidebar-old>
         <div class="content-body-doc-phase-container">
-            <slot name="doc-phase"></slot>
-            <slot name="version-banner"></slot>
+            <div class="doc-phase-wrapper">
+                <slot name="doc-phase"></slot>
+            </div>
+            <div class="version-banner-wrapper">
+                <slot name="version-banner"></slot>
+            </div>
             <div class="content-body-container">
                 <div class="content-body">
                     <doc-breadcrumbs

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

@@ -217,15 +217,16 @@ export default class ContentLayout extends LightningElement {
             ".sticky-doc-header"
         ) as HTMLElement;
 
-        let docPhaseEl = (
-            this.template.querySelector("[name=doc-phase]")! as any
+        const docPhaseWrapper = this.template.querySelector(".doc-phase-wrapper") as HTMLElement;
+        const versionBannerWrapper = this.template.querySelector(".version-banner-wrapper") as HTMLElement;
+
+        const docPhaseEl = (
+            docPhaseWrapper.querySelector("[name=doc-phase]")! as any
         ).assignedElements()[0] as HTMLSlotElement;
 
-        if (!docPhaseEl) {
-            docPhaseEl = (
-                this.template.querySelector("[name=version-banner]")! as any
-            ).assignedElements()[0] as HTMLSlotElement;
-        }
+        const verBannerEl = (
+            versionBannerWrapper.querySelector("[name=version-banner]")! as any
+        ).assignedElements()[0] as HTMLSlotElement;
 
         if (!sidebarEl || !globalNavEl || !contextNavEl || !docHeaderEl) {
             console.warn("One or more required elements are missing.");
@@ -257,23 +258,18 @@ export default class ContentLayout extends LightningElement {
                 `${globalNavHeight}px`
             );
 
+            const docPhaseElHeight = (docPhaseEl || verBannerEl)
+                    ? (docPhaseEl || verBannerEl).getBoundingClientRect().height
+                    : 0;
+
             // Adjusting the doc section heading on scroll.
             docHeadingEls.forEach((docHeadingEl) => {
-                (docHeadingEl as any).style.scrollMarginTop = docPhaseEl
-                    ? `${
-                          totalHeaderHeight +
-                          docPhaseEl.getBoundingClientRect().height +
-                          40
-                      }px`
-                    : `${totalHeaderHeight + 40}px`;
+                (docHeadingEl as any).style.scrollMarginTop = `${totalHeaderHeight + docPhaseElHeight + 40}px`;
             });
 
             // Adjusting the right nav bar on scroll.
             // setting maxheight to make the RNB scrollable based on different parent elements
             if (rightNavBarEl) {
-                const docPhaseElHeight = docPhaseEl
-                    ? docPhaseEl.getBoundingClientRect().height
-                    : 0;
                 const viewportHeight = window.innerHeight;
                 const maxHeight =
                     viewportHeight -
@@ -293,18 +289,15 @@ export default class ContentLayout extends LightningElement {
                 }
             }
 
+            const docPhaseTop = window.innerWidth < 769 ? globalNavHeight + docHeaderHeight + sidebarEl.getBoundingClientRect().height : globalNavHeight + docHeaderHeight
+
             // If doc phase element exists, we need to account for its sticky position. Mobile should include the sidebar height (since it becomes sticky aswell).
+            // To handle sticky position for safari browser, position sticky given to wrapper class
             if (docPhaseEl) {
-                docPhaseEl.style.setProperty(
-                    "--doc-c-phase-top",
-                    `${
-                        window.innerWidth < 769
-                            ? globalNavHeight +
-                              docHeaderHeight +
-                              sidebarEl.getBoundingClientRect().height
-                            : globalNavHeight + docHeaderHeight
-                    }px`
-                );
+                docPhaseWrapper.style.top = `${docPhaseTop}px`;
+            } else if(verBannerEl) {
+                versionBannerWrapper.style.position = 'sticky';
+                versionBannerWrapper.style.top = `${docPhaseTop}px`;
             }
         });
     };

package/src/modules/doc/lwcContentLayout/lwcContentLayout.html

@@ -16,8 +16,12 @@
             <slot name="sidebar-header" slot="version-picker"></slot>
         </dx-sidebar-old>
         <div class="content-body-doc-phase-container">
-            <slot name="doc-phase"></slot>
-            <slot name="version-banner"></slot>
+            <div class="doc-phase-wrapper">
+                <slot name="doc-phase"></slot>
+            </div>
+            <div class="version-banner-wrapper">
+                <slot name="version-banner"></slot>
+            </div>
             <div class="content-body-container">
                 <div class={contentBodyClasses}>
                     <doc-breadcrumbs

package/src/modules/doc/phase/phase.css

@@ -5,12 +5,6 @@
 :host {
     --doc-c-phase-top: 0;
     --doc-c-phase-container-align-items: flex-start;
-
-    position: sticky;
-    top: var(--doc-c-phase-top);
-
-    /* NOTE: If you are changing z-index value here, ensure it's less than z-index of dx-sidebar in contentLayout.css */
-    z-index: var(--dx-g-z-index-100);
 }
 
 .doc-phase-container {

package/src/modules/doc/versionPicker/versionPicker.html

@@ -2,6 +2,8 @@
     <div lwc:if={showVersionPicker} class="version-picker-container">
         <dx-dropdown
             options={versions}
+            analytics-event="custEv_docVersionSelect"
+            analytics-payload={analyticsPayload}
             value={selectedVersion.id}
             width="var(--doc-version-picker-width)"
             onchange={onVersionChange}

package/src/modules/docHelpers/contentLayoutStyle/contentLayoutStyle.css

@@ -59,6 +59,19 @@ dx-toc {
     border-left: 1px solid var(--dx-g-gray-90);
 }
 
+.doc-phase-wrapper,
+.version-banner-wrapper {
+    z-index: var(--dx-g-z-index-100);
+}
+
+.doc-phase-wrapper {
+    position: sticky;
+}
+  
+.version-banner-wrapper {
+    position: static;
+}
+
 .content-body-container {
     display: flex;
     flex-direction: row;

package/LICENSE

@@ -1,12 +0,0 @@
-Copyright (c) 2020, Salesforce.com, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.