@salesforcedevs/docs-components 1.3.115 → 1.3.120-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.115",
+    "version": "1.3.120-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": "4a003f8c32b10b375a96b466f37a609be0a4d860"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -72,7 +72,7 @@ dx-toc {
 }
 
 .right-nav-bar {
-    margin-left: var(--dx-c-content-vertical-spacing);
+    margin-left: var(--dx-g-spacing-2xl);
 }
 
 @media screen and (max-width: 1024px) {
@@ -100,6 +100,10 @@ dx-toc {
         padding-right: 0;
     }
 
+    .sidebar-open {
+        height: 0;
+    }
+
     .left-nav-bar {
         height: unset;
         z-index: 10;

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

@@ -6,6 +6,7 @@
                 trees={sidebarContent}
                 value={sidebarValue}
                 header={sidebarHeader}
+                ontogglesidebar={onToggleSidebar}
             >
                 <slot name="sidebar-header" slot="header"></slot>
             </dx-sidebar-old>
@@ -20,13 +21,14 @@
                 coveo-public-access-token={coveoPublicAccessToken}
                 coveo-search-hub={coveoSearchHub}
                 coveo-advanced-query-config={coveoAdvancedQueryConfig}
+                ontogglesidebar={onToggleSidebar}
             >
                 <slot name="sidebar-header" slot="header"></slot>
             </dx-sidebar>
         </template>
         <div class="content-body-doc-phase-container">
             <slot name="doc-phase"></slot>
-            <div class="content-body-container">
+            <div class={contentBodyClass}>
                 <div class="content-body">
                     <doc-breadcrumbs
                         if:true={showBreadcrumbs}

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

@@ -1,4 +1,5 @@
 import { LightningElement, api, track } from "lwc";
+import cx from "classnames";
 import { closest } from "kagekiri";
 import { toJson } from "dxUtils/normalizers";
 import { highlightTerms } from "dxUtils/highlight";
@@ -83,6 +84,7 @@ export default class ContentLayout extends LightningElement {
     private observer?: IntersectionObserver;
     private hasRendered: boolean = false;
     private contentLoaded: boolean = false;
+    private sidebarOpen: boolean = false;
 
     get shouldDisplayFeedback() {
         return this.contentLoaded && typeof Sprig !== "undefined";
@@ -125,6 +127,13 @@ export default class ContentLayout extends LightningElement {
         );
     }
 
+    get contentBodyClass(): string {
+        return cx(
+            "content-body-container",
+            this.sidebarOpen ? "sidebar-open" : ""
+        );
+    }
+
     connectedCallback(): void {
         const hasParentHighlightListener = closest(
             "doc-xml-content",
@@ -153,6 +162,7 @@ export default class ContentLayout extends LightningElement {
         this.adjustNavPosition();
         window.addEventListener("scroll", this.adjustNavPosition);
         window.addEventListener("resize", this.adjustNavPosition);
+        window.addEventListener("resize", this.checkSidebarOpen);
 
         if (!this.hasRendered) {
             this.hasRendered = true;
@@ -168,6 +178,7 @@ export default class ContentLayout extends LightningElement {
         );
         window.removeEventListener("scroll", this.adjustNavPosition);
         window.removeEventListener("resize", this.adjustNavPosition);
+        window.removeEventListener("resize", this.checkSidebarOpen);
         this.searchSyncer.dispose();
         this.clearRenderObserverTimer();
 
@@ -185,7 +196,7 @@ export default class ContentLayout extends LightningElement {
         }
     };
 
-    /* 
+    /*
         This is a workaround for the global nav sticky header being decoupled from the doc header & doc phase.
         We have to account for the global nav changing height due to animations.
     */
@@ -391,4 +402,15 @@ export default class ContentLayout extends LightningElement {
         this.setSidebarInputValue(nextSearchParam);
         this.dispatchHighlightChange(nextSearchParam);
     }
+
+    private onToggleSidebar(e: CustomEvent): void {
+        this.sidebarOpen = e.detail.open;
+    }
+
+    // since the content body is set to a height of 0 when the sidebar is open, we need to reset the sidebarOpen state when the window is resized
+    private checkSidebarOpen = (): void => {
+        if (window.innerWidth > 769) {
+            this.sidebarOpen = 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.