@salesforcedevs/docs-components 1.3.126 → 1.3.127-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.126",
+    "version": "1.3.127-alpha.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": "a2651830cfd3ed7af0373f7792acd852d903fe0b"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

package/src/modules/doc/content/content.css

@@ -402,3 +402,10 @@ samp,
 mark {
     background-color: var(--dx-g-yellow-vibrant-90);
 }
+
+/* offset page jump link due to fixed header */
+[id] {
+    scroll-margin-top: calc(
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
+    );
+}

package/src/modules/doc/contentLayout/contentLayout.css

@@ -40,6 +40,13 @@ dx-toc {
     display: block;
 }
 
+/* offset page jump link due to fixed header */
+::slotted(doc-heading) {
+    scroll-margin-top: calc(
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
+    );
+}
+
 .content {
     display: flex;
     position: relative;

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

@@ -1,3 +1,4 @@
+/* eslint-disable @lwc/lwc/no-document-query */
 import { LightningElement, api, track } from "lwc";
 import { closest } from "kagekiri";
 import { toJson } from "dxUtils/normalizers";
@@ -204,7 +205,10 @@ export default class ContentLayout extends LightningElement {
         const docHeaderEl = document.querySelector(
             ".sticky-doc-header"
         ) as HTMLElement;
-        const docPhaseEl = document.querySelector("doc-phase") as HTMLElement;
+
+        const docPhaseEl = this.template
+            .querySelector("[name=doc-phase]")!
+            .assignedElements()[0] as HTMLSlotElement;
 
         if (!sidebarEl || !globalNavEl || !contextNavEl || !docHeaderEl) {
             console.warn("One or more required elements are missing.");
@@ -237,6 +241,17 @@ export default class ContentLayout extends LightningElement {
                             : globalNavHeight + docHeaderHeight
                     }px`
                 );
+
+                const rightNavBarEl =
+                    this.template.querySelector(".right-nav-bar");
+
+                if (rightNavBarEl) {
+                    rightNavBarEl.style.top = `${
+                        globalNavHeight +
+                        docHeaderHeight +
+                        docPhaseEl.offsetHeight
+                    }px`;
+                }
             }
         });
     };

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

@@ -4,6 +4,7 @@
 
 :host {
     --doc-c-phase-top: 0;
+    --doc-c-phase-container-align-items: flex-start;
 
     position: sticky;
     top: var(--doc-c-phase-top);
@@ -15,7 +16,7 @@
 .doc-phase-container {
     display: flex;
     flex-direction: column;
-    align-items: center;
+    align-items: var(--doc-c-phase-container-align-items);
     padding-left: var(--dx-g-global-header-padding-horizontal);
     padding-right: var(--dx-g-global-header-padding-horizontal);
     width: 100%;
@@ -40,7 +41,7 @@ dx-button {
     margin-left: auto;
 }
 
-/* 
+/*
     NOTE: Here we are assuming that indicator height won't go beyond 1000px.
 
     It's one of the suggested way to achieve the expand/collapse animation

package/src/modules/doc/xmlContent/xmlContent.ts

@@ -156,28 +156,7 @@ export default class DocXmlContent extends LightningElementWithState<{
                 ));
 
         if (anchorEl) {
-            const globalNavHeader = document.querySelector(
-                ".global-nav-container"
-            ) as HTMLElement;
-            const docHeader = document.querySelector(
-                "doc-header"
-            ) as HTMLElement;
-            const headerHeight = globalNavHeader.offsetHeight;
-            const docHeaderHeight = docHeader.offsetHeight;
-            const rect = anchorEl.getBoundingClientRect();
-
-            // Calculate the scroll position required to bring the element into view
-            const scrollTop =
-                window.pageYOffset || document.documentElement.scrollTop;
-            const scrollX = rect.left + window.pageXOffset;
-            const scrollY =
-                rect.top + scrollTop - (headerHeight + docHeaderHeight); // subtract the header height from the top position
-
-            // Scroll to the calculated position
-            window.scrollTo({
-                top: scrollY,
-                left: scrollX
-            });
+            anchorEl.scrollIntoView();
 
             this.setState({ internalLinkClicked: false });
         }

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.