@salesforcedevs/docs-components 1.28.2-paymentcard-gc-alpha1 → 1.28.3

package/lwc.config.json

@@ -6,6 +6,8 @@
     ],
     "expose": [
         "doc/amfReference",
+        "doc/banner",
+        "doc/localeBanner",
         "doc/breadcrumbs",
         "doc/componentPlayground",
         "doc/content",
@@ -19,7 +21,6 @@
         "doc/heading",
         "doc/headingAnchor",
         "doc/overview",
-        "doc/paymentCard",
         "doc/phase",
         "doc/redocReference",
         "doc/specificationContent",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/docs-components",
-  "version": "1.28.2-paymentcard-gc-alpha1",
+  "version": "1.28.3",
   "description": "Docs Lightning web components for DSC",
   "license": "MIT",
   "main": "index.js",
@@ -25,6 +25,5 @@
     "@types/lodash.orderby": "4.6.9",
     "@types/lodash.uniqby": "4.7.9"
   },
-  "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad",
-  "stableVersion": "1.28.2"
+  "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -0,0 +1,88 @@
+@import "dxHelpers/reset";
+@import "dxHelpers/text";
+
+:host {
+    display: block;
+
+    --doc-banner-padding-left: var(--dx-g-spacing-2xl);
+    --doc-banner-padding-right: var(--dx-g-spacing-lg);
+}
+
+.container {
+    display: flex;
+    align-items: flex-start;
+    background: var(--dx-g-gray-90);
+    padding: 0 var(--doc-banner-padding-right) 0 var(--doc-banner-padding-left);
+}
+
+.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);
+}
+
+.main {
+    flex: 1;
+    min-width: 0;
+    display: flex;
+    flex-wrap: wrap;
+    align-items: flex-start;
+    column-gap: var(--dx-g-spacing-md);
+    padding: calc((var(--dx-g-spacing-xs) + var(--dx-g-spacing-sm)) / 2) 0;
+}
+
+.message {
+    flex: 0 1 auto;
+    font-size: var(--dx-g-text-sm);
+    color: var(--dx-g-gray-10);
+    padding: calc((var(--dx-g-spacing-xs) + var(--dx-g-spacing-sm)) / 2) 0;
+}
+
+.message a {
+    color: var(--dx-g-cloud-blue-vibrant-50);
+    text-decoration: underline;
+}
+
+.actions {
+    flex: 0 0 auto;
+    display: flex;
+    align-items: center;
+    gap: var(--dx-g-spacing-smd);
+}
+
+.actions dx-button {
+    --dx-c-button-font-size: var(--dx-g-text-sm);
+    --dx-c-button-font-weight: var(--dx-g-font-normal);
+
+    flex: 0 0 auto;
+}
+
+.close {
+    --dx-c-icon-size: var(--dx-g-icon-size-lg);
+
+    flex-shrink: 0;
+    align-self: flex-start;
+    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) {
+    :host {
+        --doc-banner-padding-left: var(--dx-g-spacing-xl);
+        --doc-banner-padding-right: var(--dx-g-spacing-md);
+    }
+}
+
+@media (max-width: 768px) {
+    :host {
+        --doc-banner-padding-left: var(--dx-g-spacing-lg);
+        --doc-banner-padding-right: var(--dx-g-spacing-sm);
+    }
+}

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

@@ -0,0 +1,47 @@
+<template>
+    <template lwc:if={showBanner}>
+        <div class="container" part="container">
+            <dx-icon
+                class="icon"
+                symbol="info"
+                size="override"
+                color="gray-50"
+                part="icon"
+            ></dx-icon>
+            <div class="main">
+                <div class="message" part="message" lwc:dom="manual"></div>
+                <div class="actions" part="actions">
+                    <template lwc:if={hasPrimaryButton}>
+                        <dx-button
+                            href={buttonHref}
+                            variant="primary"
+                            size="small"
+                            part="button"
+                        >
+                            {buttonLabel}
+                        </dx-button>
+                    </template>
+                    <template lwc:if={hasSecondaryAction}>
+                        <dx-button
+                            variant="inline"
+                            onclick={handleSecondaryClick}
+                            part="secondary"
+                        >
+                            {secondaryLabel}
+                        </dx-button>
+                    </template>
+                </div>
+            </div>
+            <dx-button
+                class="close"
+                variant="icon-only"
+                icon-symbol="close"
+                icon-size="override"
+                icon-color="gray-50"
+                aria-label="Close"
+                onclick={handleCloseClick}
+                part="close"
+            ></dx-button>
+        </div>
+    </template>
+</template>

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

