@salesforcedevs/dx-components 1.20.13 → 1.20.14-cb-loading-1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "1.20.13",
+    "version": "1.20.14-cb-loading-1",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {
@@ -46,6 +46,5 @@
     "volta": {
         "node": "20.19.0",
         "yarn": "1.22.19"
-    },
-    "gitHead": "533981cf67f89f660ad584fa977baf14825f51a6"
+    }
 }

package/src/modules/dx/codeBlock/codeBlock.css

@@ -130,3 +130,57 @@ pre[class*="shiki"] {
 dx-button {
     --dx-g-button-icon-color: var(--dx-g-cloud-blue-vibrant-50);
 }
+
+.code-loading-skeleton {
+    padding: 14px 21px;
+    background-color: #fff;
+    border-radius: 0 0 0.3em 0.3em;
+    overflow: hidden;
+    height: var(--dx-code-block-height, auto);
+}
+
+.dx-theme-dark .code-loading-skeleton {
+    background-color: #000;
+}
+
+.skeleton-line {
+    height: 16px;
+    background: linear-gradient(
+        90deg,
+        var(--dx-g-gray-80) 25%,
+        var(--dx-g-gray-70) 50%,
+        var(--dx-g-gray-80) 75%
+    );
+    background-size: 200% 100%;
+    animation: skeleton-loading 1.5s infinite;
+    border-radius: 4px;
+    margin-bottom: 8px;
+}
+
+.dx-theme-dark .skeleton-line {
+    background: linear-gradient(
+        90deg,
+        var(--dx-g-blue-natural-30) 25%,
+        var(--dx-g-blue-natural-40) 50%,
+        var(--dx-g-blue-natural-30) 75%
+    );
+    background-size: 200% 100%;
+}
+
+.skeleton-line.short {
+    width: 60%;
+}
+
+.skeleton-line.medium {
+    width: 80%;
+}
+
+@keyframes skeleton-loading {
+    0% {
+        background-position: 200% 0;
+    }
+
+    100% {
+        background-position: -200% 0;
+    }
+}

package/src/modules/dx/codeBlock/codeBlock.ts

@@ -3,6 +3,7 @@ import { CodeBlockTheme, CodeBlockLanguage } from "typings/custom";
 import cx from "classnames";
 import { track as gtmTrack } from "dxUtils/analytics";
 import { highlightCode } from "dxUtils/shiki";
+import { normalizeBoolean } from "dxUtils/normalizers";
 
 /*
     Custom language support is handled by the Shiki wrapper module
@@ -30,7 +31,17 @@ export default class CodeBlock extends LightningElement {
     // if it is true, it renders code as is coming instead of wrapping it into html/xml comments tags.
     @api isEncoded = false;
 
+    @api
+    get showLoadingIndicator() {
+        return this._showLoadingIndicator;
+    }
+
+    set showLoadingIndicator(value) {
+        this._showLoadingIndicator = normalizeBoolean(value);
+    }
+
     private _codeBlockRendered: boolean = false;
+    private _showLoadingIndicator: boolean = false;
     private markupLangs = ["visualforce", "html", "xml"];
     private componentLoaded: boolean = false;
     private showLanguageDropdown: boolean = false;
@@ -102,6 +113,60 @@ export default class CodeBlock extends LightningElement {
         return cx(`dx-theme-${this.theme}`);
     }
 
+    private calculateSkeletonLines(): number {
+        const computedStyle = window.getComputedStyle(this.template.host);
+        const customHeight = computedStyle.getPropertyValue(
+            "--dx-code-block-height"
+        );
+
+        if (
+            customHeight &&
+            customHeight !== "unset" &&
+            !customHeight.includes("auto")
+        ) {
+            const heightValue = parseFloat(customHeight);
+            const lineHeight = 20;
+            const verticalPadding = 28;
+            const availableHeight = heightValue - verticalPadding;
+            return Math.max(1, Math.floor(availableHeight / lineHeight));
+        }
+
+        return 4; // Default lines
+    }
+
+    private generateSkeletonHTML(lines: number): string {
+        const skeletonLines = Array.from({ length: lines }, (_, i) => {
+            const widthClass =
+                i % 3 === 0 ? "short" : i % 3 === 1 ? "medium" : "";
+            return `<div class="skeleton-line ${widthClass}"></div>`;
+        }).join("");
+
+        return `
+            <div class="code-loading-skeleton">
+                ${skeletonLines}
+            </div>
+        `;
+    }
+
+    private showLoadingSkeleton(): void {
+        if (!this.showLoadingIndicator) {
+            return;
+        }
+
+        const codeBlockContent = this.template.querySelector(
+            ".code-block-content"
+        );
+        if (!codeBlockContent) {
+            return;
+        }
+
+        // Calculate lines and generate skeleton
+        const lines = this.calculateSkeletonLines();
+        const skeletonHTML = this.generateSkeletonHTML(lines);
+
+        codeBlockContent.innerHTML = skeletonHTML;
+    }
+
     private initializeTheme() {
         window.addEventListener(EVENT_NAME, this.toggleTheme);
         const darkModeSetting = localStorage.getItem(
@@ -119,6 +184,9 @@ export default class CodeBlock extends LightningElement {
     }
 
     async formatCodeBlock() {
+        // Show loading skeleton immediately
+        this.showLoadingSkeleton();
+
         const divEl = this.template.querySelector("div.code-block-content");
         const templateEl = document.createElement("template");
 

package/src/modules/dx/tabbedCodeBlock/tabbedCodeBlock.html

@@ -9,6 +9,7 @@
                     language={codeBlockItem.language}
                     source-link={codeBlockItem.sourceLink}
                     is-encoded={codeBlockItem.isEncoded}
+                    show-loading-indicator={showLoadingIndicator}
                 ></dx-code-block>
             </dx-tab-panel>
         </template>

package/src/modules/dx/tabbedCodeBlock/tabbedCodeBlock.ts

@@ -1,14 +1,24 @@
 import { LightningElement, api } from "lwc";
 import { CodeBlockItem } from "typings/custom";
-import { safeDecodeURI, toJson } from "dxUtils/normalizers";
+import { safeDecodeURI, toJson, normalizeBoolean } from "dxUtils/normalizers";
 import { DARK } from "dx/codeBlock";
 
 export default class TabbedCodeBlock extends LightningElement {
     _codeBlocks: CodeBlockItem[] = [];
+    private _showLoadingIndicator: boolean = false;
 
     // By default, we want a dark theme for the tabbed code block; however, if the user changes the theme of any code block, it updates the same across the entire website.
     @api defaultTheme = DARK;
 
+    @api
+    get showLoadingIndicator() {
+        return this._showLoadingIndicator;
+    }
+
+    set showLoadingIndicator(value) {
+        this._showLoadingIndicator = normalizeBoolean(value);
+    }
+
     get tabs(): string {
         // Use the code block headers to create a tabs array as a JSON string
         return JSON.stringify(

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.