@salesforcedevs/docs-components 1.28.1-banner-0 → 1.28.1-banner-2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.28.1-banner-0",
+    "version": "1.28.1-banner-2",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -25,5 +25,5 @@
         "@types/lodash.orderby": "4.6.9",
         "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "602f3fab502240f4098c97535ee601f1f7a522e5"
+    "gitHead": "4f8c415f6a58d0747a9e746a4b1717d85de32122"
 }

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

@@ -6,9 +6,6 @@
 
     --doc-banner-padding-left: var(--dx-g-spacing-2xl);
     --doc-banner-padding-right: var(--dx-g-spacing-lg);
-    --doc-close-width: calc(var(--dx-g-spacing-3xl) + var(--dx-g-spacing-xs));
-    --doc-close-height: calc(var(--dx-g-spacing-2xl) + var(--dx-g-spacing-xs));
-    --doc-banner-spacing-16px: var(--dx-g-spacing-md);
 }
 
 .container {
@@ -16,14 +13,13 @@
     align-items: flex-start;
     background: var(--dx-g-gray-90);
     padding: 0 var(--doc-banner-padding-right) 0 var(--doc-banner-padding-left);
+    height: calc(var(--dx-g-spacing-2xl) + var(--dx-g-spacing-xs));
 }
 
 .icon {
     --dx-c-icon-size: var(--dx-g-icon-size-lg);
 
     flex-shrink: 0;
-    width: var(--dx-g-icon-size-lg);
-    height: var(--dx-g-icon-size-lg);
     margin-top: var(--dx-g-spacing-smd);
     margin-right: var(--dx-g-spacing-sm);
 }
@@ -34,7 +30,7 @@
     display: flex;
     flex-wrap: wrap;
     align-items: flex-start;
-    column-gap: var(--doc-banner-spacing-16px);
+    column-gap: var(--dx-g-spacing-md);
     padding: calc((var(--dx-g-spacing-xs) + var(--dx-g-spacing-sm)) / 2) 0;
 }
 
@@ -69,12 +65,13 @@
 
     flex-shrink: 0;
     align-self: flex-start;
-    width: var(--doc-close-width);
-    height: var(--doc-close-height);
+    width: calc(var(--dx-g-spacing-3xl) + var(--dx-g-spacing-xs));
+    height: calc(var(--dx-g-spacing-2xl) + var(--dx-g-spacing-xs));
     margin-left: auto;
     display: flex;
     align-items: center;
     justify-content: center;
