@salesforcedevs/docs-components 1.33.2 → 1.34.0-alpha1

package/lwc.config.json

@@ -18,6 +18,7 @@
         "doc/contentMedia",
         "doc/docXmlContent",
         "doc/lwcContentLayout",
+        "doc/unifiedContentLayout",
         "doc/header",
         "doc/heading",
         "doc/headingAnchor",

package/package.json

@@ -1,29 +1,29 @@
 {
-    "name": "@salesforcedevs/docs-components",
-    "version": "1.33.2",
-    "description": "Docs Lightning web components for DSC",
-    "license": "MIT",
-    "main": "index.js",
-    "engines": {
-        "node": "22.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": "8a1fa72aa921307f372be0268d5b8b539322dbbb"
-}
+  "name": "@salesforcedevs/docs-components",
+  "version": "1.34.0-alpha1",
+  "description": "Docs Lightning web components for DSC",
+  "license": "MIT",
+  "main": "index.js",
+  "engines": {
+    "node": "22.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"
+}

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

@@ -7,6 +7,7 @@
 .toolbar {
     display: flex;
     align-items: center;
+    flex-wrap: wrap;
     gap: var(--dx-g-spacing-smd);
     margin-bottom: var(--dx-g-spacing-lg);
 }

package/src/modules/doc/redocReference/redocReference.css

@@ -1,7 +1,7 @@
 :host {
     --dx-footer-margin-top: 142px;
     --doc-c-redoc-sidebar-top: calc(
-        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
-            var(--dx-g-spacing-xl)
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
     );
+    --doc-c-redoc-sidebar-bg: white;
 }

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

@@ -3,9 +3,13 @@ import { createElement, LightningElement, api } from "lwc";
 import DocPhase from "doc/phase";
 import DxFooter from "dx/footer";
 import DxIcon from "dx/icon";
+import SidebarFooterNav from "dx/sidebarFooterNav";
+import VersionPicker from "doc/versionPicker";
 import SprigSurvey from "doc/sprigSurvey";
 import { throttle } from "throttle-debounce";
 import { pollUntil } from "dxUtils/async";
+import { toJson } from "dxUtils/normalizers";
+import type { OptionWithLink } from "typings/custom";
 
 declare global {
     interface Window {
@@ -30,14 +34,28 @@ type ReferenceItem = {
     topic?: ReferenceTopic;
 };
 
+/** A selectable spec version. Mirrors `ReferenceVersion` in `doc/amfReference`. */
+type ReferenceVersion = {
+    id: string;
+    label: string;
+    deprecated?: boolean;
+    selected?: boolean;
+    link: { href: string };
+};
+
 type ReferenceConfig = {
     refList: ReferenceItem[];
+    versions?: ReferenceVersion[];
 };
 
 const SCROLL_THROTTLE_DELAY = 50;
 const ELEMENT_TIMEOUT = 10000;
 const ELEMENT_CHECK_INTERVAL = 100;
-const REFERENCES_SEGMENT = "/references/";
+const DEFAULT_PROJECT_TITLE = "All Reference";
+const BACK_TARGET_STORAGE_KEY = "redoc-back-target";
+const SELECTED_VIEW_STORAGE_KEY = "redoc-selected-view";
+const DOCS_PATH_SEGMENT = "docs";
+const DEFAULT_LOCALE = "en-us";
 
 export default class RedocReference extends LightningElement {
     private _referenceConfig: ReferenceConfig = { refList: [] };
@@ -47,6 +65,7 @@ export default class RedocReference extends LightningElement {
     private docHeaderElement: Element | null = null;
     private docPhaseWrapperElement: Element | null = null;
     private lastSidebarTop = 0;
+    private _languages: OptionWithLink[] = [];
 
     /**
      * History length captured at mount (pre-Redoc), used by `onBackClick` to
@@ -91,19 +110,112 @@ export default class RedocReference extends LightningElement {
      * Project title (same value passed to `<doc-header>` as `subtitle`). Used
      * inside the Redoc-rendered UI to label the parent project.
      */
-    @api projectTitle: string | null = "All Reference";
+    @api
+    get projectTitle(): string | null {
+        return this.isDocContentType
+            ? this._projectTitle
+            : DEFAULT_PROJECT_TITLE;
+    }
+    set projectTitle(value: string | null) {
+        this._projectTitle = value;
+    }
+    private _projectTitle: string | null = null;
+
+    /**
+     * Href to navigate to when the back link is clicked AND there is no
+     * usable referrer (e.g. the user opened the page directly in a fresh
+     * tab).
+     */
+    @api headerHref: string | null = null;
+
+    @api
+    get contentType(): string {
+        return this._contentType;
+    }
+    set contentType(value: string) {
+        this._contentType = value;
+    }
+    private _contentType: string = "";
+
+    @api
+    get languages(): OptionWithLink[] {
+        return this._languages;
+    }
+    set languages(value: string | OptionWithLink[]) {
+        this._languages = toJson(value) || [];
+    }
+
+    @api language: string | null = null;
 
     get specTitle(): string | null {
         return this.getSelectedReference()?.title ?? null;
     }
 
+    get isDocContentType(): boolean {
+        return this.contentType === "docs";
+    }
+
+    get isReferenceContentType(): boolean {
+        return this.contentType === "references";
+    }
+
+    get isMultiSpecSet(): boolean {
+        const refCount = this.referenceConfig?.refList?.length ?? 0;
+        return refCount > 1;
+    }
+
+    get versions(): ReferenceVersion[] {
+        return this._referenceConfig?.versions ?? [];
+    }
+
+    /** The version flagged `selected`, else the first (the latest/GA version). */
+    get selectedVersion(): ReferenceVersion | null {
+        const versions = this.versions;
+        return versions.find((v) => v.selected) ?? versions[0] ?? null;
+    }
+
+    /** True when the selected version is the latest/GA one (index 0). */
+    get latestVersion(): boolean {
+        return this.versions.length
+            ? this.selectedVersion?.id === this.versions[0].id
+            : false;
+    }
+
+    get hasVersionPicker(): boolean {
+        return this.versions.length > 0;
+    }
+
+    /** A single version has nothing to choose, so it renders read-only. */
+    get isVersionReadOnly(): boolean {
+        return this.versions.length === 1;
+    }
+
+    // Reads stored back target
+    private getBackTargetFromSession(): string | null {
+        return sessionStorage.getItem(BACK_TARGET_STORAGE_KEY);
+    }
+
+    private setBackTargetInSession(href: string): void {
+        sessionStorage.setItem(BACK_TARGET_STORAGE_KEY, href);
+    }
+
     /**
-     * Whether to show the project header (only for multi-spec reference sets).
+     * when more than one localized spec is available
+     */
+    get hasLocalePicker(): boolean {
+        return this.languages.length > 1;
+    }
+
+    /**
+     * Whether to show the project header. Shown for multi-spec reference
+     * sets, and for any docs-content spec topic so it always has a back
+     * link.
      */
     get showRedocHeader(): boolean {
-        const refCount = this._referenceConfig?.refList?.length ?? 0;
-        const isMultiSpecSet = refCount > 1;
-        return isMultiSpecSet && !!(this.projectTitle || this.specTitle);
+        return (
+            (this.isReferenceContentType && this.isMultiSpecSet) ||
+            this.isDocContentType
+        );
     }
 
     /**
@@ -111,16 +223,73 @@ export default class RedocReference extends LightningElement {
      */
     private onBackClick = (event: Event): void => {
         event.preventDefault();
+
+        const target = this.getTranslatedBackTarget() ?? this.headerHref;
+
+        if (target) {
+            window.location.assign(target);
+        }
+    };
+
+    private getTranslatedBackTarget(): string | null {
+        const stored = this.getBackTargetFromSession();
+        if (stored) {
+            return this.language
+                ? this.translateToCurrentLocale(stored)
+                : stored;
+        }
+
+        const referrer = this.getSameOriginReferrerHref();
+        return referrer &&
+            !this.isLocaleHref(new URL(referrer).pathname) &&
+            !this.isVersionHref(new URL(referrer).pathname)
+            ? referrer
+            : null;
+    }
+
+    /* The locale segment sits after "docs" for docs pages,
+     * and after the product segment for references.
+     */
+    private translateToCurrentLocale(storedHref: string): string {
+        const url = new URL(storedHref, window.location.origin);
+        const localeIds = this.languages.map((loc) => loc.id);
+        const segments = url.pathname.split("/").filter(Boolean);
+
+        // docs -> right after "docs"; references -> after the product segment.
+        const localeIndex = this.isDocContentType ? 1 : 2;
+
+        if (segments[0] === DOCS_PATH_SEGMENT) {
+            // Drop the existing locale segment, if any
+            if (localeIds.includes(segments[localeIndex])) {
+                segments.splice(localeIndex, 1);
+            }
+            // Add the current locale
+            if (this.language && this.language !== DEFAULT_LOCALE) {
+                segments.splice(localeIndex, 0, this.language);
+            }
+        }
+
+        url.pathname = "/" + segments.join("/");
+        return url.href;
+    }
+
+    // Preserves target across locale switches, updates on normal navigation
+    private trackBackTarget(): void {
         const referrerHref = this.getSameOriginReferrerHref();
-        if (referrerHref) {
-            window.location.href = referrerHref;
+        if (!referrerHref) {
             return;
         }
-        const fallbackHref = this.getReferencesRootHref();
-        if (fallbackHref) {
-            window.location.href = fallbackHref;
+
+        const referrerUrl = new URL(referrerHref);
+        if (
+            this.isLocaleHref(referrerUrl.pathname) ||
+            this.isVersionHref(referrerUrl.pathname)
+        ) {
+            return;
         }
-    };
+
+        this.setBackTargetInSession(referrerHref);
+    }
 
     /**
      * Returns the referrer URL when the page was reached via in-tab navigation
@@ -144,16 +313,29 @@ export default class RedocReference extends LightningElement {
     }
 
     /**
-     * Derives the project's `.../references` root from the current URL by
-     * trimming any trailing reference id (and deeper segments). Returns null
-     * when the URL doesn't contain a `/references` segment.
+     * switching locale on this same page.
      */
-    private getReferencesRootHref(): string | null {
-        const { pathname } = window.location;
-        const idx = pathname.lastIndexOf(REFERENCES_SEGMENT);
-        return idx === -1
-            ? null
-            : pathname.slice(0, idx + REFERENCES_SEGMENT.length);
+    private isLocaleHref(pathname: string): boolean {
+        return this.languages.some((locale) => {
+            const href = locale?.link?.href;
+            return (
+                !!href &&
+                new URL(href, window.location.origin).pathname === pathname
+            );
+        });
+    }
+
+    /**
+     * switching version on this same page.
+     */
+    private isVersionHref(pathname: string): boolean {
+        return this.versions.some((version) => {
+            const href = version?.link?.href;
+            return (
+                !!href &&
+                new URL(href, window.location.origin).pathname === pathname
+            );
+        });
     }
 
     /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
@@ -168,6 +350,9 @@ export default class RedocReference extends LightningElement {
         // so it reflects real in-tab navigation rather than Redoc's churn.
         this.initialHistoryLength = window.history.length;
 
+        // Track the back target, preserving it across locale switches
+        this.trackBackTarget();
+
         window.addEventListener("scroll", this.handleScrollAndResize);
         window.addEventListener("resize", this.handleScrollAndResize);
     }
@@ -225,6 +410,14 @@ export default class RedocReference extends LightningElement {
         return parseInt(value, 10) || 0;
     }
 
+    /** Redoc's LNB background color, themeable via `--doc-c-redoc-sidebar-bg`. */
+    private get sidebarBackgroundColor(): string {
+        const value = getComputedStyle(this.template.host).getPropertyValue(
+            "--doc-c-redoc-sidebar-bg"
+        );
+        return value.trim() || "white";
+    }
+
     /*
      ** Since we could not use --dx-g-global-header-height as getPropertyValue returns a calc expression,
      ** we are using the respective CSS variables to calculate the height.
@@ -340,7 +533,14 @@ export default class RedocReference extends LightningElement {
                     specUrl,
                     {
                         // Dynamic scroll offset to account for headers
-                        scrollYOffset: this.calculateScrollYOffset
+                        scrollYOffset: this.calculateScrollYOffset,
+                        // Redoc's own styled background outranks injected
+                        // CSS, so the LNB background must be set via theme.
+                        theme: {
+                            sidebar: {
+                                backgroundColor: this.sidebarBackgroundColor
+                            }
+                        }
                     },
                     redocContainer,
                     (error: any) => {
@@ -394,14 +594,26 @@ export default class RedocReference extends LightningElement {
             this.appendFooterItems(apiContentDiv);
 
             // Inject the multi-spec project header into Redoc's left menu only.
-            this.insertProjectHeaderInMenu(redocContainer);
+            this.insertSidebarNav(redocContainer);
 
             // Wait for footer to be rendered before updating styles
             requestAnimationFrame(() => {
-                this.updateRedocThirdColumnStyle(redocContainer);
-
-                // Fix initial hash scroll after doc phase insertion
-                this.handleInitialHashScrollFix();
+                try {
+                    this.updateRedocThirdColumnStyle(redocContainer);
+
+                    // Restore the view selected before a version switch only
+                    // after all layout mutations (footer, header) are
+                    // complete, so the scroll lands on the correct element.
+                    this.restoreSelectedView();
+
+                    // Fix initial hash scroll after doc phase insertion
+                    this.handleInitialHashScrollFix();
+                } catch (error) {
+                    this.showErrorUI(
+                        "Failed to integrate custom components:",
+                        error
+                    );
+                }
             });
         } catch (error) {
             this.showErrorUI("Failed to integrate custom components:", error);
@@ -409,31 +621,107 @@ export default class RedocReference extends LightningElement {
     }
 
     /**
-     * Inserts the project header into Redoc for multi-spec reference sets.
+     * Inserts the project header and LNB footer into Redoc.
+     */
+    private insertSidebarNav(redocContainer: HTMLElement): void {
+        // Select the LNB and content area of Redoc and insert the requried header.
+        if (this.showRedocHeader) {
+            redocContainer
+                .querySelectorAll<HTMLElement>(".menu-content, .api-content")
+                .forEach((target) => {
+                    target.insertBefore(
+                        this.buildProjectHeaderDom(),
+                        target.firstChild
+                    );
+                });
+        }
+
+        // Locale picker
+        if (this.hasLocalePicker) {
+            const menuContent = redocContainer.querySelector(".menu-content");
+            menuContent?.appendChild(this.buildLocalePickerDom());
+        }
+    }
+
+    /** Builds the version picker DOM by reusing `doc-version-picker`. */
+    private buildVersionPickerDom(): HTMLElement {
+        const wrapper = document.createElement("div");
+        wrapper.className = "redoc-version-picker";
+
+        const picker = createElement("doc-version-picker", {
+            is: VersionPicker
+        });
+
+        Object.assign(picker, {
+            versions: this.versions,
+            selectedVersion: this.selectedVersion,
+            latestVersion: this.latestVersion,
+            readOnly: this.isVersionReadOnly
+        });
+        picker.addEventListener("change", this.onVersionChange);
+        wrapper.appendChild(picker);
+
+        return wrapper;
+    }
+
+    /** Stashes the current view (URL hash) before the version link navigates. */
+    private onVersionChange = (): void => {
+        sessionStorage.setItem(
+            SELECTED_VIEW_STORAGE_KEY,
+            window.location.hash || ""
+        );
+    };
+
+    /**
+     * Re-applies the view stashed before a version switch, if its anchor exists
+     * in the new spec; otherwise a no-op (lands on the spec root).
      */
-    private insertProjectHeaderInMenu(redocContainer: HTMLElement): void {
-        if (!this.showRedocHeader) {
+    private restoreSelectedView(): void {
+        const storedHash = sessionStorage.getItem(SELECTED_VIEW_STORAGE_KEY);
+        sessionStorage.removeItem(SELECTED_VIEW_STORAGE_KEY);
+
+        if (!storedHash || window.location.hash) {
             return;
         }
 
-        // Select the LNB and content area of Redoc and insert the requried header.
-        redocContainer
-            .querySelectorAll<HTMLElement>(".menu-content, .api-content")
-            .forEach((target) => {
-                target.insertBefore(
-                    this.buildProjectHeaderDom(),
-                    target.firstChild
-                );
-            });
+        const targetId = storedHash.replace(/^#/, "");
+        if (targetId && document.getElementById(targetId)) {
+            window.location.hash = storedHash;
+        }
     }
 
     /**
-     * Builds a fresh project-title/spec-title header DOM node.
+     * Builds the locale picker DOM by reusing `dx-sidebar-footer-nav`
+     */
+    private buildLocalePickerDom(): HTMLElement {
+        const wrapper = document.createElement("div");
+        wrapper.className = "redoc-footer-nav";
+
+        const picker = createElement("dx-sidebar-footer-nav", {
+            is: SidebarFooterNav
+        });
+
+        Object.assign(picker, {
+            languages: this.languages,
+            language: this.language
+        });
+        wrapper.appendChild(picker);
+
+        return wrapper;
+    }
+
+    /**
+     * Builds the doc header: a title group (back link + spec title) and, when
+     * versions are available, the version picker as a sibling row. Layout/gaps
+     * are styled by the developer-website's redoc CSS.
      */
     private buildProjectHeaderDom(): HTMLElement {
         const wrapper = document.createElement("div");
         wrapper.className = "redoc-project-header";
 
+        const main = document.createElement("div");
+        main.className = "redoc-project-header-main";
+
         if (this.projectTitle) {
             const backLink = document.createElement("a");
             backLink.className = "redoc-project-back";
@@ -454,14 +742,20 @@ export default class RedocReference extends LightningElement {
 
             backLink.appendChild(icon);
             backLink.appendChild(label);
-            wrapper.appendChild(backLink);
+            main.appendChild(backLink);
         }
 
         if (this.specTitle) {
             const specEl = document.createElement("h2");
             specEl.className = "redoc-spec-title dx-text-display-7";
             specEl.textContent = this.specTitle;
-            wrapper.appendChild(specEl);
+            main.appendChild(specEl);
+        }
+
+        wrapper.appendChild(main);
+
+        if (this.hasVersionPicker) {
+            wrapper.appendChild(this.buildVersionPickerDom());
         }
 
         return wrapper;

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.css

@@ -0,0 +1,19 @@
+:host {
+    display: block;
+}
+
+.content-type-docs doc-phase {
+    --doc-c-phase-top: calc(
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+            var(--dx-g-spacing-xl)
+    );
+}
+
+@media screen and (max-width: 768px) {
+    .content-type-docs doc-phase {
+        --doc-c-phase-top: calc(
+            var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+                40px
+        );
+    }
+}

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.html

@@ -0,0 +1,29 @@
+<template>
+    <doc-content-layout
+        class="content-type content-type-markdown content-type-docs"
+        breadcrumbs={breadcrumbs}
+        share-title={shareTitle}
+        share-twitter-via={twitterVia}
+        sidebar-header={sidebarHeader}
+        sidebar-value={sidebarValue}
+        sidebar-content={sidebarContent}
+        toc-title={tocTitle}
+        toc-options={tocOptions}
+        toc-aria-level={tocAriaLevel}
+        enable-slot-change="true"
+        languages={languages}
+        language={language}
+        show-footer={enableFooter}
+        show-content-action-toolbar={showContentActionToolbar}
+        origin={origin}
+        dev-center={devCenter}
+        brand={brand}
+    >
+        <doc-phase
+            slot="doc-phase"
+            lwc:if={docPhaseInfo}
+            doc-phase-info={docPhaseInfo}
+        ></doc-phase>
+        <slot></slot>
+    </doc-content-layout>
+</template>

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.ts

@@ -0,0 +1,94 @@
+import { LightningElement, api } from "lwc";
+import { toJson } from "dxUtils/normalizers";
+import type { OptionWithLink, TreeNode } from "typings/custom";
+
+/**
+ * Per-topic type emitted by the docs content-type parser
+ * (see @salesforcedevs/sfdocs-doc-framework: `TopicTypeEnum`). Only `spec`
+ * is meaningful inside this component; everything else renders as a plain
+ * markdown-style tile.
+ */
+const TOPIC_TYPE_SPEC = "spec";
+
+/**
+ * Translates per-topic `topicType` into the generic `showForwardArrow` flag
+ * that `dx-tree-tile` reads (spec topics get the forward arrow icon for Redoc).
+ */
+function decorateTopicsWithForwardArrow(
+    topics:
+        | Array<TreeNode & { topicType?: string; versions?: unknown }>
+        | undefined
+): TreeNode[] | undefined {
+    return topics?.map((topic) => {
+        const { topicType, versions, ...decorated } = topic;
+        if (topicType === TOPIC_TYPE_SPEC) {
+            decorated.showForwardArrow = true;
+            // Nested and standalone specs never get a sidebar picker; only the
+            // parent MD topic (when versioned) shows one.
+        } else if (versions) {
+            decorated.versions = versions;
+        }
+        if (decorated.children) {
+            decorated.children = decorateTopicsWithForwardArrow(
+                decorated.children
+            );
+        }
+        return decorated;
+    });
+}
+
+/**
+ * Wrapper around `doc-content-layout` for the "docs" content type emitted by
+ * the `DocsContentTypeParser`.
+ */
+export default class UnifiedContentLayout extends LightningElement {
+    @api breadcrumbs: string | null = null;
+    @api sidebarHeader?: string;
+    @api sidebarValue?: string;
+    @api tocTitle?: string;
+    @api tocOptions?: string;
+    @api tocAriaLevel?: string;
+    @api languages?: OptionWithLink[];
+    @api language?: string;
+    @api devCenter: any = null;
+    @api brand: any = null;
+    @api showContentActionToolbar = false;
+
+    /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). */
+    @api origin: string | null = null;
+
+    /** Article name from breadcrumbs, used as share title (e.g. for social share). */
+    @api shareTitle: string | null = null;
+
+    /** Optional Twitter "via" handle (e.g. SalesforceDevs) for social share. */
+    @api twitterVia: string | null = null;
+
+    @api hideFooter = false;
+
+    private _docPhaseInfo: string | null = null;
+    private _sidebarContent: unknown = null;
+
+    @api
+    get docPhaseInfo(): string | null {
+        return this._docPhaseInfo;
+    }
+
+    set docPhaseInfo(value: string | null) {
+        this._docPhaseInfo = value || null;
+    }
+
+    @api
+    get sidebarContent(): unknown {
+        return this._sidebarContent;
+    }
+
+    set sidebarContent(value: string) {
+        this._sidebarContent = decorateTopicsWithForwardArrow(
+            toJson(value)?.topics
+        );
+    }
+
+    private get enableFooter(): boolean {
+        return !this.hideFooter;
+    }
+}

package/src/modules/doc/versionPicker/versionPicker.css

@@ -4,26 +4,59 @@
 :host {
     --dx-c-dropdown-option-font-weight: normal;
     --dx-c-dropdown-option-label-color: var(--dx-g-gray-10);
+    --dx-c-dropdown-option-padding: var(--dx-g-spacing-sm)
+        var(--dx-g-spacing-lg);
+    --dx-c-popover-padding: var(--dx-g-spacing-sm) 0;
     --popover-container-open-transform: translateY(4px);
 }
 
+/* Open menus must stack above later sibling pickers in the sidebar. */
+:host(:has([aria-expanded="true"])) {
+    position: relative;
+    z-index: 2;
+}
+
 .version-picker-container {
-    padding: 8px var(--dx-g-spacing-lg) 8px
-        var(--dx-g-global-header-padding-horizontal);
-    border-top: 1px solid var(--dx-g-gray-90);
-    border-bottom: 1px solid var(--dx-g-gray-90);
+    /* Override --doc-version-picker-padding to change the inset (e.g. when the
+       picker sits inside an already-padded container). */
+    padding: var(
+        --doc-version-picker-padding,
+        var(--dx-g-spacing-sm) var(--dx-g-spacing-lg) var(--dx-g-spacing-sm)
+            var(--dx-g-global-header-padding-horizontal)
+    );
+
+    /* Override --doc-version-picker-divider (e.g. `none`) to restyle dividers. */
+    border-top: var(
+        --doc-version-picker-divider,
+        1px solid var(--dx-g-gray-90)
+    );
+    border-bottom: var(
+        --doc-version-picker-divider,
+        1px solid var(--dx-g-gray-90)
+    );
+}
+
+/* Inline sidebar variant: drop the header-slot chrome so the picker sits
+   beside a tree node without extra padding or divider lines. */
+.version-picker-container-small {
+    display: flex;
+    align-items: center;
+    padding: 0;
+    border: none;
 }
 
 .version-picker-button {
     display: flex;
     width: var(--doc-version-picker-width, 296px);
+
+    --dx-c-button-horizontal-spacing: var(--dx-g-spacing-sm);
+    --dx-g-button-icon-color: var(--dx-g-gray-50);
 }
 
 .version-picker-button:hover,
-.version-picker-button:active,
-.version-picker-button:focus {
-    --dx-c-button-secondary-color-hover: var(--dx-g-cloud-blue-vibrant-95);
-    --dx-c-button-primary-color: var(--dx-g-blue-vibrant-40);
+.version-picker-button:focus-within,
+.version-picker-button[aria-expanded="true"] {
+    --dx-g-button-icon-color: var(--dx-g-blue-vibrant-20);
 }
 
 /**
@@ -35,6 +68,27 @@ dx-button::part(content) {
     overflow: hidden;
 }
 
+/* The border is an inset box-shadow so thickening it on hover/focus doesn't
+   resize the small variant's fit-content box. */
+.version-picker-button::part(container) {
+    background: white;
+    box-shadow: inset 0 0 0 1px var(--dx-g-gray-50);
+    color: var(--dx-g-gray-10);
+}
+
+.version-picker-button::part(container):hover {
+    background: var(--dx-g-blue-vibrant-95);
+    box-shadow: inset 0 0 0 2px var(--dx-g-blue-vibrant-20);
+}
+
+/* aria-expanded keeps the focus ring while the menu is open. */
+.version-picker-button:focus-within::part(container),
+.version-picker-button[aria-expanded="true"]::part(container) {
+    background: var(--dx-g-blue-vibrant-95);
+    box-shadow: inset 0 0 0 2px var(--dx-g-blue-vibrant-20), 0 0 0 2px white,
+        0 0 0 4px var(--dx-g-blue-vibrant-60);
+}
+
 .selected-version {
     display: flex;
     flex-direction: row;
@@ -49,16 +103,100 @@ dx-button::part(content) {
     white-space: nowrap;
 }
 
-dx-type-badge.latest-badge {
-    --dx-c-type-badge-color: var(--dx-g-green-vibrant-40);
-    --dx-c-type-badge-background: var(--dx-g-green-vibrant-95);
-
+dx-type-badge.latest-badge,
+dx-type-badge.not-latest-badge {
     margin-left: var(--dx-g-spacing-sm);
 }
 
-dx-type-badge.not-latest-badge {
-    --dx-c-type-badge-color: var(--dx-g-red-vibrant-40);
-    --dx-c-type-badge-background: var(--dx-g-red-vibrant-95);
+/* ------------------------------------------------------------------ *
+ * Small "dot" variant (opt-in via `small`). Additive 
+ * ------------------------------------------------------------------ */
 
-    margin-left: var(--dx-g-spacing-sm);
+/* Option padding is sm both axes: the small menu tracks the ~104px trigger, so
+   the default 24px horizontal would crowd the labels. */
+.version-picker-dropdown-small {
+    --dx-c-dropdown-option-font-size: var(--dx-g-text-xs);
+    --dx-c-dropdown-option-padding: var(--dx-g-spacing-sm)
+        var(--dx-g-spacing-sm);
+    --dx-c-dropdown-option-border-radius: 0;
+    --dx-c-popover-border: none;
+}
+
+.version-picker-button-small {
+    width: fit-content;
+    max-width: 104px;
+
+    --dx-c-button-font-size: var(--dx-g-text-xs);
+    --dx-c-button-font-weight: var(--dx-g-font-normal);
+    --dx-c-button-line-height: var(--dx-g-spacing-lg);
+    --dx-c-button-icon-gap: var(--dx-g-spacing-2xs);
+}
+
+/* min-width: 0 on each flex ancestor lets the label truncate: a flex item's
+   default min-width: auto refuses to shrink below its content and overrides the
+   host's max-width, so without this the trigger overflows instead. */
+.version-picker-button-small::part(content) {
+    display: flex;
+    flex: 1;
+    min-width: 0;
+    width: auto;
+    overflow: hidden;
+}
+
+/* width:100% re-ties to the 104px-capped host (container is width:inherit,
+   which copies width but not max-width). Border/bg/states are shared above. */
+.version-picker-button-small::part(container) {
+    width: 100%;
+    height: var(--dx-g-spacing-lg);
+    padding: 0 var(--dx-g-spacing-xs);
+}
+
+.selected-version-small {
+    flex: 1;
+    min-width: 0;
+}
+
+.version-picker-dot {
+    flex: 0 0 auto;
+    width: var(--dx-g-spacing-sm);
+    height: var(--dx-g-spacing-sm);
+    margin-right: var(--dx-g-spacing-xs);
+    border-radius: 50%;
+}
+
+.version-picker-dot-latest {
+    background: var(--dx-g-green-vibrant-60);
+}
+
+.version-picker-dot-not-latest {
+    background: var(--dx-g-yellow-vibrant-80);
+}
+
+/* inline-block (not flex) so the label can truncate; line-height centers it. */
+.version-picker-readonly {
+    box-sizing: border-box;
+    display: inline-block;
+    width: var(--doc-version-picker-width, 296px);
+    height: var(--dx-g-spacing-xl);
+    margin: 0;
+    padding: 0 var(--dx-g-spacing-sm);
+    border: 1px solid var(--dx-g-gray-80);
+    border-radius: var(--dx-g-spacing-xs);
+    overflow: hidden;
+    color: var(--dx-g-gray-10);
+    text-overflow: ellipsis;
+    white-space: nowrap;
+    font: var(--dx-g-font-normal) var(--dx-g-text-sm) / var(--dx-g-spacing-xl)
+            var(--dx-g-font-sans),
+        sans-serif;
+}
+
+.version-picker-readonly-small {
+    width: fit-content;
+    max-width: 104px;
+    height: var(--dx-g-spacing-lg);
+    padding: 0 var(--dx-g-spacing-xs);
+    font: var(--dx-g-font-normal) var(--dx-g-text-xs) / var(--dx-g-spacing-lg)
+            var(--dx-g-font-sans),
+        sans-serif;
 }

package/src/modules/doc/versionPicker/versionPicker.html

@@ -1,37 +1,70 @@
 <template>
-    <div lwc:if={showVersionPicker} class="version-picker-container">
+    <div lwc:if={showVersionPicker} class={containerClass}>
+        <!-- Small read-only: plain value, no dropdown -->
+        <p
+            lwc:if={readOnly}
+            class={readOnlyClass}
+            title={selectedVersion.label}
+        >
+            {selectedVersion.label}
+        </p>
+
         <dx-dropdown
+            lwc:else
+            class={dropdownClass}
             options={versions}
             analytics-event="custEv_docVersionSelect"
             analytics-payload={analyticsPayload}
             value={selectedVersion.id}
-            width="var(--doc-version-picker-width)"
+            full-width="true"
             onchange={onVersionChange}
         >
             <dx-button
-                class="version-picker-button"
+                class={triggerClass}
                 variant="tertiary"
                 size="small"
+                font="sans"
                 icon-symbol="chevrondown"
-                icon-size="medium"
+                icon-size={triggerIconSize}
+                aria-label={triggerAriaLabel}
             >
-                <div class="selected-version">
-                    <p class="selected-version-label">
-                        {selectedVersion.label}
-                    </p>
-                    <template lwc:if={showLatestTag}>
-                        <dx-type-badge
-                            class="latest-badge"
-                            lwc:if={latestVersion}
-                            value="Latest"
-                            size="small"
-                        ></dx-type-badge>
-                        <dx-type-badge
-                            class="not-latest-badge"
-                            lwc:else
-                            value="Not Latest"
-                            size="small"
-                        ></dx-type-badge>
+                <div class={selectedVersionClass}>
+                    <!-- Small: leading colored dot -->
+                    <template lwc:if={small}>
+                        <template lwc:if={showLatestTag}>
+                            <span class={dotClass} aria-hidden="true"></span>
+                        </template>
+                        <p
+                            class="selected-version-label"
+                            title={selectedVersion.label}
+                        >
+                            {selectedVersion.label}
+                        </p>
+                    </template>
+                    <!-- Default: trailing Latest/Not-Latest badge -->
+                    <template lwc:else>
+                        <p
+                            class="selected-version-label"
+                            title={selectedVersion.label}
+                        >
+                            {selectedVersion.label}
+                        </p>
+                        <template lwc:if={showLatestTag}>
+                            <dx-type-badge
+                                class="latest-badge"
+                                lwc:if={latestVersion}
+                                variant="status-success"
+                                value="Latest"
+                                size="small"
+                            ></dx-type-badge>
+                            <dx-type-badge
+                                class="not-latest-badge"
+                                lwc:else
+                                variant="status-warning"
+                                value="Not Latest"
+                                size="small"
+                            ></dx-type-badge>
+                        </template>
                     </template>
                 </div>
             </dx-button>

package/src/modules/doc/versionPicker/versionPicker.ts

@@ -1,4 +1,5 @@
 import { LightningElement, api, track } from "lwc";
+import cx from "classnames";
 
 import { AnalyticsPayload, OptionWithNested } from "typings/custom";
 
@@ -12,6 +13,8 @@ export default class VersionPicker extends LightningElement {
     private _selectedVersion?: OptionWithNested;
     private _latestVersion: boolean = false;
     private _hideBadge: boolean = false;
+    private _small: boolean = false;
+    private _readOnly: boolean = false;
 
     @api
     get versions() {
@@ -51,14 +54,97 @@ export default class VersionPicker extends LightningElement {
         this._hideBadge = normalizeBoolean(value);
     }
 
+    // Opt-in compact "dot" variant (24px, abbreviated label). Off by default so
+    // existing consumers render the default trigger unchanged.
+    @api
+    get small() {
+        return this._small;
+    }
+
+    set small(value) {
+        this._small = normalizeBoolean(value);
+    }
+
+    // Opt-in read-only state: plain value, no dropdown menu.
+    @api
+    get readOnly() {
+        return this._readOnly;
+    }
+
+    set readOnly(value) {
+        this._readOnly = normalizeBoolean(value);
+    }
+
     private get showVersionPicker() {
         return this._versions && this._versions.length !== 0;
     }
 
+    private get containerClass(): string {
+        return this.small
+            ? "version-picker-container-small"
+            : "version-picker-container";
+    }
+
     private get showLatestTag(): boolean {
         return !this.hideBadge;
     }
 
+    private get readOnlyClass(): string {
+        return cx(
+            "version-picker-readonly",
+            this.small && "version-picker-readonly-small"
+        );
+    }
+
+    private get dotClass(): string {
+        return `version-picker-dot ${
+            this.latestVersion
+                ? "version-picker-dot-latest"
+                : "version-picker-dot-not-latest"
+        }`;
+    }
+
+    // Accessible name for the small trigger: includes the latest state so it
+    // isn't conveyed by the dot's color alone (WCAG 1.4.1). Omits the state
+    // when the indicator is hidden.
+    private get smallTriggerAriaLabel(): string {
+        const label = this.selectedVersion?.label ?? "";
+        if (!this.showLatestTag) {
+            return label;
+        }
+        return `${label}, ${this.latestVersion ? "Latest" : "Not Latest"}`;
+    }
+
+    // --- Per-variant values for the shared dropdown/button markup below. The
+    // small variant opts into extra classes and a compact chevron.
+
+    // Not cx(): the default must have NO class attribute (cx returns "", which
+    // would render class="" and break the frozen consumer snapshots).
+    private get dropdownClass(): string | undefined {
+        return this.small ? "version-picker-dropdown-small" : undefined;
+    }
+
+    private get triggerClass(): string {
+        return cx(
+            "version-picker-button",
+            this.small && "version-picker-button-small"
+        );
+    }
+
+    private get triggerIconSize(): string {
+        return this.small ? "xsmall" : "medium";
+    }
+
+    // Default returns "" (dx-button's own default) so the trigger's rendered
+    // aria-label is unchanged for the default variant.
+    private get triggerAriaLabel(): string {
+        return this.small ? this.smallTriggerAriaLabel : "";
+    }
+
+    private get selectedVersionClass(): string {
+        return cx("selected-version", this.small && "selected-version-small");
+    }
+
     private onVersionChange(e: CustomEvent) {
         this.dispatchEvent(new CustomEvent("change", { detail: e.detail }));
     }

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.