@salesforcedevs/docs-components 1.34.0 → 1.35.0-ver-picker-1

package/package.json

@@ -1,29 +1,30 @@
 {
-    "name": "@salesforcedevs/docs-components",
-    "version": "1.34.0",
-    "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": "db75cd19dd7a77fe4e09856439c4905c32e64d1f"
-}
+  "name": "@salesforcedevs/docs-components",
+  "version": "1.35.0-ver-picker-1",
+  "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",
+  "stableVersion": "1.34.0"
+}

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

@@ -62,3 +62,117 @@ dx-type-badge.not-latest-badge {
 
     margin-left: var(--dx-g-spacing-sm);
 }
+
+/* ------------------------------------------------------------------ *
+ * Small "dot" variant (opt-in via `small`). Additive 
+ * ------------------------------------------------------------------ */
+
+/* Scoped hooks so the shared dx-popover/dx-dropdown-option keep their defaults. */
+.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-lg);
+    --dx-c-dropdown-option-border-radius: 0;
+    --dx-c-popover-border: none;
+    --dx-c-popover-padding: var(--dx-g-spacing-sm) 0;
+}
+
+.version-picker-button-small {
+    display: flex;
+    width: fit-content;
+    max-width: 104px;
+    border-radius: var(--dx-g-spacing-xs);
+
+    --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: 18px;
+    --dx-g-button-icon-color: var(--dx-g-gray-50);
+    --dx-g-spacing-sm: 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;
+}
+
+/* Border is an inset box-shadow, not a real border, so thickening it on
+   hover/focus doesn't widen the fit-content box (no horizontal shift). */
+.version-picker-button-small::part(container) {
+    box-sizing: border-box;
+
+    /* width:100% re-ties to the 104px-capped host (container is width:inherit,
+       which copies width but not max-width). */
+    width: 100%;
+    height: 24px;
+    padding: 0 var(--dx-g-spacing-xs);
+    border-radius: var(--dx-g-spacing-xs);
+    background: #fff;
+    box-shadow: inset 0 0 0 1px var(--dx-g-gray-50);
+    color: var(--dx-g-gray-10);
+}
+
+.version-picker-button-small::part(container):hover {
+    background: var(--dx-g-blue-vibrant-95);
+    box-shadow: inset 0 0 0 2px var(--dx-g-blue-vibrant-20);
+}
+
+.version-picker-button-small:hover,
+.version-picker-button-small:focus-within,
+.version-picker-button-small[aria-expanded="true"] {
+    --dx-g-button-icon-color: var(--dx-g-blue-vibrant-20);
+}
+
+/* Also matches aria-expanded so the ring stays while the menu is open (opening
+   moves focus into the menu, which would otherwise drop :focus-within). */
+.version-picker-button-small:focus-within::part(container),
+.version-picker-button-small[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 #fff,
+        0 0 0 4px var(--dx-g-blue-vibrant-60);
+}
+
+.selected-version-small {
+    flex: 1;
+    min-width: 0;
+}
+
+.version-picker-dot {
+    flex: 0 0 auto;
+    width: 8px;
+    height: 8px;
+    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);
+}
+
+.version-picker-readonly-small {
+    display: inline-flex;
+    align-items: center;
+    box-sizing: border-box;
+    width: fit-content;
+    max-width: 104px;
+    height: 24px;
+    margin: 0;
+    padding: 0 var(--dx-g-spacing-xs);
+    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-xs) / 18px
+        var(--dx-g-font-sans), sans-serif;
+}

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

@@ -1,6 +1,43 @@
 <template>
     <div lwc:if={showVersionPicker} class="version-picker-container">
+        <!-- Small read-only: plain value, no dropdown -->
+        <p lwc:if={readOnly} class="version-picker-readonly-small">
+            {selectedVersion.label}
+        </p>
+
+        <!-- Small "dot" variant -->
         <dx-dropdown
+            lwc:elseif={small}
+            class="version-picker-dropdown-small"
+            options={versions}
+            analytics-event="custEv_docVersionSelect"
+            analytics-payload={analyticsPayload}
+            value={selectedVersion.id}
+            onchange={onVersionChange}
+        >
+            <dx-button
+                class="version-picker-button version-picker-button-small"
+                variant="tertiary"
+                size="small"
+                font="sans"
+                icon-symbol="chevrondown"
+                icon-size="xsmall"
+                aria-label={smallTriggerAriaLabel}
+            >
+                <div class="selected-version selected-version-small">
+                    <template lwc:if={showLatestTag}>
+                        <span class={dotClass} aria-hidden="true"></span>
+                    </template>
+                    <p class="selected-version-label">
+                        {selectedVersion.label}
+                    </p>
+                </div>
+            </dx-button>
+        </dx-dropdown>
+
+        <!-- Default (existing) -->
+        <dx-dropdown
+            lwc:else
             options={versions}
             analytics-event="custEv_docVersionSelect"
             analytics-payload={analyticsPayload}

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

@@ -12,6 +12,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,6 +53,27 @@ 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;
     }
@@ -59,6 +82,25 @@ export default class VersionPicker extends LightningElement {
         return !this.hideBadge;
     }
 
+    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"}`;
+    }
+
     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.