@salesforcedevs/docs-components 1.3.122 → 1.3.124-old-version-banner

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.122",
+    "version": "1.3.124-old-version-banner",
     "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": "9741a2ed52c5106459cb1bd807bafac9aff25ff3"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

package/src/modules/doc/amfReference/amfReference.css

@@ -4,6 +4,21 @@ doc-phase {
     );
 }
 
+/* We need to apply some borders when there are two doc phases */
+doc-phase:not(:only-child):first-child::part(container) {
+    border-top: 1px solid #f9e3b6 !important;
+}
+
+doc-phase:nth-child(2)::part(container) {
+    border-top: 1px solid #f9e3b6 !important;
+    border-bottom: 1px solid #f9e3b6 !important;
+}
+
+/* We don't want second component to sticky as we need to handle different cases like position*/
+doc-phase:nth-child(2) {
+    position: static;
+}
+
 .api-documentation {
     margin-top: 48px;
 }

package/src/modules/doc/amfReference/amfReference.html

@@ -21,6 +21,13 @@
             if:true={docPhaseInfo}
             doc-phase-info={docPhaseInfo}
         ></doc-phase>
+        <doc-phase
+            slot="version-banner"
+            if:true={oldVersionInfo}
+            doc-phase-info={oldVersionInfo}
+            dismissible="true"
+            icon="warning"
+        ></doc-phase>
         <div slot="sidebar-header" class="version-picker">
             <template if:true={isVersionEnabled}>
                 <dx-dropdown

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

@@ -44,6 +44,12 @@ export default class AmfReference extends LightningElement {
     @track
     protected topicModel!: TopicModel;
 
+    @api oldVersionInfo = {
+        title: "Newer Version Available",
+        body: `This content describes an older version of this product. <a style="font-weight: bold;" href="https://developer.salesforce.com/">
+                View Latest</a>`,
+    }
+
     get isVersionEnabled(): boolean {
         return !!this._referenceSetConfig?.versions?.length;
     }

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,12 +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>
+            <slot name="version-banner"></slot>
             <div class="content-body-container">
                 <div class="content-body">
                     <doc-breadcrumbs

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

@@ -83,6 +83,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";
@@ -185,7 +186,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 +392,15 @@ export default class ContentLayout extends LightningElement {
         this.setSidebarInputValue(nextSearchParam);
         this.dispatchHighlightChange(nextSearchParam);
     }
+
+    private onToggleSidebar(e: CustomEvent): void {
+        this.sidebarOpen = e.detail.open;
+
+        // eslint-disable-next-line @lwc/lwc/no-document-query
+        const footer = document.querySelector("dx-footer") as HTMLElement;
+
+        if (footer) {
+            footer.style.display = this.sidebarOpen ? "none" : "block";
+        }
+    }
 }

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

@@ -64,6 +64,10 @@ dx-button {
     color: var(--dx-g-blue-vibrant-50);
 }
 
+.dismissible-icon {
+    margin-left: auto;
+}
+
 /* Small Devices */
 @media screen and (max-width: 480px) {
     .doc-phase-container {

package/src/modules/doc/phase/phase.html

@@ -4,7 +4,7 @@
             <div class="doc-phase-title-container">
                 <dx-icon
                     class="doc-status-icon doc-phase-icon"
-                    symbol="recipe"
+                    symbol={iconName}
                     size="large"
                     color="status-icon-color"
                 ></dx-icon>
@@ -12,18 +12,27 @@
                     {docPhaseTitle}
                 </p>
                 <dx-button
+                    if:false={dismissible}
                     variant="inline"
-                    onclick={onButtonClick}
+                    onclick={onShowHide}
                     aria-label={hideBodyText}
                 >
                     {hideBodyText}
                 </dx-button>
+                <dx-icon
+                    class="dismissible-icon"
+                    onclick={onDismiss}
+                    if:true={dismissible}
+                    symbol="close"
+                    size="large"
+                    color="status-icon-color"
+                ></dx-icon>
             </div>
             <!--
-            NOTE: Here we are rendering mark up using lwc:dom & innerHTML
-            option instead of slots because the html markup will come as a
-            property to the component from a configuration
-        -->
+                NOTE: Here we are rendering mark up using lwc:dom & innerHTML
+                option instead of slots because the html markup will come as a
+                property to the component from a configuration
+            -->
             <span lwc:dom="manual" class={bodyClassName}></span>
         </div>
     </div>

package/src/modules/doc/phase/phase.ts

@@ -2,16 +2,12 @@ import { LightningElement, api } from "lwc";
 import cx from "classnames";
 
 import { DocPhaseInfo } from "typings/custom";
-import { toJson } from "dxUtils/normalizers";
+import { toJson, normalizeBoolean } from "dxUtils/normalizers";
 
 export default class Phase extends LightningElement {
     _docPhaseInfo: DocPhaseInfo | null = null;
-
-    isBodyHidden = false;
-
-    get docPhaseTitle() {
-        return this.docPhaseInfo?.title;
-    }
+    _dismissible = false;
+    _iconName = 'recipe';
 
     @api
     get docPhaseInfo(): DocPhaseInfo | null {
@@ -22,6 +18,34 @@ export default class Phase extends LightningElement {
         this._docPhaseInfo = toJson(value);
     }
 
+    @api
+    get dismissible(): boolean {
+        return this._dismissible;
+    }
+
+    set dismissible(value) {
+        if (value) {
+            this._dismissible = normalizeBoolean(value);
+        }
+    }
+
+    @api
+    get iconName(): string {
+        return this._iconName;
+    }
+
+    set iconName(value) {
+        if (value) {
+            this._iconName = value;
+        }
+    }
+
+    isBodyHidden = false;
+
+    get docPhaseTitle() {
+        return this.docPhaseInfo?.title;
+    }
+
     get hideBodyText() {
         return this.isBodyHidden ? "Show" : "Hide";
     }
@@ -52,7 +76,19 @@ export default class Phase extends LightningElement {
         }
     }
 
-    onButtonClick() {
+    onShowHide() {
         this.isBodyHidden = !this.isBodyHidden;
     }
+    
+    onDismiss(){
+        this.dispatchEvent(
+            new CustomEvent("dismissbanner", {
+                detail: { 
+                    docPhaseInfo: this.docPhaseInfo
+                },
+                composed: true,
+                bubbles: true
+            })
+        );   
+    }
 }

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

@@ -11,6 +11,13 @@
         onselect={handleSelect}
         use-old-sidebar={useOldSidebar}
     >
+        <doc-phase
+            slot="version-banner"
+            if:true={oldVersionInfo}
+            doc-phase-info={oldVersionInfo}
+            dismissible="true"
+            icon="warning"
+        ></doc-phase>
         <div slot="sidebar-header" class="document-pickers">
             <dx-dropdown
                 data-type="version"

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

@@ -34,6 +34,12 @@ export default class DocXmlContent extends LightningElementWithState<{
     @api coveoPublicAccessToken!: string;
     @api coveoSearchHub!: string;
 
+    @api oldVersionInfo = {
+        title: "Newer Version Available",
+        body: `This content describes an older version of this product. <a style="font-weight: bold;" href="https://developer.salesforce.com/">
+                View Latest</a>`,
+    }
+
     @api
     get allLanguages(): Array<Language> {
         return this._allLanguages;

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.