@@ -0,0 +1,73 @@
+import { LightningElement, api } from "lwc";
+
+const BANNER_STORAGE_PREFIX = "doc-banner-";
+
+export default class Banner extends LightningElement {
+    @api message = "";
+
+    @api buttonLabel = "";
+
+    @api buttonHref = "";
+
+    @api secondaryLabel = "";
+
+    @api dismissStorageKey = "";
+
+    private _dismissed = false;
+
+    connectedCallback() {
+        if (this.dismissStorageKey && window?.sessionStorage) {
+            this._dismissed =
+                window.sessionStorage.getItem(
+                    `${BANNER_STORAGE_PREFIX}${this.dismissStorageKey}`
+                ) === "true";
+        }
+    }
+
+    renderedCallback() {
+        if (this.message) {
+            const messageElement = this.template.querySelector(".message");
+            if (messageElement) {
+                messageElement.innerHTML = this.message;
+            }
+        }
+    }
+
+    get showBanner(): boolean {
+        return !this._dismissed;
+    }
+
+    get hasPrimaryButton(): boolean {
+        return !!(this.buttonLabel && this.buttonHref);
+    }
+
+    get hasSecondaryAction(): boolean {
+        return !!this.secondaryLabel;
+    }
+
+    private dismissBanner() {
+        if (this.dismissStorageKey && window?.sessionStorage) {
+            window.sessionStorage.setItem(
+                `${BANNER_STORAGE_PREFIX}${this.dismissStorageKey}`,
+                "true"
+            );
+        }
+        this._dismissed = true;
+        this.dispatchEvent(
+            new CustomEvent("dismissbanner", {
+                bubbles: true,
+                composed: true
+            })
+        );
+    }
+
+    @api
+    handleSecondaryClick() {
+        this.dismissBanner();
+    }
+
+    @api
+    handleCloseClick() {
+        this.dismissBanner();
+    }
+}

package/src/modules/doc/localeBanner/localeBanner.css

@@ -0,0 +1,3 @@
+:host {
+    display: block;
+}

package/src/modules/doc/localeBanner/localeBanner.html

@@ -0,0 +1,9 @@
+<template>
+    <doc-banner
+        message={bannerMessage}
+        button-label={bannerButtonLabel}
+        button-href={bannerButtonHref}
+        secondary-label={bannerSecondaryLabel}
+        dismiss-storage-key={dismissStorageKey}
+    ></doc-banner>
+</template>

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

@@ -0,0 +1,195 @@
+import { LightningElement, api } from "lwc";
+
+interface LocaleStrings {
+    messageText: string;
+    linkUrl: string;
+    linkText: string;
+    buttonLabel: string;
+    secondaryLabel: string;
+}
+
+const DEFAULT_LOCALE = "en-us";
+
+const LOCALE_STRINGS: Record<string, LocaleStrings> = {
+    "en-us": {
+        messageText:
+            "This text has been translated using Salesforce machine translation system. More details {link}.",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1",
+        linkText: "here",
+        buttonLabel: "Switch to English",
+        secondaryLabel: "Not Now"
+    },
+    "ja-jp": {
+        messageText:
+            "この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細は{link}をご参照ください。",
+        linkUrl:
+            "https://help.salesforce.com/s/articleView?id=000396076&type=1&language=ja",
+        linkText: "こちら",
+        buttonLabel: "英語に切り替える",
+        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 = DEFAULT_LOCALE;
+    @api targetHref = "";
+    @api dismissStorageKey = "";
+
+    get localeData(): LocaleStrings {
+        return LOCALE_STRINGS[this.locale] || LOCALE_STRINGS[DEFAULT_LOCALE];
+    }
+
+    get bannerMessage(): string {
+        const data = this.localeData;
+        const link = `<a href="${data.linkUrl}">${data.linkText}</a>`;
+        return data.messageText.replace("{link}", link);
+    }
+
+    get bannerButtonLabel(): string {
+        return this.localeData.buttonLabel;
+    }
+
+    get bannerButtonHref(): string {
+        return this.targetHref;
+    }
+
+    get bannerSecondaryLabel(): string {
+        return this.localeData.secondaryLabel;
+    }
+}

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

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

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

@@ -322,8 +322,10 @@ export default class DocXmlContent extends LightningElementWithState<{
         };
     }
 
