@salesforcedevs/docs-components 1.34.3 → 1.34.4-scroll-1

package/package.json

@@ -1,29 +1,30 @@
 {
-    "name": "@salesforcedevs/docs-components",
-    "version": "1.34.3",
-    "description": "Docs Lightning web components for DSC",
-    "license": "MIT",
-    "main": "index.js",
-    "engines": {
-        "node": "22.x"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "dependencies": {
-        "@api-components/amf-helper-mixin": "4.5.29",
-        "classnames": "2.5.1",
-        "dompurify": "3.2.4",
-        "kagekiri": "1.4.2",
-        "lodash.orderby": "4.6.0",
-        "lodash.uniqby": "4.7.0",
-        "query-string": "7.1.3",
-        "sentence-case": "3.0.4"
-    },
-    "devDependencies": {
-        "@types/classnames": "2.3.1",
-        "@types/lodash.orderby": "4.6.9",
-        "@types/lodash.uniqby": "4.7.9"
-    },
-    "gitHead": "c8c3bb1003d40a55fdd5733c7891dcca3931fb24"
-}
+  "name": "@salesforcedevs/docs-components",
+  "version": "1.34.4-scroll-1",
+  "description": "Docs Lightning web components for DSC",
+  "license": "MIT",
+  "main": "index.js",
+  "engines": {
+    "node": "22.x"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@api-components/amf-helper-mixin": "4.5.29",
+    "classnames": "2.5.1",
+    "dompurify": "3.2.4",
+    "kagekiri": "1.4.2",
+    "lodash.orderby": "4.6.0",
+    "lodash.uniqby": "4.7.0",
+    "query-string": "7.1.3",
+    "sentence-case": "3.0.4"
+  },
+  "devDependencies": {
+    "@types/classnames": "2.3.1",
+    "@types/lodash.orderby": "4.6.9",
+    "@types/lodash.uniqby": "4.7.9"
+  },
+  "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad",
+  "stableVersion": "1.34.4"
+}

package/src/modules/doc/banner/banner.css

@@ -16,8 +16,6 @@
 }
 
 .icon {
-    --dx-c-icon-size: var(--dx-g-icon-size-lg);
-
     flex-shrink: 0;
     margin-top: var(--dx-g-spacing-smd);
     margin-right: var(--dx-g-spacing-sm);
@@ -73,6 +71,47 @@
     cursor: pointer;
 }
 
