@salesforcedevs/docs-components 1.17.11 → 1.17.12-banner

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.17.11",
+    "version": "1.17.12-banner",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -25,5 +25,5 @@
         "@types/lodash.orderby": "4.6.9",
         "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "788524c2a30a036b5c06c95ecdb37b46ee522ea5"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -248,41 +248,65 @@ export default class ContentLayout extends LightningElement {
             const docHeaderHeight = docHeaderEl.getBoundingClientRect().height;
             const totalHeaderHeight = globalNavHeight + docHeaderHeight;
 
+            // Collect any banners rendered via the doc-phase and version-banner slots
+            const versionBannerSlot = this.template.querySelector(
+                "[name=version-banner]"
+            ) as any;
+            const docPhaseSlot = this.template.querySelector(
+                "[name=doc-phase]"
+            ) as any;
+            const versionBannerEls = (
+                versionBannerSlot
+                    ? (versionBannerSlot.assignedElements() as HTMLElement[])
+                    : []
+            ) as HTMLElement[];
+            const docPhaseEls = (
+                docPhaseSlot
+                    ? (docPhaseSlot.assignedElements() as HTMLElement[])
+                    : []
+            ) as HTMLElement[];
+            const bannersTotalHeight = [
+                ...versionBannerEls,
+                ...docPhaseEls
+            ].reduce(
+                (sum, el) => sum + (el?.getBoundingClientRect()?.height || 0),
+                0
+            );
+
             // Selecting the doc section heading and RNB here.
             const docHeadingEls = Array.from(
                 document.querySelectorAll("doc-heading")
             );
             const rightNavBarEl = this.template.querySelector(".right-nav-bar");
 
-            sidebarEl.style.setProperty(
+            (sidebarEl as HTMLElement).style.setProperty(
                 "--dx-c-content-sidebar-sticky-top",
-                `${globalNavHeight + docHeaderHeight}px`
+                `${totalHeaderHeight}px`
             );
 
             docHeaderEl.style.setProperty(
                 "--dx-g-global-header-height",
                 `${globalNavHeight}px`
             );
+            // Expose heights as CSS variables for sticky offsets used by page content
+            const rootStyle = document.documentElement.style;
+            rootStyle.setProperty(
+                "--dx-g-doc-header-banner-height",
+                `${docHeaderHeight + bannersTotalHeight}px`
+            );
 
             // 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 + bannersTotalHeight + 40
+                }px`;
             });
 
             // Adjusting the right nav bar on scroll.
             if (rightNavBarEl) {
-                rightNavBarEl.style.top = docPhaseEl
-                    ? `${
-                          totalHeaderHeight +
-                          docPhaseEl.getBoundingClientRect().height
-                      }px`
-                    : `${totalHeaderHeight}px`;
+                (rightNavBarEl as HTMLElement).style.top = `${
+                    totalHeaderHeight + bannersTotalHeight
+                }px`;
             }
 
             // If doc phase element exists, we need to account for its sticky position. Mobile should include the sidebar height (since it becomes sticky aswell).

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.