@salesforcedevs/docs-components 1.30.1-node22-3 → 1.31.0-md-alpha

package/lwc.config.json

@@ -5,6 +5,7 @@
         { "npm": "@salesforcedevs/dw-components" }
     ],
     "expose": [
+        "doc/contentActionToolbar",
         "doc/amfReference",
         "doc/banner",
         "doc/localeBanner",
@@ -26,6 +27,9 @@
         "doc/specificationContent",
         "doc/versionPicker",
         "doc/xmlContent",
+        "docUtils/searchClient",
+        "docUtils/searchController",
+        "docUtils/searchLocale",
         "docUtils/utils"
     ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/docs-components",
-  "version": "1.30.1-node22-3",
+  "version": "1.31.0-md-alpha",
   "description": "Docs Lightning web components for DSC",
   "license": "MIT",
   "main": "index.js",

package/src/modules/doc/amfReference/amfReference.html

@@ -17,6 +17,7 @@
         languages={languages}
         language={language}
         show-footer={enableFooter}
+        show-content-action-toolbar={showContentActionToolbar}
         empty-state-message={emptyStateMessage}
         origin={origin}
     >

package/src/modules/doc/amfReference/amfReference.ts

@@ -37,6 +37,7 @@ type NavigationItem = {
     isExpanded: boolean;
     children: ParsedMarkdownTopic[];
     isChildrenLoading: boolean;
+    showForwardArrow?: boolean;
 };
 
 export default class AmfReference extends LightningElement {
@@ -72,6 +73,8 @@ export default class AmfReference extends LightningElement {
         return this.isSpecBasedReference(this._currentReferenceId);
     }
 
+    @api showContentActionToolbar = false;
+
     @api
     get referenceSetConfig(): ReferenceSetConfig {
         return this._referenceSetConfig;
@@ -204,6 +207,7 @@ export default class AmfReference extends LightningElement {
 
     _boundOnApiNavigationChanged;
     _boundUpdateSelectedItemFromUrlQuery;
+    _boundOnPageShow;
 
     constructor() {
         super();
@@ -212,6 +216,7 @@ export default class AmfReference extends LightningElement {
             this.onApiNavigationChanged.bind(this);
         this._boundUpdateSelectedItemFromUrlQuery =
             this.updateSelectedItemFromUrlQuery.bind(this);
+        this._boundOnPageShow = this.onPageShow.bind(this);
     }
 
     connectedCallback(): void {
@@ -223,6 +228,7 @@ export default class AmfReference extends LightningElement {
             "popstate",
             this._boundUpdateSelectedItemFromUrlQuery
         );
+        window.addEventListener("pageshow", this._boundOnPageShow);
     }
 
     disconnectedCallback(): void {
@@ -234,6 +240,22 @@ export default class AmfReference extends LightningElement {
             "popstate",
             this._boundUpdateSelectedItemFromUrlQuery
         );
+        window.removeEventListener("pageshow", this._boundOnPageShow);
+    }
+
+    /**
+     * On bfcache restore, reset the sidebar selection so the tree re-syncs
+     * its highlighted tile with the current URL.
+     */
+    protected onPageShow(event: PageTransitionEvent): void {
+        if (!event.persisted) {
+            return;
+        }
+        const currentPath = window.location.pathname;
+        this.selectedSidebarValue = "";
+        Promise.resolve().then(() => {
+            this.selectedSidebarValue = currentPath;
+        });
     }
 
     renderedCallback(): void {
@@ -443,16 +465,21 @@ export default class AmfReference extends LightningElement {
             let navItemChildren = [] as ParsedMarkdownTopic[];
             let isChildrenLoading = false;
             if (amfConfig.referenceType !== REFERENCE_TYPES.markdown) {
-                if (amfConfig.isSelected) {
-                    const amfPromise = this.fetchAmf(amfConfig).then(
-                        (amfJson) => {
-                            this.updateModel(amfConfig.id, amfJson);
-                            this.assignNavigationItemsFromAmf(amfConfig, index);
-                        }
-                    );
-                    this.amfFetchPromiseMap[amfConfig.id] = amfPromise;
+                if (amfConfig.amf) {
+                    if (amfConfig.isSelected) {
+                        const amfPromise = this.fetchAmf(amfConfig).then(
+                            (amfJson) => {
+                                this.updateModel(amfConfig.id, amfJson);
+                                this.assignNavigationItemsFromAmf(
+                                    amfConfig,
+                                    index
+                                );
+                            }
+                        );
+                        this.amfFetchPromiseMap[amfConfig.id] = amfPromise;
+                    }
+                    isChildrenLoading = true;
                 }
-                isChildrenLoading = true;
             } else {
                 const isExpandChildrenEnabled = this.isExpandChildrenEnabled(
                     amfConfig.id
@@ -473,13 +500,30 @@ export default class AmfReference extends LightningElement {
                     amfConfig.isSelected ||
                     this.isExpandChildrenEnabled(amfConfig.id),
                 children: navItemChildren,
-                isChildrenLoading
+                isChildrenLoading,
+                showForwardArrow: this.resolveNavRenderWith(amfConfig)
             };
             this.parentReferenceUrls.push(amfConfig.href);
         }
         this.navigation = navAmfOrder;
     }
 
+    /**
+     * Determines whether the sidebar tile should render a forward arrow for
+     * this reference. Honors `redoc` set on the config, and also infers it
+     * for non-markdown references that have no AMF URL (i.e. those rendered
+     * by Redoc).
+     */
+    private resolveNavRenderWith(amfConfig: AmfConfig): boolean {
+        if (amfConfig.renderWith) {
+            return amfConfig.renderWith === "redoc";
+        }
+        return (
+            amfConfig.referenceType !== REFERENCE_TYPES.markdown &&
+            !amfConfig.amf
+        );
+    }
+
     /**
      * Returns a boolean indicating whether the children should be expanded or not.
      */

package/src/modules/doc/amfReference/types.ts

@@ -78,6 +78,11 @@ export interface AmfConfig {
 
     // required for markdown based references
     topic?: ParsedMarkdownTopic;
+
+    /**
+     * Required for rendering the arrow on LNB
+     */
+    renderWith?: string;
 }
 
 export interface ParsedTopicModel {

package/src/modules/doc/contentActionToolbar/contentActionToolbar.css

@@ -0,0 +1,31 @@
+@import "dxHelpers/reset";
+
+:host {
+    display: block;
+}
+
+.toolbar {
+    display: flex;
+    align-items: center;
+    gap: var(--dx-g-spacing-smd);
+    margin-bottom: var(--dx-g-spacing-lg);
+}
+
+.toolbar-button {
+    --dx-c-button-font-weight: var(--dx-g-font-demi);
+    --dx-c-button-line-height: var(--dx-g-spacing-mlg);
+    --dx-c-button-letter-spacing: 0.005em;
+}
+
+.divider {
+    width: 1px;
+    height: var(--dx-g-spacing-md);
+    background-color: var(--dx-g-gray-70);
+}
+
+@media screen and (max-width: 480px) {
+    .toolbar-button_copy-url,
+    .divider_copy-url {
+        display: none;
+    }
+}

package/src/modules/doc/contentActionToolbar/contentActionToolbar.html

@@ -0,0 +1,53 @@
+<template>
+    <div class="toolbar" lwc:if={markdownUrl}>
+        <dx-tooltip placement="top-right" label={copyMarkdownLabel}>
+            <dx-button
+                class="toolbar-button"
+                variant="inline"
+                size="small"
+                icon-sprite="utility"
+                icon-symbol="copy"
+                icon-size="medium"
+                icon-position="right"
+                aria-label={copyMarkdownButtonText}
+                onclick={handleCopyMarkdown}
+            >
+                {copyMarkdownButtonText}
+            </dx-button>
+        </dx-tooltip>
+
+        <div class="divider"></div>
+
+        <dx-button
+            class="toolbar-button"
+            variant="inline"
+            size="small"
+            icon-sprite="utility"
+            icon-symbol="new_window"
+            icon-size="medium"
+            icon-position="right"
+            aria-label={viewMarkdownButtonText}
+            onclick={handleViewMarkdown}
+        >
+            {viewMarkdownButtonText}
+        </dx-button>
+
+        <div class="divider divider_copy-url"></div>
+
+        <dx-tooltip placement="top-right" label={copyUrlLabel}>
+            <dx-button
+                class="toolbar-button toolbar-button_copy-url"
+                variant="inline"
+                size="small"
+                icon-sprite="utility"
+                icon-symbol="link"
+                icon-size="medium"
+                icon-position="right"
+                aria-label={copyUrlButtonText}
+                onclick={handleCopyUrl}
+            >
+                {copyUrlButtonText}
+            </dx-button>
+        </dx-tooltip>
+    </div>
+</template>

package/src/modules/doc/contentActionToolbar/contentActionToolbar.ts

@@ -0,0 +1,151 @@
+import { LightningElement, api } from "lwc";
+import { track } from "dxUtils/analytics";
+
+const DEFAULT_COPY_TOOLTIP_LABEL = "Click to copy";
+const COPIED_TOOLTIP_LABEL = "Copied!";
+const COPIED_TOOLTIP_RESET_MS = 1000;
+
+const ANALYTICS_CONTENT_CATEGORY = "content action toolbar";
+const COPY_MARKDOWN_LABEL = "Copy as Markdown";
+const VIEW_MARKDOWN_LABEL = "View as Markdown";
+const COPY_URL_LABEL = "Copy URL to Markdown";
+
+export default class ContentActionToolbar extends LightningElement {
+    @api
+    get pageUrl(): string | undefined {
+        return this._pageUrl;
+    }
+    set pageUrl(value: string | undefined) {
+        if (this._pageUrl === value) {
+            return;
+        }
+        this._pageUrl = value;
+    }
+    private _pageUrl?: string;
+
+    copyMarkdownLabel: string = DEFAULT_COPY_TOOLTIP_LABEL;
+    copyUrlLabel: string = DEFAULT_COPY_TOOLTIP_LABEL;
+
+    private copyTooltipResetTimeout: number | null = null;
+
+    /**
+     * Returns the `.md` equivalent of `pageUrl` with any hash and query
+     * string stripped, or `null` when `pageUrl` is not set or does not end
+     * with `.html`.
+     */
+    get markdownUrl(): string | null {
+        if (!this.pageUrl) {
+            return null;
+        }
+
+        const url = new URL(this.pageUrl, window.location.href);
+        url.hash = "";
+        url.search = "";
+
+        if (!url.pathname.endsWith(".html")) {
+            return null;
+        }
+
+        url.pathname = url.pathname.replace(/\.html$/, ".md");
+        return url.toString();
+    }
+
+    get copyMarkdownButtonText(): string {
+        return COPY_MARKDOWN_LABEL;
+    }
+
+    get viewMarkdownButtonText(): string {
+        return VIEW_MARKDOWN_LABEL;
+    }
+
+    get copyUrlButtonText(): string {
+        return COPY_URL_LABEL;
+    }
+
+    async handleCopyMarkdown(event: Event) {
+        if (!this.markdownUrl) {
+            return;
+        }
+
+        this.trackToolbarEvent(
+            event,
+            "custEv_linkClick",
+            COPY_MARKDOWN_LABEL,
+            this.markdownUrl
+        );
+
+        try {
+            const response = await fetch(this.markdownUrl);
+            if (!response.ok) {
+                return;
+            }
+            const markdown = await response.text();
+            await navigator.clipboard.writeText(markdown);
+            this.flashCopied("copyMarkdownLabel");
+        } catch (error) {
+            console.error(error);
+        }
+    }
+
+    handleViewMarkdown(event: Event) {
+        if (!this.markdownUrl) {
+            return;
+        }
+
+        this.trackToolbarEvent(
+            event,
+            "custEv_linkClick",
+            VIEW_MARKDOWN_LABEL,
+            this.markdownUrl
+        );
+
+        window.open(this.markdownUrl, "_blank", "noopener,noreferrer");
+    }
+
+    async handleCopyUrl(event: Event) {
+        if (!this.markdownUrl) {
+            return;
+        }
+
+        this.trackToolbarEvent(
+            event,
+            "custEv_linkClick",
+            COPY_URL_LABEL,
+            this.markdownUrl
+        );
+
+        try {
+            await navigator.clipboard.writeText(this.markdownUrl);
+            this.flashCopied("copyUrlLabel");
+        } catch (error) {
+            console.error(error);
+        }
+    }
+
+    private trackToolbarEvent(
+        event: Event,
+        eventName: "custEv_linkClick",
+        label: string,
+        url: string
+    ): void {
+        track(event.currentTarget!, eventName, {
+            click_text: label,
+            click_url: url,
+            element_type: "button_link",
+            element_title: label,
+            content_category: ANALYTICS_CONTENT_CATEGORY
+        });
+    }
+
+    private flashCopied(labelKey: "copyMarkdownLabel" | "copyUrlLabel") {
+        if (this.copyTooltipResetTimeout !== null) {
+            window.clearTimeout(this.copyTooltipResetTimeout);
+        }
+        this[labelKey] = COPIED_TOOLTIP_LABEL;
+        this.copyTooltipResetTimeout = window.setTimeout(() => {
+            this.copyMarkdownLabel = DEFAULT_COPY_TOOLTIP_LABEL;
+            this.copyUrlLabel = DEFAULT_COPY_TOOLTIP_LABEL;
+            this.copyTooltipResetTimeout = null;
+        }, COPIED_TOOLTIP_RESET_MS);
+    }
+}

package/src/modules/doc/contentActionToolbar/contentActionToolbarMocks.ts

@@ -0,0 +1,48 @@
+import { http, HttpResponse } from "msw";
+
+/**
+ * Mocks for the content action toolbar so stories never hit the real
+ * docs backend. Any story rendering `doc-content-action-toolbar` (directly or
+ * via `doc-content-layout`) must register `contentActionToolbarMswHandlers`
+ * and call `interceptWindowOpenForContentActionToolbar()`.
+ */
+export const DUMMY_MARKDOWN_CONTENT = `# Dummy Markdown
+
+Storybook serves this placeholder content in place of the real markdown
+that the docs backend would return for the current page. It exists so
+the "Copied" tooltip, the "View as Markdown" new tab, and the
+"Copy URL to Markdown" clipboard behavior are all exercisable in
+storybook without hitting the live backend.
+
+- Item 1
+- Item 2
+- Item 3
+`;
+
+export const DUMMY_MARKDOWN_DATA_URL = `data:text/markdown;charset=utf-8,${encodeURIComponent(
+    DUMMY_MARKDOWN_CONTENT
+)}`;
+
+/** Intercepts any `.md` GET request and returns the dummy markdown. */
+export const contentActionToolbarMswHandlers = [
+    http.get(/\.md(\?.*)?$/, () => HttpResponse.text(DUMMY_MARKDOWN_CONTENT))
+];
+
+let windowOpenIntercepted = false;
+
+/** Redirects `window.open` calls for `.md` URLs to the dummy markdown data URL (MSW does not cover new tabs). */
+export function interceptWindowOpenForContentActionToolbar() {
+    if (windowOpenIntercepted) {
+        return;
+    }
+    windowOpenIntercepted = true;
+
+    const originalOpen = window.open.bind(window);
+    window.open = ((url?: string | URL, target?: string, features?: string) => {
+        const stringUrl = url?.toString() ?? "";
+        if (stringUrl.endsWith(".md")) {
+            return originalOpen(DUMMY_MARKDOWN_DATA_URL, target, features);
+        }
+        return originalOpen(url ?? "", target, features);
+    }) as typeof window.open;
+}

package/src/modules/doc/contentLayout/contentLayout.html

@@ -43,7 +43,7 @@
                                 ></path>
                             </g>
                         </svg>
-                        {readingTime} minute read
+                        {readingTimeLabel}
                     </div>
                     <div class="share-below-read" lwc:if={showSocialShare}>
                         <doc-social-share

package/src/modules/doc/contentLayout/contentLayout.ts

@@ -1,11 +1,17 @@
 /* eslint-disable @lwc/lwc/no-document-query */
-import { LightningElement, api, track } from "lwc";
-import { closest } from "kagekiri";
+import { LightningElement, api, createElement, track } from "lwc";
+import { closest, querySelector } from "kagekiri";
 import { toJson, normalizeBoolean } from "dxUtils/normalizers";
 import { highlightTerms } from "dxUtils/highlight";
 import { SearchSyncer } from "docUtils/searchSyncer";
 import type { OptionWithLink } from "typings/custom";
 import { buildDocLinkClickHandler } from "dxUtils/analytics";
+import ContentActionToolbar from "doc/contentActionToolbar";
+
+const CONTENT_ACTION_TOOLBAR_TAG = "doc-content-action-toolbar";
+const PAGE_HEADING_SELECTOR = "h1";
+const FALLBACK_HEADING_SELECTOR = "h1, h2, h3, h4, h5, h6";
+const CONTENT_BODY_SELECTOR = ".content-body-container .content-body";
 
 type AnchorMap = { [key: string]: { intersect: boolean; id: string } };
 
@@ -28,6 +34,35 @@ const HIGHLIGHTABLE_SELECTOR = [
 ].join(",");
 export const OBSERVER_ATTACH_WAIT_TIME = 500;
 
+const DEFAULT_READING_TIME_LOCALE = "en-us";
+
+/**
+ * Localized "minute read" templates. `{minutes}` is replaced with the rounded
+ * reading-time value. Only displayed when reading time is greater than 1, so
+ * plural forms are always appropriate. Keys match the locales declared in
+ * sfdocs (and the doc-locale-banner) so that a localized document automatically
+ * gets a localized reading-time label.
+ */
+export const READING_TIME_LABELS: Record<string, string> = {
+    "en-us": "{minutes} minute read",
+    "ja-jp": "読了時間 {minutes} 分",
+    "zh-cn": "阅读时间 {minutes} 分钟",
+    "zh-tw": "閱讀時間 {minutes} 分鐘",
+    "fr-fr": "Lecture de {minutes} minutes",
+    "de-de": "{minutes} Minuten Lesezeit",
+    "it-it": "{minutes} minuti di lettura",
+    "ko-kr": "읽는 데 {minutes}분",
+    "pt-br": "{minutes} minutos de leitura",
+    "es-mx": "{minutes} minutos de lectura",
+    "es-es": "{minutes} minutos de lectura",
+    "ru-ru": "Время чтения: {minutes} мин",
+    "fi-fi": "{minutes} minuutin lukuaika",
+    "da-dk": "{minutes} minutters læsning",
+    "sv-se": "{minutes} minuters läsning",
+    "nl-nl": "{minutes} minuten leestijd",
+    "nb-no": "{minutes} minutters lesetid"
+};
+
 export default class ContentLayout extends LightningElement {
     @api sidebarValue!: string;
     @api sidebarHeader!: string;
@@ -66,6 +101,17 @@ export default class ContentLayout extends LightningElement {
     /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). Passed through to dx-footer. */
     @api origin: string | null = null;
 
+    /** Controls whether the content action toolbar is displayed. */
+    @api
+    get showContentActionToolbar() {
+        return this._showContentActionToolbar;
+    }
+    set showContentActionToolbar(value) {
+        this._showContentActionToolbar = normalizeBoolean(value);
+        this.updateContentActionToolbar();
+    }
+    private _showContentActionToolbar = false;
+
     @api
     get breadcrumbs() {
         return this._breadcrumbs;
@@ -123,6 +169,7 @@ export default class ContentLayout extends LightningElement {
     protected hasRendered: boolean = false;
     protected contentLoaded: boolean = false;
     protected sidebarOpen: boolean = false;
+    protected contentActionToolbarElement: HTMLElement | null = null;
 
     get shouldDisplayFeedback() {
         return this.contentLoaded && typeof Sprig !== "undefined";
@@ -173,6 +220,19 @@ export default class ContentLayout extends LightningElement {
         return this.readingTime != null && this.readingTime > 1;
     }
 
+    /**
+     * Localized "X minute read" string for the current document language.
+     * Falls back to the default (en-us) template when the language is missing
+     * or has no translation.
+     */
+    get readingTimeLabel(): string {
+        const localeKey = (this.language || "").toLowerCase();
+        const template =
+            READING_TIME_LABELS[localeKey] ||
+            READING_TIME_LABELS[DEFAULT_READING_TIME_LOCALE];
+        return template.replace("{minutes}", String(this.readingTime));
+    }
+
     /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
     get effectiveFooterOrigin(): string {
         return (
@@ -215,6 +275,8 @@ export default class ContentLayout extends LightningElement {
         window.addEventListener("scroll", this.adjustNavPosition);
         window.addEventListener("resize", this.adjustNavPosition);
 
+        this.updateContentActionToolbar();
+
         if (!this.hasRendered) {
             this.hasRendered = true;
             this.restoreScroll();
@@ -224,6 +286,54 @@ export default class ContentLayout extends LightningElement {
         }
     }
 
+    /**
+     * Inserts the content action toolbar into the slotted content immediately
+     * after the first H1 found inside this layout, falling back to the first
+     * heading of any level if no H1 exists.
+     */
+    protected updateContentActionToolbar(): void {
+        if (!this.showContentActionToolbar || !this.sidebarValue) {
+            this.removeContentActionToolbar();
+            return;
+        }
+
+        const contentBody = querySelector(
+            CONTENT_BODY_SELECTOR,
+            this.template.host
+        ) as HTMLElement | null;
+
+        if (!contentBody) {
+            return;
+        }
+
+        const heading = (querySelector(PAGE_HEADING_SELECTOR, contentBody) ??
+            querySelector(
+                FALLBACK_HEADING_SELECTOR,
+                contentBody
+            )) as HTMLElement | null;
+
+        if (!heading) {
+            return;
+        }
+
+        const toolbar = (this.contentActionToolbarElement ??
+            createElement(CONTENT_ACTION_TOOLBAR_TAG, {
+                is: ContentActionToolbar
+            })) as HTMLElement & { pageUrl?: string };
+
+        toolbar.pageUrl = this.sidebarValue;
+
+        if (toolbar.previousElementSibling !== heading) {
+            heading.parentNode?.insertBefore(toolbar, heading.nextSibling);
+        }
+
+        this.contentActionToolbarElement = toolbar;
+    }
+
+    protected removeContentActionToolbar(): void {
+        this.contentActionToolbarElement?.remove();
+    }
+
     disconnectedCallback(): void {
         this.disconnectObserver();
         window.removeEventListener(
@@ -239,6 +349,9 @@ export default class ContentLayout extends LightningElement {
 
         // Remove link click handler
         this.template.removeEventListener("click", this.handleLinkClick);
+
+        this.removeContentActionToolbar();
+        this.contentActionToolbarElement = null;
     }
 
     restoreScroll() {
@@ -481,6 +594,7 @@ export default class ContentLayout extends LightningElement {
 
     onSlotChange(): void {
         this.updateRNB();
+        this.updateContentActionToolbar();
         this.contentLoaded = true;
     }
 

package/src/modules/doc/header/header.html

@@ -13,7 +13,6 @@
                         onclick={onLinkClick}
                         class="dev-center-content"
                     >
-                        <dx-icon symbol="back"></dx-icon>
                         <dx-icon
                             class="brand-icon"
                             lwc:if={devCenter.icon}

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

@@ -41,7 +41,7 @@
                                 ></path>
                             </g>
                         </svg>
-                        {readingTime} minute read
+                        {readingTimeLabel}
                     </div>
                     <slot onslotchange={onSlotChange}></slot>
                     <doc-sprig-survey