-    private handlePopState = (event: PopStateEvent): void =>
+    private handlePopState = (event: PopStateEvent): void => {
         this.updatePageReference(this.getReferenceFromUrl(), event);
+        this.handleLocaleReload();
+    };
 
     handleDismissVersionBanner() {
         this.showVersionBanner = false;
@@ -598,6 +600,31 @@ export default class DocXmlContent extends LightningElementWithState<{
             "docs",
             this.pageReferenceToString(this.pageReference)
         );
+        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) {
+            return;
+        }
+
+        const currentPath = window.location.pathname;
+        const localePattern = /atlas\.[a-z]{2}-[a-z]{2}\./;
+
+        if (localePattern.test(currentPath)) {
+            const newPath = currentPath.replace(
+                localePattern,
+                `atlas.${targetLocale}.`
+            );
+            const newUrl =
+                window.location.origin +
+                newPath +
+                window.location.search +
+                window.location.hash;
+            window.location.href = newUrl;
+        }
     }
 
     private updateHighlighting(searchParam: string): void {

package/src/modules/doc/paymentCard/paymentCard.css

@@ -1,118 +0,0 @@
-@import "dxHelpers/reset";
-@import "dxHelpers/text";
-
-:host {
-    display: block;
-    max-width: 520px;
-    margin: 2rem auto;
-    min-height: 400px;
-    border-radius: 8px;
-    padding: 1rem;
-    --x-deg: 0deg;
-    --y-deg: 0deg;
-    --bg-x: 50%;
-    --bg-y: 50%;
-}
-
-.container {
-    perspective: 1000px;
-    display: flex;
-    justify-content: center;
-    align-items: center;
-    padding: 50px;
-    border-radius: 8px;
-}
-
-.card {
-    width: 400px;
-    height: 250px;
-    background: rgba(255, 255, 255, 0.07);
-    backdrop-filter: blur(16px);
-    -webkit-backdrop-filter: blur(16px);
-    border-radius: 16px;
-    border: 1px solid rgba(255, 255, 255, 0.2);
-    position: relative;
-    padding: 30px;
-    display: flex;
-    flex-direction: column;
-    justify-content: space-between;
-    box-shadow: 0 25px 50px rgba(0, 0, 0, 0.4);
-    color: white;
-    transform: rotateX(var(--x-deg)) rotateY(var(--y-deg));
-}
-
-.card.debit {
-    background: linear-gradient(135deg, #1a1a2e 0%, #16213e 100%);
-}
-
-.card.credit {
-    background: linear-gradient(135deg, #b8860b 0%, #daa520 50%, #b8860b 100%);
-    border-color: rgba(255, 215, 0, 0.4);
-    color: #1a1508;
-}
-
-.card.credit .label {
-    color: rgba(26, 21, 8, 0.85);
-}
-
-.card-label,
-.chip,
-.number,
-.details {
-    position: relative;
-    z-index: 1;
-}
-
-.card-label {
-    font-family: var(--dx-g-font-display, system-ui, sans-serif);
-    font-size: var(--dx-g-spacing-md, 0.875rem);
-    font-weight: 600;
-    line-height: 1.25;
-}
-
-.card::before {
-    content: '';
-    position: absolute;
-    inset: 0;
-    z-index: 0;
-    background: linear-gradient(125deg,
-        transparent 0%,
-        rgba(255, 255, 255, 0.1) 45%,
-        rgba(255, 255, 255, 0.3) 50%,
-        rgba(255, 255, 255, 0.1) 55%,
-        transparent 100%);
-    background-size: 200% 200%;
-    background-position: var(--bg-x) var(--bg-y);
-    border-radius: inherit;
-    pointer-events: none;
-}
-
-.chip {
-    width: 50px;
-    height: 40px;
-    background: linear-gradient(135deg, #fceabb 0%, #f8b500 50%, #fceabb 100%);
-    border-radius: 6px;
-}
-
-.number,
-.value {
-    font-family: 'Courier New', monospace;
-}
-
-.number {
-    font-size: 1.6rem;
-    letter-spacing: 2px;
-    margin-top: 20px;
-}
-
-.label {
-    display: block;
-    font-size: 0.65rem;
-    text-transform: uppercase;
-    color: rgba(255, 255, 255, 0.8);
-}
-
-.value {
-    font-size: 0.9rem;
-    font-weight: bold;
-}

package/src/modules/doc/paymentCard/paymentCard.html

@@ -1,22 +0,0 @@
-<template>
-    <div class="container">
-        <div class={cardClass}>
-            <div class={cardLabelClass}>{cardLabel}</div>
-
-            <div class="chip"></div>
-
-            <div class="number">{number}</div>
-
-            <div class="details">
-                <div>
-                    <span class="label">Cardholder Name</span>
-                    <span class="value">{cardHolder}</span>
-                </div>
-                <div>
-                    <span class="label">Valid Thru</span>
-                    <span class="value">{expires}</span>
-                </div>
-            </div>
-        </div>
-    </div>
-</template>

package/src/modules/doc/paymentCard/paymentCard.ts

@@ -1,91 +0,0 @@
-import { LightningElement, api } from "lwc";
-import { normalizeBoolean } from "dxUtils/normalizers";
-
-export default class PaymentCard extends LightningElement {
-    _isDebit: boolean = false;
-    _number: string | null = null;
-
-    @api
-    get number(): string | null {
-        return this._number;
-    }
-
-    set number(value: string | null) {
-        if (value) {
-            const digits = value.replace(/\s/g, "");
-            this._number = digits.replace(/(.{4})/g, "$1 ").trim();
-        } else {
-            this._number = value;
-        }
-    }
-    _cardHolder: string | null = null;
-
-    @api
-    get cardHolder(): string | null {
-        return this._cardHolder;
-    }
-
-    set cardHolder(value: string | null) {
-        this._cardHolder = value ? value.toUpperCase() : value;
-    }
-    @api expires: string | null = null;
-    @api
-    get isDebit(): boolean {
-        return this._isDebit;
-    }
-
-    set isDebit(value) {
-        this._isDebit = normalizeBoolean(value);
-    }
-
-    get cardClass(): string {
-        return this._isDebit ? "card debit" : "card credit";
-    }
-
-    get cardLabelClass(): string {
-        return this._isDebit ? "card-label debit" : "card-label credit";
-    }
-
-    get cardLabel(): string {
-        return this._isDebit ? "Debit" : "Credit";
-    }
-
-    renderedCallback() {
-        if (this._initialized) {
-            return;
-        }
-        this._initialized = true;
-
-        const card = this.template.querySelector(".card") as HTMLElement;
-        if (!card) {
-            return;
-        }
-
-        let mouseX = 0;
-        let mouseY = 0;
-        let rotateX = 0;
-        let rotateY = 0;
-
-        const onMouseMove = (e: MouseEvent) => {
-            mouseX = (window.innerWidth / 2 - e.clientX) / 15;
-            mouseY = (e.clientY - window.innerHeight / 2) / 15;
-        };
-
-        const animate = () => {
-            rotateX += (mouseY - rotateX) * 0.1;
-            rotateY += (mouseX - rotateY) * 0.1;
-
-            card.style.setProperty("--x-deg", `${rotateX}deg`);
-            card.style.setProperty("--y-deg", `${rotateY}deg`);
-            card.style.setProperty("--bg-x", `${50 + rotateY * 2}%`);
-            card.style.setProperty("--bg-y", `${50 + rotateX * 2}%`);
-
-            requestAnimationFrame(animate);
-        };
-
-        window.addEventListener("mousemove", onMouseMove);
-        requestAnimationFrame(animate);
-    }
-
-    _initialized = false;
-}