@salesforcedevs/docs-components 1.14.9-playground-404-1 → 1.16.0

package/LICENSE

@@ -0,0 +1,12 @@
+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.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.14.9-playground-404-1",
+    "version": "1.16.0",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -25,5 +25,5 @@
         "@types/lodash.orderby": "4.6.9",
         "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
+    "gitHead": "977c82c3a242a1476eee4eee5c70b03472a7492e"
 }

package/src/modules/doc/componentPlayground/componentPlayground.html

@@ -1,5 +1,5 @@
 <template>
-    <div class="container" if:true={playgroundAvailable}>
+    <div class="container" lwc:if={playgroundAvailable}>
         <dx-spinner
             size="large"
             variant="brand"
@@ -13,7 +13,7 @@
         ></iframe>
     </div>
     <dx-error-fallback
-        if:false={playgroundAvailable}
+        lwc:else
         title="Playground Unavailable"
         description="This component's playground is currently unavailable. Please check again later."
     ></dx-error-fallback>

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

@@ -11,6 +11,8 @@
                 language={language}
                 bail-href={bailHref}
                 bail-label={bailLabel}
+                dev-center={devCenter}
+                brand={brand}
             >
                 <slot name="sidebar-header" slot="version-picker"></slot>
             </dx-sidebar-old>
@@ -30,6 +32,8 @@
                 language={language}
                 bail-href={bailHref}
                 bail-label={bailLabel}
+                dev-center={devCenter}
+                brand={brand}
             >
                 <slot name="sidebar-header" slot="version-picker"></slot>
             </dx-sidebar>

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

@@ -42,6 +42,8 @@ export default class ContentLayout extends LightningElement {
     @api language!: string;
     @api bailHref!: string;
     @api bailLabel!: string;
+    @api devCenter: any;
+    @api brand: any;
 
     // This is needed for now to prevent failing snapshot tests due to links in the footer
     @api showFooter = false;

package/src/modules/doc/header/header.html

@@ -6,6 +6,7 @@
                     lwc:if={showBanner}
                     banner-markup={bannerMarkup}
                 ></dx-banner>
+                <!-- To-Do: Move the devCenter as a new component and use it here, as devCenter is also used in Sidebar now -->
                 <div lwc:if={devCenter} class="dev-center-link">
                     <a href={devCenter.link} class="dev-center-content">
                         <dx-icon symbol="back"></dx-icon>
@@ -30,7 +31,7 @@
                         </a>
                     </div>
                     <div
-                        lwc:if={hasScopedNavItems}
+                        lwc:if={showScopedNavItems}
                         class="header_l2_group header_l2_group-nav"
                     >
                         <div
@@ -48,7 +49,7 @@
             </header>
         </dx-brand-theme-provider>
     </template>
-    <template lwc:if={showDocDivider}>
+    <template lwc:if={shouldHideHeader}>
         <div class="no-header-content"></div>
     </template>
 </template>

package/src/modules/doc/header/header.ts

@@ -1,8 +1,8 @@
 import { api } from "lwc";
 import cx from "classnames";
-import type { OptionWithNested } from "typings/custom";
+import type { OptionWithNested, DevCenterConfig } from "typings/custom";
 import { HeaderBase } from "dxBaseElements/headerBase";
-import { toJson } from "dxUtils/normalizers";
+import { toJson, normalizeBoolean } from "dxUtils/normalizers";
 
 const TABLET_MATCH = "980px";
 const MOBILE_MATCH = "768px";
@@ -18,6 +18,15 @@ export default class Header extends HeaderBase {
     @api langValuePath: string = "id"; // allows to override how language property is interpreted, follows valuePath dropdown api.
     @api headerHref: string = "/";
 
+    @api
+    get hideDocHeader() {
+        return this._hideDocHeader;
+    }
+
+    set hideDocHeader(value) {
+        this._hideDocHeader = normalizeBoolean(value);
+    }
+
     @api
     get scopedNavItems() {
         return this._scopedNavItems;
@@ -28,7 +37,7 @@ export default class Header extends HeaderBase {
     }
 
     @api
-    get devCenter() {
+    get devCenter(): DevCenterConfig {
         return this._devCenter;
     }
 
@@ -41,14 +50,27 @@ export default class Header extends HeaderBase {
     private tabletMatchMedia!: MediaQueryList;
     private shouldRender: boolean = false;
     private showDocDivider: boolean = false;
-    private _devCenter: any;
+    private _devCenter!: DevCenterConfig;
+    private _hideDocHeader: boolean = false;
 
     protected mobileBreakpoint(): string {
         return MOBILE_MATCH;
     }
 
-    private get hasScopedNavItems(): boolean {
-        return this.scopedNavItems && this.scopedNavItems.length > 0;
+    private get showScopedNavItems(): boolean {
+        return (
+            this.scopedNavItems &&
+            this.scopedNavItems.length > 0 &&
+            !this.hideDocHeader
+        );
+    }
+
+    /**
+     * This function returns true if the hideDocHeader is true and the view is not mobile.
+     * Also we need to show the header border in case the doc is hidden or if the brand information doesn't exists.
+     */
+    private get shouldHideHeader(): boolean {
+        return (this.hideDocHeader && !this.mobile) || this.showDocDivider;
     }
 
     connectedCallback(): void {
@@ -60,7 +82,8 @@ export default class Header extends HeaderBase {
         this.tabletMatchMedia.addEventListener("change", this.onTabletChange);
 
         if (
-            (window.location.pathname.includes("/docs/") &&
+            (!this.shouldHideHeader &&
+                window.location.pathname.includes("/docs/") &&
                 window.location.pathname !== "/docs/apis") ||
             window.location.pathname ===
                 "/tableau/embedding-playground/overview" ||
@@ -91,7 +114,7 @@ export default class Header extends HeaderBase {
     protected additionalClasses(): string {
         return cx(
             this.brand && "has-brand",
-            this.hasScopedNavItems && "has-scoped-nav-items"
+            this.showScopedNavItems && "has-scoped-nav-items"
         );
     }
 }

package/src/modules/doc/lwcContentLayout/lwcContentLayout.html

@@ -11,6 +11,8 @@
                 language={language}
                 bail-href={bailHref}
                 bail-label={bailLabel}
+                dev-center={devCenter}
+                brand={brand}
             >
                 <slot name="sidebar-header" slot="version-picker"></slot>
             </dx-sidebar-old>
@@ -30,6 +32,8 @@
                 language={language}
                 bail-href={bailHref}
                 bail-label={bailLabel}
+                dev-center={devCenter}
+                brand={brand}
             >
                 <slot name="sidebar-header" slot="version-picker"></slot>
             </dx-sidebar>