@salesforcedevs/docs-components 0.68.1 → 0.69.1-callout-fix-2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.68.1",
+    "version": "0.69.1-callout-fix-2",
     "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": "5aa9cb52b70c658e41dbcc89b62baf84e12ce842"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

package/src/modules/doc/amfReference/amfReference.ts

@@ -204,7 +204,7 @@ export default class AmfReference extends LightningElement {
     }
 
     restoreScroll() {
-        document.body.scrollTop = document.documentElement.scrollTop = window.history.state?.scrollValue || 0;
+        document.body.scrollTop = document.documentElement.scrollTop = window.history.state?.scrollValue;
     }
 
     renderedCallback(): void {
@@ -845,7 +845,6 @@ export default class AmfReference extends LightningElement {
      */
     protected onApiNavigationChanged(): void {
         this.saveScroll();
-        document.body.scrollTop = document.documentElement.scrollTop = 0;
 
         const specBasedReference = this.isSpecBasedReference(
             this._currentReferenceId
@@ -1275,7 +1274,6 @@ export default class AmfReference extends LightningElement {
 
     onNavSelect(event: CustomEvent): void {
         this.saveScroll();
-        document.body.scrollTop = document.documentElement.scrollTop = 0;
         
         const name = event.detail.name;
         if (name) {

package/src/modules/doc/content/content.ts

@@ -150,7 +150,7 @@ export default class Content extends LightningElement {
                     is: ContentCallout
                 });
                 const detailEls = calloutEl.querySelectorAll(
-                    "p, div.data, ol, ul, p+.codeSection, .mediaBd > span.ph"
+                    "p, .p, div.data, ol, ul, p+.codeSection, p~.codeSection, div >.codeSection, .mediaBd > span.ph"
                 );
                 detailEls.forEach((detailEl) => {
                     if (detailEl.innerHTML.trim() !== "") {
@@ -159,7 +159,7 @@ export default class Content extends LightningElement {
                 });
 
                 let flag = 1;
-                for (let i = 0; i < detailEls.length; i++) {
+                for (let i: number = 0; i < detailEls.length; i++) {
                     flag &= detailEls[i].innerHTML.trim() === "";
                 }
 

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

@@ -158,7 +158,7 @@ export default class ContentLayout extends LightningElement {
     }
 
     restoreScroll() {
-        document.body.scrollTop = document.documentElement.scrollTop = window.history.state.scrollValue;
+        document.body.scrollTop = document.documentElement.scrollTop = window.history.state?.scrollValue;
     }
 
     clearRenderObserverTimer = () => {

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

@@ -26,7 +26,7 @@
             </dx-dropdown>
         </div>
         <doc-breadcrumbs
-            if:true={breadcrumbs}
+            if:true={showBreadcrumbs}
             breadcrumbs={breadcrumbs}
             pixel-per-character={breadcrumbPixelPerCharacter}
         ></doc-breadcrumbs>

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

@@ -18,11 +18,6 @@ import { Breadcrumb, Language } from "typings/custom";
 // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
 const handleContentError = (error): void => console.log(error);
 
-const FIRST_CRUMB = {
-    href: "/docs",
-    label: "Documentation"
-};
-
 const PIXEL_PER_CHARACTER_MAP: { [key: string]: number } = {
     default: 7.7,
     "ja-jp": 12.5
@@ -581,6 +576,10 @@ export default class DocXmlContent extends LightningElementWithState<{
         );
     }
 
+    get showBreadcrumbs(): boolean {
+        return this.breadcrumbs && this.breadcrumbs.length > 0;
+    }
+
     private buildBreadcrumbs(): void {
         const { contentDocumentId } = this.pageReference;
         if (!contentDocumentId) {
@@ -588,23 +587,31 @@ export default class DocXmlContent extends LightningElementWithState<{
         }
 
         const currentNode = this.tocMap[contentDocumentId];
-        this.breadcrumbs = this.nodeToBreadcrumb(currentNode);
+        
+        if(currentNode.parent) {
+            this.breadcrumbs = this.nodeToBreadcrumb(currentNode);
+        } else {
+            this.breadcrumbs = [];
+        }
     }
 
-    private nodeToBreadcrumb(node?: TreeNode): Breadcrumb[] {
-        if (!node) {
-            return [FIRST_CRUMB];
+    private nodeToBreadcrumb(node: TreeNode): Breadcrumb[] {
+        const item = {
+            href: this.pageReferenceToString({
+                ...this.pageReference,
+                contentDocumentId: node.name
+            }),
+            label: node.label
+        };
+
+        if(node.parent) {
+            return [
+                ...this.nodeToBreadcrumb(node.parent),
+                item
+            ];
         }
-        return [
-            ...this.nodeToBreadcrumb(node.parent),
-            {
-                href: this.pageReferenceToString({
-                    ...this.pageReference,
-                    contentDocumentId: node.name
-                }),
-                label: node.label
-            }
-        ];
+
+        return [item];
     }
 
     addMetatags(): void {

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.