@salesforcedevs/dx-components 1.3.352 → 1.3.353-tabbed-codeblock1

package/lwc.config.json

@@ -91,6 +91,7 @@
         "dx/stepSequenceStep",
         "dx/tabPanel",
         "dx/tabPanelList",
+        "dx/tabbedCodeBlock",
         "dx/tbidAvatarButton",
         "dx/toast",
         "dx/toc",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "1.3.352",
+    "version": "1.3.353-tabbed-codeblock1",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {
@@ -45,6 +45,5 @@
     },
     "volta": {
         "node": "18.18.0"
-    },
-    "gitHead": "336de44c52a7dca8b05119cfb36a94273b222f80"
+    }
 }

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

@@ -9,6 +9,7 @@
 
 pre {
     margin: 0 !important;
+    height: var(--dx-code-block-height, unset);
 }
 
 .copyta {
@@ -19,7 +20,7 @@ pre {
 }
 
 .toolbar {
-    border-radius: 0.3em 0.3em 0 0;
+    border-radius: var(--dx-code-block-toolbar-border-radius, 0.3em 0.3em 0 0);
     opacity: 1;
     display: flex;
     align-items: center;

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

@@ -39,14 +39,14 @@ prism.languages.sql_docs_template = sqlDocsTemplate;
 // Used for remove enclosing <pre> tag's (if occurs)
 const preTagRegexp: RegExp = /^<pre.*?>(.*)<\/pre>$/is;
 
-const LIGHT = "light";
-const DARK = "dark";
+export const LIGHT = "light";
+export const DARK = "dark";
 const themes: CodeBlockTheme[] = [LIGHT, DARK];
 const LOCAL_STORAGE_KEY = "dx-codeblock-theme";
 
 export default class CodeBlock extends LightningElement {
     @api defaultTheme: CodeBlockTheme = LIGHT;
-    @api header: string = "title";
+    @api header: string = "";
     @api sourceLink: string = "";
     @api language: string = "";
     // if it is true, it renders code as is coming instead of wrapping it into html/xml comments tags.

package/src/modules/dx/tabPanelItem/tabPanelItem.css

@@ -6,7 +6,7 @@
     font-size: var(--dx-g-text-base);
     font-weight: var(--dx-g-font-normal);
     line-height: var(--dx-g-spacing-lg);
-    padding: var(--dx-g-spacing-smd) var(--dx-g-spacing-lg);
+    padding: var(--dx-g-spacing-sm) var(--dx-g-spacing-lg);
     border-top-left-radius: var(--dx-g-spacing-sm);
     border-top-right-radius: var(--dx-g-spacing-sm);
     border-bottom: var(--dx-g-spacing-xs) solid transparent;

package/src/modules/dx/tabbedCodeBlock/tabbedCodeBlock.css

@@ -0,0 +1,8 @@
+dx-code-block {
+    --dx-code-block-height: 320px;
+    --dx-code-block-toolbar-border-radius: 0;
+}
+
+dx-tab-panel-list {
+    --dx-c-tab-panel-list-horizontal-padding: 0;
+}

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

@@ -0,0 +1,16 @@
+<template>
+    <dx-tab-panel-list tabs={tabs}>
+        <template for:each={_codeBlocks} for:item="codeBlockItem">
+            <dx-tab-panel key={codeBlockItem.header}>
+                <!-- The header attribute is not passed intentionally because the tab title uses the header value. -->
+                <dx-code-block
+                    default-theme={defaultTheme}
+                    code-block={codeBlockItem.codeBlock}
+                    language={codeBlockItem.language}
+                    source-link={codeBlockItem.sourceLink}
+                    is-encoded={codeBlockItem.isEncoded}
+                ></dx-code-block>
+            </dx-tab-panel>
+        </template>
+    </dx-tab-panel-list>
+</template>

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

@@ -0,0 +1,44 @@
+import { LightningElement, api } from "lwc";
+import { CodeBlockItem } from "typings/custom";
+import { safeDecodeURI, toJson } from "dxUtils/normalizers";
+import { DARK } from "dx/codeBlock";
+
+export default class TabbedCodeBlock extends LightningElement {
+    _codeBlocks: CodeBlockItem[] = [];
+
+    // 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;
+
+    get tabs(): string {
+        // Use the code block headers to create a tabs array as a JSON string
+        return JSON.stringify(
+            this._codeBlocks.map((codeBlock) => ({ label: codeBlock.header }))
+        );
+    }
+
+    // We need to pass the attribute as decodedURI(JSON.stringify(codeBlocksArray)) to avoid issues with single and double quotes in the code block content.
+    @api
+    set codeBlocks(value: string) {
+        if (value) {
+            // Decode the encoded code block JSON string
+            const decodeCodeBlockJson = safeDecodeURI(value);
+            try {
+                const codeBlockItems = toJson(decodeCodeBlockJson);
+                this._codeBlocks = codeBlockItems.map(
+                    (codeBlock: CodeBlockItem) => {
+                        return {
+                            ...codeBlock,
+                            defaultTheme: this.defaultTheme
+                        };
+                    }
+                );
+            } catch (exception) {
+                console.log("Invalid codeblock items json", exception);
+            }
+        }
+    }
+
+    get codeBlocks(): CodeBlockItem[] {
+        return this._codeBlocks;
+    }
+}

package/src/modules/dxUtils/normalizers/normalizers.ts

@@ -76,3 +76,15 @@ export const normalizeBoolean = (
 export const normalizeDomId = (id: string): string => {
     return id.replace(/^[^a-z]+|[^\w.-]+/gi, "");
 };
+
+export const safeDecodeURI = (value: string): string => {
+    try {
+        // Check if the value contains URI encoding patterns
+        return typeof value === "string" && value.includes("%")
+            ? decodeURIComponent(value)
+            : value;
+    } catch (error) {
+        // In case of any errors, return the original value
+        return value;
+    }
+};

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.