@salesforcedevs/docs-components 1.14.8-ldh-alpha6 → 1.14.8-ldh-alpha7

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.14.8-ldh-alpha6",
+    "version": "1.14.8-ldh-alpha7",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",

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>

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

@@ -1,6 +1,6 @@
 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, normalizeBoolean } from "dxUtils/normalizers";
 
@@ -37,7 +37,7 @@ export default class Header extends HeaderBase {
     }
 
     @api
-    get devCenter() {
+    get devCenter(): DevCenterConfig {
         return this._devCenter;
     }
 
@@ -50,7 +50,7 @@ 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 {
@@ -65,6 +65,10 @@ export default class Header extends HeaderBase {
         );
     }
 
+    /**
+     * 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 isHideHeader(): boolean {
         return (this.hideDocHeader && !this.mobile) || this.showDocDivider;
     }