+/* Centered variant: the message is centered in the banner and the icon hangs
+   to its left. The close button is taken out of the flow so it doesn't offset
+   the centering. */
+.container_centered {
+    position: relative;
+    display: grid;
+    grid-template-columns: 1fr auto 1fr;
+    align-items: center;
+
+    /* Reserve the close button's width plus its right inset on both sides */
+    padding: 0
+        calc(
+            var(--dx-g-spacing-3xl) + var(--dx-g-spacing-xs) +
+                var(--doc-banner-padding-right)
+        );
+}
+
+.container_centered .icon {
+    grid-column: 1;
+    justify-self: end;
+    margin-top: 0;
+}
+
+.container_centered .main {
+    grid-column: 2;
+    align-items: center;
+    justify-content: center;
+}
+
+.container_centered .message {
+    text-align: center;
+}
+
+.container_centered .close {
+    position: absolute;
+    top: 50%;
+    right: var(--doc-banner-padding-right);
+    margin-left: 0;
+    transform: translateY(-50%);
+}
+
 @media (max-width: 1279px) {
     :host {
         --doc-banner-padding-left: var(--dx-g-spacing-xl);

package/src/modules/doc/banner/banner.html

@@ -1,16 +1,17 @@
 <template>
     <template lwc:if={showBanner}>
-        <div class="container" part="container">
+        <div class={containerClass} part="container">
             <dx-icon
                 class="icon"
-                symbol="info"
-                size="override"
-                color="gray-50"
+                sprite={iconSprite}
+                symbol={iconSymbol}
+                size={iconSize}
+                color={iconColor}
                 part="icon"
             ></dx-icon>
             <div class="main">
                 <div class="message" part="message" lwc:dom="manual"></div>
-                <div class="actions" part="actions">
+                <div lwc:if={hasActions} class="actions" part="actions">
                     <template lwc:if={hasPrimaryButton}>
                         <dx-button
                             href={buttonHref}

package/src/modules/doc/banner/banner.ts

@@ -1,4 +1,6 @@
 import { LightningElement, api } from "lwc";
+import { IconSize, IconSprite, IconSymbol } from "typings/custom";
+import { normalizeBoolean } from "dxUtils/normalizers";
 
 const BANNER_STORAGE_PREFIX = "doc-banner-";
 
@@ -13,6 +15,24 @@ export default class Banner extends LightningElement {
 
     @api dismissStorageKey = "";
 
+    @api
+    get centered(): boolean {
+        return this._centered;
+    }
+    set centered(value: boolean | string) {
+        this._centered = normalizeBoolean(value);
+    }
+
+    @api iconSprite: IconSprite = "utility";
+
+    @api iconSymbol: IconSymbol = "info";
+
+    @api iconColor = "gray-50";
+
+    @api iconSize: IconSize = "large";
+
+    private _centered = false;
+
     private _dismissed = false;
 
     connectedCallback() {
@@ -33,10 +53,18 @@ export default class Banner extends LightningElement {
         }
     }
 
+    get containerClass(): string {
+        return this._centered ? "container container_centered" : "container";
+    }
+
     get showBanner(): boolean {
         return !this._dismissed;
     }
 
+    get hasActions(): boolean {
+        return this.hasPrimaryButton || this.hasSecondaryAction;
+    }
+
     get hasPrimaryButton(): boolean {
         return !!(this.buttonLabel && this.buttonHref);
     }

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

@@ -496,8 +496,18 @@ export default class ContentLayout extends LightningElement {
         }
 
         if (!this.didScrollToSelectedHash) {
+            this.tryScrollToHash(headingElements);
+        }
+    }
+
+    /**
+     * Attempts the one-shot hash scroll and marks it complete only if scrolling succeeds,
+     * keeping both trigger points consistent.
+     */
+    // eslint-disable-next-line no-undef
+    protected tryScrollToHash(headingElements: NodeListOf<Element>): void {
+        if (this.scrollToHash(headingElements)) {
             this.didScrollToSelectedHash = true;
-            this.scrollToHash(headingElements);
         }
     }
 
@@ -585,6 +595,10 @@ export default class ContentLayout extends LightningElement {
         this.updateRNB();
         this.updateContentActionToolbar();
         this.contentLoaded = true;
+
+        if (this.enableSlotChange && !this.didScrollToSelectedHash) {
+            this.tryScrollToHash(this.getHeadingElements());
+        }
     }
 
     protected disconnectObserver(): void {
@@ -595,7 +609,7 @@ export default class ContentLayout extends LightningElement {
     }
 
     // eslint-disable-next-line no-undef
-    protected scrollToHash(headingElements: NodeListOf<Element>): void {
+    protected scrollToHash(headingElements: NodeListOf<Element>): boolean {
         let { hash } = window.location;
         if (hash) {
             hash = hash.substr(1);
@@ -610,14 +624,18 @@ export default class ContentLayout extends LightningElement {
                 "hgf-c360contextnav"
             ) as HTMLElement;
 
+            if (!docHeaderEl || !globalNavEl || !contextNavEl) {
+                return false;
+            }
+
             const headerHeight =
-                docHeaderEl?.offsetHeight +
-                globalNavEl?.offsetHeight +
-                contextNavEl?.offsetHeight;
+                (docHeaderEl.offsetHeight || 0) +
+                (globalNavEl.offsetHeight || 0) +
+                (contextNavEl.offsetHeight || 0);
 
             const docPhaseEl = (
                 this.template.querySelector("[name=doc-phase]")! as any
-            ).assignedElements()[0] as HTMLSlotElement;
+            )?.assignedElements?.()[0] as HTMLSlotElement | undefined;
 
             const offset = docPhaseEl
                 ? headerHeight + docPhaseEl.offsetHeight
@@ -626,10 +644,11 @@ export default class ContentLayout extends LightningElement {
             for (const headingElement of headingElements as any) {
                 if (headingElement.getAttribute("id") === hash) {
                     this.scrollIntoViewWithOffset(headingElement, offset);
-                    break;
+                    return true;
                 }
             }
         }
+        return false;
     }
 
     protected scrollIntoViewWithOffset(

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.