@salesforcedevs/docs-components 0.69.0 → 0.69.2-miles

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.69.0",
+    "version": "0.69.2-miles",
     "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": "5183cd0ee93cedb7988377ff667f1e4c54ff8ea6"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -1,7 +1,7 @@
 <template>
     <nav role="navigation" aria-label={ariaLabel}>
-        <template if:false={renderSmallVariant}>
-            <template if:true={renderFirstCrumb}>
+        <template if:true={displayCrumbs}>
+            <template if:false={renderSmallVariant}>
                 <doc-breadcrumb-item
                     analytics-event={analyticsEventName}
                     analytics-base-payload={analyticsBasePayload}
@@ -9,50 +9,50 @@
                     label={firstCrumb.label}
                 ></doc-breadcrumb-item>
                 <span class="breadcrumb-item_slash">/</span>
+                <template if:true={renderDropdown}>
+                    <dx-dropdown
+                        if:true={renderDropdown}
+                        analytics-event={analyticsEventName}
+                        analytics-base-payload={analyticsBasePayload}
+                        options={dropdownOptions}
+                        open-on-hover
+                        placement="bottom"
+                        suppress-gtm-nav-headings
+                        variant="indented"
+                        width="fit-content"
+                    >
+                        <dx-button
+                            aria-label="Open Breadcrumbs Dropdown"
+                            icon-size="large"
+                            icon-symbol="threedots"
+                            variant="tertiary"
+                        ></dx-button>
+                    </dx-dropdown>
+                    <span class="breadcrumb-item_slash">/</span>
+                </template>
+                <template for:each={breadcrumbItems} for:item="breadcrumb">
+                    <doc-breadcrumb-item
+                        analytics-event={analyticsEventName}
+                        analytics-base-payload={analyticsBasePayload}
+                        href={breadcrumb.href}
+                        key={breadcrumb.id}
+                        label={breadcrumb.label}
+                    ></doc-breadcrumb-item>
+                    <span class="breadcrumb-item_slash" key={breadcrumb.label}>
+                        /
+                    </span>
+                </template>
+                <doc-breadcrumb-item label={lastCrumb.label}></doc-breadcrumb-item>
             </template>
-            <template if:true={renderDropdown}>
-                <dx-dropdown
-                    if:true={renderDropdown}
-                    analytics-event={analyticsEventName}
-                    analytics-base-payload={analyticsBasePayload}
-                    options={dropdownOptions}
-                    open-on-hover
-                    placement="bottom"
-                    suppress-gtm-nav-headings
-                    variant="indented"
-                    width="fit-content"
-                >
-                    <dx-button
-                        aria-label="Open Breadcrumbs Dropdown"
-                        icon-size="large"
-                        icon-symbol="threedots"
-                        variant="tertiary"
-                    ></dx-button>
-                </dx-dropdown>
-                <span class="breadcrumb-item_slash">/</span>
-            </template>
-            <template for:each={breadcrumbItems} for:item="breadcrumb">
+            <template if:true={renderSmallVariant}>
                 <doc-breadcrumb-item
                     analytics-event={analyticsEventName}
                     analytics-base-payload={analyticsBasePayload}
-                    href={breadcrumb.href}
-                    key={breadcrumb.id}
-                    label={breadcrumb.label}
+                    href={lastLinkCrump.href}
+                    label={lastLinkCrump.label}
+                    variant="back-arrow"
                 ></doc-breadcrumb-item>
-                <span class="breadcrumb-item_slash" key={breadcrumb.label}>
-                    /
-                </span>
             </template>
-            <doc-breadcrumb-item label={lastCrumb.label}></doc-breadcrumb-item>
-        </template>
-        <template if:true={renderSmallVariant}>
-            <doc-breadcrumb-item
-                analytics-event={analyticsEventName}
-                analytics-base-payload={analyticsBasePayload}
-                href={lastLinkCrump.href}
-                label={lastLinkCrump.label}
-                variant="back-arrow"
-            ></doc-breadcrumb-item>
         </template>
     </nav>
 </template>

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

@@ -92,7 +92,7 @@ export default class Breadcrumbs extends LightningElement {
         );
     }
 
-    private get renderFirstCrumb(): boolean {
+    private get displayCrumbs(): boolean {
         return this.breadcrumbs.length > 1;
     }
 

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

@@ -29,10 +29,12 @@
             <div class="content-body-container">
                 <div class="content-body">
                     <doc-breadcrumbs
-                        if:true={breadcrumbs}
+                        if:true={showBreadcrumbs}
                         breadcrumbs={breadcrumbs}
                     ></doc-breadcrumbs>
-                    <slot onslotchange={onSlotChange}></slot>
+                    <div style={docContentStyle}>
+                        <slot onslotchange={onSlotChange}></slot>
+                    </div>
                 </div>
                 <div class="right-nav-bar is-sticky">
                     <dx-toc

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

@@ -38,7 +38,7 @@ export default class ContentLayout extends LightningElement {
         return this._breadcrumbs;
     }
 
-    set breadcrumbs(value) {
+    set breadcrumbs(value): [] {
         if (value) {
             this._breadcrumbs = toJson(value);
         }
@@ -78,6 +78,8 @@ export default class ContentLayout extends LightningElement {
     private anchoredElements: AnchorMap = {};
     private lastScrollPosition: number;
     private observer?: IntersectionObserver;
+    private hasRendered: boolean = false;
+    
     private searchSyncer = new SearchSyncer({
         callbacks: {
             onUrlChange: (nextSearchString: string): void => {
@@ -109,6 +111,14 @@ export default class ContentLayout extends LightningElement {
         return window.location.pathname;
     }
 
+    get showBreadcrumbs(): boolean {
+        return this.breadcrumbs != null && (this.breadcrumbs as any[]).length > 1;
+    }
+
+    get docContentStyle(): string {
+        return this.showBreadcrumbs ? "" : "margin-top: 48px";
+    }
+
     connectedCallback(): void {
         const hasParentHighlightListener = closest(
             "doc-xml-content",
@@ -125,6 +135,7 @@ export default class ContentLayout extends LightningElement {
         this._scrollInterval = window.setInterval(() => {
             this.saveScroll();
           }, 1000);
+
           
     }
 
@@ -138,7 +149,10 @@ export default class ContentLayout extends LightningElement {
             this.attachInteractionObserver,
             OBSERVER_ATTACH_WAIT_TIME
         );
-        this.restoreScroll();
+        if(!this.hasRendered) {
+            this.hasRendered = true;
+            this.restoreScroll();
+        }
     }
 
     disconnectedCallback(): void {

package/src/modules/doc/xmlContent/xmlContent.html

@@ -34,6 +34,7 @@
             docs-data={docContent}
             page-reference={pageReference}
             onnavclick={handleNavClick}
+            style={docContentStyle}
         ></doc-content>
     </doc-content-layout>
 </template>

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

@@ -577,7 +577,11 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     get showBreadcrumbs(): boolean {
-        return this.breadcrumbs && this.breadcrumbs.length > 0;
+        return this.breadcrumbs && this.breadcrumbs.length > 1;
+    }
+
+    get docContentStyle(): string {
+        return this.showBreadcrumbs ? "" : "margin-top: 48px";
     }
 
     private buildBreadcrumbs(): void {
@@ -588,7 +592,7 @@ export default class DocXmlContent extends LightningElementWithState<{
 
         const currentNode = this.tocMap[contentDocumentId];
         
-        if(currentNode.parent) {
+        if(currentNode?.parent) {
             this.breadcrumbs = this.nodeToBreadcrumb(currentNode);
         } else {
             this.breadcrumbs = [];

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.