+    cursor: pointer;
 }
 
 @media (max-width: 1279px) {

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

@@ -1,4 +1,4 @@
-import { LightningElement, api, track } from "lwc";
+import { LightningElement, api } from "lwc";
 
 const BANNER_STORAGE_PREFIX = "doc-banner-";
 
@@ -13,14 +13,10 @@ export default class Banner extends LightningElement {
 
     @api dismissStorageKey = "";
 
-    @track private _dismissed = false;
+    private _dismissed = false;
 
     connectedCallback() {
-        if (
-            this.dismissStorageKey &&
-            typeof window !== "undefined" &&
-            window.sessionStorage
-        ) {
+        if (this.dismissStorageKey && window?.sessionStorage) {
             this._dismissed =
                 window.sessionStorage.getItem(
                     `${BANNER_STORAGE_PREFIX}${this.dismissStorageKey}`
@@ -50,11 +46,7 @@ export default class Banner extends LightningElement {
     }
 
     private dismissBanner() {
-        if (
-            this.dismissStorageKey &&
-            typeof window !== "undefined" &&
-            window.sessionStorage
-        ) {
+        if (this.dismissStorageKey && window?.sessionStorage) {
             window.sessionStorage.setItem(
                 `${BANNER_STORAGE_PREFIX}${this.dismissStorageKey}`,
                 "true"

package/src/modules/doc/localeBanner/localeBanner.ts

@@ -8,39 +8,177 @@ interface LocaleStrings {
     secondaryLabel: string;
 }
 
+const DEFAULT_LOCALE = "en-us";
+
 const LOCALE_STRINGS: Record<string, LocaleStrings> = {
     "en-us": {
         messageText:
-            "This text was translated using Salesforce's machine translation system. More details can be found ",
+            "This text has been translated using Salesforce machine translation system. More details {link}.",
         linkUrl:
-            "https://help.salesforce.com/s/articleView?language=en&id=000396076&type=1",
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1",
         linkText: "here",
         buttonLabel: "Switch to English",
         secondaryLabel: "Not Now"
     },
     "ja-jp": {
         messageText:
-            "このテキストは Salesforce の機械翻訳システムを使用して翻訳されました。詳細は ",
+            "この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細は{link}をご参照ください。",
         linkUrl:
-            "https://help.salesforce.com/s/articleView?language=ja&id=000396076&type=1",
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=ja",
         linkText: "こちら",
         buttonLabel: "英語に切り替える",
-        secondaryLabel: "後で"
+        secondaryLabel: "今はしません"
+    },
+    "zh-cn": {
+        messageText:
+            "此文本已使用 Salesforce 机器翻译系统进行翻译。如需了解更多详情，请点击{link}。",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=zh_CN",
+        linkText: "此处",
+        buttonLabel: "切换为英语",
+        secondaryLabel: "而非现在"
+    },
+    "zh-tw": {
+        messageText:
+            "此文已使用 Salesforce 機器翻譯系統翻譯。更多詳細資料請參見{link}。",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=zh_TW",
+        linkText: "此處",
+        buttonLabel: "切換至英文",
+        secondaryLabel: "不要現在"
+    },
+    "fr-fr": {
+        messageText:
+            "Ce texte a été traduit à l’aide du système de traduction automatique de Salesforce. Plus de détails, consultez {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=fr",
+        linkText: "cette page",
+        buttonLabel: "Basculer vers la page en anglais",
+        secondaryLabel: "Pas maintenant"
+    },
+    "de-de": {
+        messageText:
+            "Dieser Text wurde mit dem maschinellen Übersetzungssystem von Salesforce übersetzt. Weitere Details finden Sie {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=de",
+        linkText: "hier",
+        buttonLabel: "Zu Englisch wechseln",
+        secondaryLabel: "Nicht jetzt"
+    },
+    "it-it": {
+        messageText:
+            "Questo testo è stato tradotto utilizzando il sistema di traduzione automatica di Salesforce. Ulteriori dettagli sono disponibili {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=it",
+        linkText: "qui",
+        buttonLabel: "Passa all'inglese",
+        secondaryLabel: "Non ora"
+    },
+    "ko-kr": {
+        messageText:
+            "본 텍스트는 Salesforce 기계 번역 시스템으로 번역되었습니다. 자세한 내용은 {link}를 참조하세요.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=ko",
+        linkText: "여기",
+        buttonLabel: "영어로 전환",
+        secondaryLabel: "지금 안 함"
+    },
+    "pt-br": {
+        messageText:
+            "Este texto foi traduzido pelo sistema de tradução automática da Salesforce. Mais detalhes {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=pt_BR",
+        linkText: "aqui",
+        buttonLabel: "Alternar para inglês",
+        secondaryLabel: "Agora não"
+    },
+    "es-mx": {
+        messageText:
+            "Este texto se tradujo con el sistema de traducción automática de Salesforce. Obtenga más detalles {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=es_MX",
+        linkText: "aquí",
+        buttonLabel: "Cambiar a inglés",
+        secondaryLabel: "Ahora no"
+    },
+    "es-es": {
+        messageText:
+            "Este texto se ha traducido utilizando un sistema de traducción automática de Salesforce. Más información {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=es",
+        linkText: "aquí",
+        buttonLabel: "Cambiar a inglés",
+        secondaryLabel: "Ahora no"
+    },
+    "ru-ru": {
+        messageText:
+            "Данный текст был переведен при помощи системы машинного перевода Salesforce. Дополнительные сведения см. {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=ru",
+        linkText: "здесь",
+        buttonLabel: "Переключить на английский",
+        secondaryLabel: "Не сейчас"
+    },
+    "fi-fi": {
+        messageText:
+            "Tämä teksti on käännetty Salesforcen konekäännösjärjestelmän avulla. Katso lisätietoja {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=fi",
+        linkText: "täältä",
+        buttonLabel: "Vaihda englantiin",
+        secondaryLabel: "Ei nyt"
+    },
+    "da-dk": {
+        messageText:
+            "Denne tekst er oversat ved hjælp af Salesforce-maskinoversættelsessystem. Du finder flere detaljer {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=da",
+        linkText: "her",
+        buttonLabel: "Skift til engelsk",
+        secondaryLabel: "Ikke nu"
+    },
+    "sv-se": {
+        messageText:
+            "Den här texten har översatts med Salesforces maskinöversättningssystem. Mer information {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=sv",
+        linkText: "här",
+        buttonLabel: "Byt till engelska",
+        secondaryLabel: "Inte nu"
+    },
+    "nl-nl": {
+        messageText:
+            "Deze tekst werd vertaald aan de hand van het systeem voor automatische vertaling van Salesforce. U vindt {link} meer details.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=nl_NL",
+        linkText: "hier",
+        buttonLabel: "Overschakelen op Engels",
+        secondaryLabel: "Niet nu"
+    },
+    "nb-no": {
+        messageText:
+            "Denne teksten er oversatt med Salesforce maskinoversettingssystem. Flere detaljer {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=no",
+        linkText: "her",
+        buttonLabel: "Bytt til engelsk",
+        secondaryLabel: "Ikke nå"
     }
 };
 
 export default class LocaleBanner extends LightningElement {
-    @api locale = "en-us";
+    @api locale = DEFAULT_LOCALE;
     @api targetHref = "";
     @api dismissStorageKey = "";
 
     get localeData(): LocaleStrings {
-        return LOCALE_STRINGS[this.locale] || LOCALE_STRINGS["en-us"];
+        return LOCALE_STRINGS[this.locale] || LOCALE_STRINGS[DEFAULT_LOCALE];
     }
 
     get bannerMessage(): string {
         const data = this.localeData;
-        return `${data.messageText}<a href="${data.linkUrl}">${data.linkText}</a>`;
+        const link = `<a href="${data.linkUrl}">${data.linkText}</a>`;
+        return data.messageText.replace("{link}", link);
     }
 
     get bannerButtonLabel(): string {

package/src/modules/doc/xmlContent/xmlContent.html

@@ -53,7 +53,7 @@
     </doc-content-layout>
     <div lwc:if={display404}>
         <dx-error
-            image="https://a.sfdcstatic.com/developer-website/prod/images/404.svg"
+            image="https://developer.salesforce.com/ns-assets/404.svg"
             code="404"
             header="Beep boop. That did not compute."
             subtitle="The document you're looking for doesn't seem to exist."

package/src/modules/doc/xmlContent/xmlContent.ts

@@ -603,6 +603,7 @@ export default class DocXmlContent extends LightningElementWithState<{
         this.handleLocaleReload();
     }
 
+    /* This method reloads the page as locale banner context is not available in developer-website. */
     private handleLocaleReload(): void {
         const targetLocale = this.language?.id;
         if (!targetLocale) {