@salesforcedevs/docs-components 1.27.24 → 1.28.1-mti

package/.npmrc

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${SFDOCS_NPM_AUTH_TOKEN}

package/lwc.config.json

@@ -18,6 +18,7 @@
         "doc/header",
         "doc/heading",
         "doc/headingAnchor",
+        "doc/mtIndicator",
         "doc/overview",
         "doc/phase",
         "doc/redocReference",

package/package.json

@@ -1,29 +1,30 @@
 {
-    "name": "@salesforcedevs/docs-components",
-    "version": "1.27.24",
-    "description": "Docs Lightning web components for DSC",
-    "license": "MIT",
-    "main": "index.js",
-    "engines": {
-        "node": "20.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": "48921f68f82d211591241267ed65276fcbb077ed"
-}
+  "name": "@salesforcedevs/docs-components",
+  "version": "1.28.1-mti",
+  "description": "Docs Lightning web components for DSC",
+  "license": "MIT",
+  "main": "index.js",
+  "engines": {
+    "node": "20.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.28.0"
+}

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

@@ -57,7 +57,7 @@
                 </div>
             </div>
             <div lwc:if={showFooter} class="footer-container">
-                <dx-footer variant="no-signup"></dx-footer>
+                <dx-footer variant="no-signup" mfe-config-origin={effectiveFooterOrigin}></dx-footer>
             </div>
         </div>
     </div>

package/src/modules/doc/lwcContentLayout/lwcContentLayout.ts

@@ -1,3 +1,4 @@
+import { api } from "lwc";
 import ContentLayout from "doc/contentLayout";
 import cx from "classnames";
 
@@ -15,6 +16,16 @@ export default class LwcContentLayout extends ContentLayout {
     private allTabsCache: any[] | null = null;
     private mainSlotCache: any = null;
 
+    /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). Passed through to dx-footer. */
+    @api origin: string | null = null;
+
+    /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
+    get effectiveFooterOrigin(): string {
+        return (
+            this.origin ?? `${window.location.origin}/developer/en-us/wp-json`
+        );
+    }
+
     private setRNBByTab() {
         const tabPanelListItem = this.getTabPanelList();
         this.rnbByTab = tabPanelListItem?.id === RNB_BY_TAB;

package/src/modules/doc/mtIndicator/mtIndicator.css

@@ -0,0 +1,167 @@
+@import "dxHelpers/reset";
+@import "dxHelpers/text";
+
+:host {
+    display: block;
+    --doc-mt-indicator-bg: var(--neutral-90, #e5e5e5);
+    --doc-mt-indicator-height: 44px;
+    --doc-mt-indicator-padding-x-left: 40px;
+    --doc-mt-indicator-padding-x-right: var(--dx-g-spacing-lg);
+    --doc-mt-indicator-icon-size: 18.4615px;
+    --doc-mt-indicator-close-color: #747474;
+    --doc-mt-indicator-primary-bg: #0176d3;
+    --doc-mt-indicator-primary-bg-hover: #0160b3;
+}
+
+.doc-mt-indicator {
+    display: flex;
+    align-items: flex-start;
+    justify-content: space-between;
+    width: 100%;
+    margin: 0;
+    min-height: var(--doc-mt-indicator-height);
+    padding: 0 var(--doc-mt-indicator-padding-x-right) 0
+        var(--doc-mt-indicator-padding-x-left);
+    background: var(--doc-mt-indicator-bg);
+    box-sizing: border-box;
+}
+
+.doc-mt-indicator .icon-wrap,
+.doc-mt-indicator .main,
+.doc-mt-indicator .content,
+.doc-mt-indicator .actions,
+.doc-mt-indicator .close-wrap {
+    display: flex;
+    align-items: center;
+}
+
+.doc-mt-indicator .icon-wrap,
+.doc-mt-indicator .close-wrap {
+    flex-shrink: 0;
+    width: calc(var(--doc-mt-indicator-icon-size) + var(--dx-g-spacing-sm));
+    min-height: 32px;
+    align-self: flex-start;
+    justify-content: flex-start;
+}
+
+.doc-mt-indicator .icon-wrap dx-icon {
+    --dx-c-icon-size: var(--doc-mt-indicator-icon-size);
+    width: var(--doc-mt-indicator-icon-size);
+    height: var(--doc-mt-indicator-icon-size);
+    padding: 12px 8px 0 0;
+    box-sizing: content-box;
+}
+
+.doc-mt-indicator .main {
+    flex: 1 1 0;
+    min-width: 0;
+    align-self: flex-start;
+    padding: 6px 0;
+    gap: var(--dx-g-spacing-md);
+}
+
+.doc-mt-indicator .content {
+    flex: 0 1 auto;
+    min-width: 0;
+    max-width: 100%;
+    min-height: 32px;
+    align-items: flex-start;
+}
+
+.doc-mt-indicator .message {
+    margin: 0;
+    padding: 6px 0;
+    font-size: 14px;
+    font-weight: 400;
+    line-height: 20px;
+    color: var(--dx-g-neutral-30, #444);
+}
+
+.doc-mt-indicator .message a {
+    color: var(--dx-g-cloud-blue-vibrant-50);
+    text-decoration: underline;
+}
+
+.doc-mt-indicator .message a:hover {
+    opacity: 0.9;
+}
+
+.doc-mt-indicator .actions {
+    flex-shrink: 0;
+    min-height: 32px;
+    gap: var(--dx-g-spacing-smd);
+}
+
+.doc-mt-indicator .primary-btn {
+    --dx-c-button-primary-color: var(--doc-mt-indicator-primary-bg);
+    --dx-c-button-primary-color-hover: var(--doc-mt-indicator-primary-bg-hover);
+    --dx-c-button-vertical-spacing: 0;
+    --dx-c-button-horizontal-spacing: var(--dx-g-spacing-md);
+    min-width: min(144px, 100%);
+    height: 32px;
+    border-radius: var(--dx-g-spacing-xs);
+}
+
+.doc-mt-indicator .primary-btn::part(container) {
+    min-width: min(144px, 100%);
+    width: 100%;
+    height: 32px;
+    padding: 0 var(--dx-g-spacing-md);
+    border-radius: var(--dx-g-spacing-xs);
+}
+
+.doc-mt-indicator .close-wrap {
+    align-self: flex-start;
+    justify-content: center;
+    align-items: center;
+    width: 52px;
+    height: 44px;
+    padding: 12px 8px 18px;
+    margin-left: auto;
+    box-sizing: border-box;
+}
+
+.doc-mt-indicator .close-wrap .close-btn {
+    width: 100%;
+    height: 100%;
+    --dx-c-button-custom-color: var(--doc-mt-indicator-close-color);
+    --dx-c-button-custom-color-hover: var(--doc-mt-indicator-close-color);
+    --dx-c-button-custom-background: transparent;
+    --dx-c-button-custom-background-hover: rgb(0 0 0 / 5%);
+    --dx-c-button-custom-border: none;
+    --dx-c-button-custom-border-hover: none;
+}
+
+@media (max-width: 1279px) {
+    :host {
+        --doc-mt-indicator-padding-x-left: 32px;
+        --doc-mt-indicator-padding-x-right: var(--dx-g-spacing-md);
+    }
+    .doc-mt-indicator {
+        min-height: 78px;
+        flex-wrap: wrap;
+        align-content: space-between;
+        padding: 0 var(--doc-mt-indicator-padding-x-right) 0 0;
+    }
+    .doc-mt-indicator .main {
+        flex-wrap: wrap;
+        gap: var(--dx-g-spacing-2xs);
+    }
+    .doc-mt-indicator .actions {
+        flex: 0 0 100%;
+        width: 100%;
+    }
+    .doc-mt-indicator .close-wrap {
+        min-height: 44px;
+    }
+}
+
+@media (max-width: 768px) {
+    :host {
+        --doc-mt-indicator-padding-x-left: 24px;
+        --doc-mt-indicator-padding-x-right: var(--dx-g-spacing-sm);
+    }
+    .doc-mt-indicator {
+        min-height: 44px;
+    }
+}

package/src/modules/doc/mtIndicator/mtIndicator.html

@@ -0,0 +1,48 @@
+<template>
+    <template lwc:if={showBanner}>
+        <div class="doc-mt-indicator" part="container">
+            <div class="icon-wrap" part="icon-wrap">
+                <dx-icon symbol="info" part="icon" color="#747474"></dx-icon>
+            </div>
+            <div class="main" part="main">
+                <div class="content" part="content">
+                    <p class="message dx-text-body-4" part="message">
+                        This text was translated using Salesforce's machine translation system. More details can be found
+                        <a
+                            href="https://help.salesforce.com/s/articleView?id=sf.machine_translation.htm"
+                            target="_blank"
+                            rel="noopener noreferrer"
+                            part="message-link"
+                        >
+                            here
+                        </a>
+                    </p>
+                </div>
+                <div class="actions" part="actions">
+                    <template lwc:if={showButton}>
+                        <dx-button
+                            class="primary-btn"
+                            href={enUsHref}
+                            variant="primary"
+                            size="small"
+                            part="button"
+                        >
+                            Switch to English
+                        </dx-button>
+                    </template>
+                </div>
+            </div>
+            <div class="close-wrap" part="close-wrap">
+                <dx-button
+                    class="close-btn"
+                    variant="icon-only"
+                    icon-symbol="close"
+                    icon-color="#747474"
+                    aria-label="Close"
+                    onclick={handleCloseClick}
+                    part="close"
+                ></dx-button>
+            </div>
+        </div>
+    </template>
+</template>

package/src/modules/doc/mtIndicator/mtIndicator.ts

@@ -0,0 +1,19 @@
+import { LightningElement, api } from "lwc";
+
+export default class MtIndicator extends LightningElement {
+    @api enUsHref = "";
+
+    private _dismissed = false;
+
+    get showBanner(): boolean {
+        return !this._dismissed;
+    }
+
+    get showButton(): boolean {
+        return !!this.enUsHref;
+    }
+
+    handleCloseClick() {
+        this._dismissed = true;
+    }
+}

package/src/modules/doc/redocReference/redocReference.ts

@@ -68,6 +68,16 @@ export default class RedocReference extends LightningElement {
         this._parentDocPhaseInfo = value;
     }
 
+    /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). Passed through to dx-footer. */
+    @api origin: string | null = null;
+
+    /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
+    get effectiveFooterOrigin(): string {
+        return (
+            this.origin ?? `${window.location.origin}/developer/en-us/wp-json`
+        );
+    }
+
     connectedCallback(): void {
         window.addEventListener("scroll", this.handleScrollAndResize);
         window.addEventListener("resize", this.handleScrollAndResize);
@@ -338,7 +348,7 @@ export default class RedocReference extends LightningElement {
     // Appends footer component to container
     private insertFooter(container: HTMLElement): void {
         const footerElement = createElement("dx-footer", { is: DxFooter });
-        Object.assign(footerElement, { variant: "no-signup" });
+        Object.assign(footerElement, { variant: "no-signup", mfeConfigOrigin: this.effectiveFooterOrigin });
         container.appendChild(footerElement);
     }
 

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.