@salesforcedevs/docs-components 1.29.0 → 1.30.0

package/lwc.config.json

@@ -5,6 +5,7 @@
         { "npm": "@salesforcedevs/dw-components" }
     ],
     "expose": [
+        "doc/contentActionToolbar",
         "doc/amfReference",
         "doc/banner",
         "doc/localeBanner",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.29.0",
+    "version": "1.30.0",
     "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": "0dce435f5845187b50577dc005de80ddc3002b9d"
+    "gitHead": "f3e8e2c6ae6c8792b316e41021344648d4a07bec"
 }

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

@@ -73,6 +73,17 @@ export default class AmfReference extends LightningElement {
         return this.isSpecBasedReference(this._currentReferenceId);
     }
 
+    /**
+     * Content action toolbar is only enabled for markdown-based references in the en-us locale.
+     */
+    get showContentActionToolbar(): boolean {
+        if (this.showSpecBasedReference) {
+            return false;
+        }
+        const locale = this.language?.toLowerCase() ?? "en-us";
+        return locale === "en-us";
+    }
+
     @api
     get referenceSetConfig(): ReferenceSetConfig {
         return this._referenceSetConfig;

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.ts

@@ -1,11 +1,15 @@
 /* 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";
 
 type AnchorMap = { [key: string]: { intersect: boolean; id: string } };
 
@@ -95,6 +99,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;
@@ -152,6 +167,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";
@@ -257,6 +273,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();
@@ -266,6 +284,43 @@ export default class ContentLayout extends LightningElement {
         }
     }
 
+    /**
+     * Inserts the content action toolbar into the slotted content immediately
+     * after the first H1 found inside this layout.
+     */
+    protected updateContentActionToolbar(): void {
+        if (!this.showContentActionToolbar || !this.sidebarValue) {
+            this.removeContentActionToolbar();
+            return;
+        }
+
+        const heading = querySelector(
+            PAGE_HEADING_SELECTOR,
+            this.template.host
+        ) 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(
@@ -281,6 +336,9 @@ export default class ContentLayout extends LightningElement {
 
         // Remove link click handler
         this.template.removeEventListener("click", this.handleLinkClick);
+
+        this.removeContentActionToolbar();
+        this.contentActionToolbarElement = null;
     }
 
     restoreScroll() {
@@ -523,6 +581,7 @@ export default class ContentLayout extends LightningElement {
 
     onSlotChange(): void {
         this.updateRNB();
+        this.updateContentActionToolbar();
         this.contentLoaded = true;
     }