@salesforcedevs/docs-components 1.3.194-docfooter8-alpha → 1.3.194-search1-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.194-docfooter8-alpha",
+    "version": "1.3.194-search1-alpha",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",

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

@@ -185,10 +185,12 @@ export default class AmfReference extends LightningElement {
     constructor() {
         super();
 
-        this._boundOnApiNavigationChanged =
-            this.onApiNavigationChanged.bind(this);
-        this._boundUpdateSelectedItemFromUrlQuery =
-            this.updateSelectedItemFromUrlQuery.bind(this);
+        this._boundOnApiNavigationChanged = this.onApiNavigationChanged.bind(
+            this
+        );
+        this._boundUpdateSelectedItemFromUrlQuery = this.updateSelectedItemFromUrlQuery.bind(
+            this
+        );
     }
 
     connectedCallback(): void {
@@ -244,8 +246,9 @@ export default class AmfReference extends LightningElement {
                 const updatedReferenceId =
                     oldReferenceIdNewReferenceIdMap[referenceId];
                 const newReferenceId = updatedReferenceId || referenceId;
-                const referenceItemConfig =
-                    this.getAmfConfigWithId(newReferenceId);
+                const referenceItemConfig = this.getAmfConfigWithId(
+                    newReferenceId
+                );
                 if (referenceItemConfig) {
                     hashBasedRedirectUrl = `${referenceItemConfig.href}?meta=${encodedMeta}`;
                 }
@@ -325,8 +328,9 @@ export default class AmfReference extends LightningElement {
                 for (let i = 0; i < allVersions.length; i++) {
                     const versionItem = allVersions[i];
                     const referenceLink = versionItem.link.href;
-                    const referenceId =
-                        this.getReferenceIdFromUrl(referenceLink);
+                    const referenceId = this.getReferenceIdFromUrl(
+                        referenceLink
+                    );
                     if (this._currentReferenceId === referenceId) {
                         // This is to navigate to respective topic in the changed version
                         versionItem.link.href = `${referenceLink}/${currentRefMeta}`;
@@ -840,8 +844,9 @@ export default class AmfReference extends LightningElement {
             this._currentReferenceId
         );
         if (specBasedReference) {
-            const currentMeta: RouteMeta | undefined =
-                this.getReferenceMetaInfo(window.location.href);
+            const currentMeta:
+                | RouteMeta
+                | undefined = this.getReferenceMetaInfo(window.location.href);
             const metadata =
                 currentMeta && this.getMetadataByUrlQuery(currentMeta);
             if (metadata) {
@@ -1161,7 +1166,7 @@ export default class AmfReference extends LightningElement {
                         selectedItemMetaData.parentReferencePath,
                         selectedItemMetaData.meta
                     );
-                    this.updateNavTitleMetaTag(selectedItemMetaData.navTitle);
+                    this.updateTags(selectedItemMetaData.navTitle);
                 }
             });
         } else {
@@ -1267,16 +1272,18 @@ export default class AmfReference extends LightningElement {
         }
         if (!isRedirecting) {
             const currentReferenceUrl = window.location.href;
-            const referenceMeta =
-                this.getMarkdownReferenceMeta(currentReferenceUrl);
-            const selectedItemRefId =
-                this.getReferenceIdFromUrl(currentReferenceUrl);
+            const referenceMeta = this.getMarkdownReferenceMeta(
+                currentReferenceUrl
+            );
+            const selectedItemRefId = this.getReferenceIdFromUrl(
+                currentReferenceUrl
+            );
             const referenceDetails = this.getRefDetailsForGivenTopicMeta(
                 selectedItemRefId,
                 referenceMeta
             );
             if (referenceDetails) {
-                this.updateNavTitleMetaTag(referenceDetails.topicTitle);
+                this.updateTags(referenceDetails.topicTitle);
             }
 
             this.versions = this.getVersions();
@@ -1304,21 +1311,50 @@ export default class AmfReference extends LightningElement {
         this.showVersionBanner = false;
     }
 
-    private updateNavTitleMetaTag(navTitle = ""): void {
+    private updateTags(navTitle = ""): void {
+        if (!navTitle) {
+            return;
+        }
+
         // this is required to update the nav title meta tag.
         // eslint-disable-next-line @lwc/lwc/no-document-query
         const metaNavTitle = document.querySelector('meta[name="nav-title"]');
-        if (metaNavTitle && navTitle) {
+        // eslint-disable-next-line @lwc/lwc/no-document-query
+        const titleTag = document.querySelector("title");
+        if (metaNavTitle) {
             metaNavTitle.setAttribute("content", navTitle);
         }
+
+        /**
+         * Right now, the title tag only changes when you pick a Ref spec,
+         * not every time you choose a subsection of the Ref spec.
+         * This update aims to refresh the title tag with each selection.
+         * If a Ref spec is chosen, we add the value of the <selected topic> to the title.
+         * If a subsection is selected, we update the first part of the current
+         * title with the new <selected topic>.
+         */
+        if (titleTag) {
+            let titleTagValue = titleTag.textContent;
+            const titleTagSectionValues: string[] = titleTagValue?.split(" | ");
+            if (titleTagSectionValues) {
+                if (titleTagSectionValues.length <= 3) {
+                    titleTagValue = navTitle + " | " + titleTagValue;
+                } else {
+                    titleTagSectionValues[0] = navTitle;
+                    titleTagValue = titleTagSectionValues.join(" | ");
+                }
+            }
+            titleTag.textContent = titleTagValue;
+        }
     }
 
     onNavSelect(event: CustomEvent): void {
         const name = event.detail.name;
         if (name) {
             const urlReferenceId = this.getReferenceIdFromUrl(name);
-            const specBasedReference =
-                this.isSpecBasedReference(urlReferenceId);
+            const specBasedReference = this.isSpecBasedReference(
+                urlReferenceId
+            );
             if (specBasedReference) {
                 const metaVal = this.getMetaFromUrl(name);
                 const currentSelectedMeta = this.selectedTopic
@@ -1353,7 +1389,7 @@ export default class AmfReference extends LightningElement {
                         this.coveoAnalyticsToken
                     );
                     this.updateUrlWithSelected(parentReferencePath, metaVal);
-                    this.updateNavTitleMetaTag(metadata.navTitle);
+                    this.updateTags(metadata.navTitle);
                 } else {
                     if (this.isParentReferencePath(name)) {
                         this.loadNewReferenceItem(name);
@@ -1373,8 +1409,9 @@ export default class AmfReference extends LightningElement {
             const currentReferenceId = this.getReferenceIdFromUrl(currentUrl);
             //No need to do anything if user is expanding currently selected reference
             if (referenceId !== currentReferenceId) {
-                const isSpecBasedReference =
-                    this.isSpecBasedReference(referenceId);
+                const isSpecBasedReference = this.isSpecBasedReference(
+                    referenceId
+                );
                 if (isSpecBasedReference) {
                     // Perform functionality same as item selection
                     this.onNavSelect(event);

package/src/modules/doc/content/content.css

@@ -106,7 +106,7 @@ h6 {
 }
 
 img {
-    image-rendering: -webkit-optimize-contrast;
+    image-rendering: optimize-contrast;
 }
 
 p,

package/src/modules/doc/contentLayout/contentLayout.css

@@ -61,10 +61,8 @@ dx-toc {
     flex-direction: row;
     justify-content: center;
     max-width: var(--dx-g-doc-content-max-width);
-    min-height: 100vh;
     margin: auto;
     padding: 0 var(--dx-g-global-header-padding-horizontal);
-    margin-bottom: calc(2 * (var(--dx-g-spacing-5xl) + 4px));
 }
 
 .content-body {
@@ -108,7 +106,6 @@ dx-toc {
     .content-body-container {
         padding-right: 0;
         overflow-x: auto;
-        margin-bottom: calc(var(--dx-g-spacing-5xl) + 4px);
     }
 
     .left-nav-bar {

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

@@ -48,9 +48,6 @@
                     ></dx-toc>
                 </div>
             </div>
-            <div class="footer-container">
-                <dx-footer variant="no-signup"></dx-footer>
-            </div>
         </div>
     </div>
 </template>

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

@@ -207,9 +207,9 @@ export default class ContentLayout extends LightningElement {
             ".sticky-doc-header"
         ) as HTMLElement;
 
-        const docPhaseEl = (
-            this.template.querySelector("[name=doc-phase]")! as any
-        ).assignedElements()[0] as HTMLSlotElement;
+        const docPhaseEl = (this.template.querySelector(
+            "[name=doc-phase]"
+        )! as any).assignedElements()[0] as HTMLSlotElement;
 
         if (!sidebarEl || !globalNavEl || !contextNavEl || !docHeaderEl) {
             console.warn("One or more required elements are missing.");
@@ -259,8 +259,9 @@ export default class ContentLayout extends LightningElement {
                 });
 
                 // Adjust right nav bar position when doc phase is present
-                const rightNavBarEl =
-                    this.template.querySelector(".right-nav-bar");
+                const rightNavBarEl = this.template.querySelector(
+                    ".right-nav-bar"
+                );
 
                 if (rightNavBarEl) {
                     rightNavBarEl.style.top = `${
@@ -322,17 +323,14 @@ export default class ContentLayout extends LightningElement {
     };
 
     onSlotChange(event: Event): void {
-        const slotElements = (
-            event.target as HTMLSlotElement
-        ).assignedElements();
+        const slotElements = (event.target as HTMLSlotElement).assignedElements();
 
         if (slotElements.length) {
             this.contentLoaded = true;
             const slotContentElement = slotElements[0];
-            const headingElements =
-                slotContentElement.ownerDocument?.getElementsByTagName(
-                    TOC_HEADER_TAG
-                );
+            const headingElements = slotContentElement.ownerDocument?.getElementsByTagName(
+                TOC_HEADER_TAG
+            );
 
             for (const headingElement of headingElements as any) {
                 // Sometimes elements hash is not being set when slot content is wrapped with div
@@ -392,9 +390,9 @@ export default class ContentLayout extends LightningElement {
                 globalNavEl?.offsetHeight +
                 contextNavEl?.offsetHeight;
 
-            const docPhaseEl = (
-                this.template.querySelector("[name=doc-phase]")! as any
-            ).assignedElements()[0] as HTMLSlotElement;
+            const docPhaseEl = (this.template.querySelector(
+                "[name=doc-phase]"
+            )! as any).assignedElements()[0] as HTMLSlotElement;
 
             const offset = docPhaseEl
                 ? headerHeight + docPhaseEl.offsetHeight

package/src/modules/doc/header/header.css

@@ -2,14 +2,11 @@
 
 dx-logo {
     min-width: fit-content;
-    min-width: -moz-fit-content;
 }
 
 .header_l2 {
     justify-content: space-between;
     height: var(--dx-g-doc-header-main-nav-height);
-    padding-bottom: var(--dx-g-spacing-xs);
-    background: white;
 }
 
 .nav_menu-button {
@@ -19,24 +16,16 @@ dx-logo {
     );
 }
 
-.has-brand.has-scoped-nav-items {
-    border-bottom: 1px solid var(--dx-g-gray-90);
-    border-top: 1px solid var(--dx-g-gray-90);
-}
-
 .nav_menu-ctas {
     margin-right: var(--dx-g-spacing-sm);
 }
 
 header:not(.has-brand) > .header_l1 {
-    background: white;
-    border-bottom: 1px solid var(--dx-g-gray-90);
+    background: var(--dx-g-brand-current-color-background);
 }
 
 header:not(.has-brand) > .header_l2 {
-    border-bottom: 1px solid var(--dx-g-gray-90);
-    border-top: 1px solid var(--dx-g-gray-90);
-    padding-bottom: var(--dx-g-spacing-lg);
+    background: var(--dx-g-brand-current-color-background-2);
 }
 
 .header_l2_group.header_l2_group-right-ctas {
@@ -67,10 +56,6 @@ header:not(.has-brand) > .header_l2 {
     --border-color: var(--button-primary-color-hover);
 }
 
-.has-brand .header_l2_group-title {
-    padding-bottom: calc(var(--dx-g-spacing-md) + 2px);
-}
-
 @media (max-width: 768px) {
     .header_l2 {
         padding: 0;
@@ -97,10 +82,6 @@ header:not(.has-brand) > .header_l2 {
         margin-right: var(--dx-g-spacing-sm);
     }
 
-    .has-brand .header_l2_group-title {
-        padding-bottom: var(--dx-g-spacing-smd);
-    }
-
     .header_l2_group-title {
         margin-right: 0;
         padding: var(--dx-g-spacing-smd)
@@ -121,10 +102,6 @@ header:not(.has-brand) > .header_l2 {
     }
 
     .has-scoped-nav-items .header_l2_group-title {
-        border-bottom: 1px solid var(--dx-g-gray-90);
-    }
-
-    header:not(.has-brand) > .header_l2 {
-        padding-bottom: 0;
+        border-bottom: 1px solid var(--dx-g-brand-current-color-border-2);
     }
 }

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

@@ -14,9 +14,9 @@
                                 if:true={isValidBrand}
                                 sprite="salesforcebrand"
                                 symbol={brand}
-                                size="large"
+                                size="xlarge"
                             ></dx-icon>
-                            <span class="subtitle dx-text-display-7">
+                            <span class="subtitle dx-text-display-6">
                                 {subtitle}
                             </span>
                         </a>

package/src/modules/doc/headingAnchor/headingAnchor.css

@@ -2,7 +2,7 @@
 
 button {
     opacity: 0;
-    color: rgb(11, 92, 171);
+    color: rgb(11 92 171);
 }
 
 button:hover {
@@ -17,7 +17,7 @@ button:focus {
 
 button:focus-visible {
     border-radius: 4px;
-    border: 2px solid rgb(11, 92, 171);
+    border: 2px solid rgb(11 92 171);
 }
 
 .icon-wrapper {

package/src/modules/doc/headingContent/headingContent.css

@@ -23,7 +23,7 @@ button {
     bottom: var(--doc-c-heading-anchor-button-bottom);
     left: 0;
     opacity: 0;
-    color: rgb(11, 92, 171);
+    color: rgb(11 92 171);
     display: flex;
     justify-content: center;
     align-items: center;

package/src/modules/doc/sprigSurvey/sprigSurvey.scoped.css

@@ -4,7 +4,7 @@
     width: 100%;
     display: flex;
     flex-direction: row;
-    margin: 20px 0 20px 0;
+    margin: 20px 0;
 }
 
 dx-hr:first-of-type::part(hr) {

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

@@ -252,11 +252,14 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     private get coveoAdvancedQueryConfig(): CoveoAdvancedQueryXMLConfig {
-        const config: { locale?: string; topicid?: string; version?: string } =
-            {
-                locale: this.languageId,
-                topicid: this.deliverable
-            };
+        const config: {
+            locale?: string;
+            topicid?: string;
+            version?: string;
+        } = {
+            locale: this.languageId,
+            topicid: this.deliverable
+        };
 
         if (this.releaseVersionId && this.releaseVersionId !== "noversion") {
             config.version = this.releaseVersionId;
@@ -411,8 +414,12 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     getReferenceFromUrl(): PageReference {
-        const [page, docId, deliverable, contentDocumentId] =
-            window.location.pathname.substr(1).split("/");
+        const [
+            page,
+            docId,
+            deliverable,
+            contentDocumentId
+        ] = window.location.pathname.substr(1).split("/");
 
         const { origin: domain, hash, search } = window.location;
 
@@ -574,14 +581,20 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     private updateSearchInput(searchParam: string): void {
-        (
-            this.template.querySelector("doc-content-layout") as any
-        )?.setSidebarInputValue(searchParam);
+        (this.template.querySelector(
+            "doc-content-layout"
+        ) as any)?.setSidebarInputValue(searchParam);
     }
 
     private pageReferenceToString(reference: PageReference): string {
-        const { page, docId, deliverable, contentDocumentId, hash, search } =
-            reference;
+        const {
+            page,
+            docId,
+            deliverable,
+            contentDocumentId,
+            hash,
+            search
+        } = reference;
         return `/${page}/${docId}/${deliverable}/${contentDocumentId}${this.normalizeSearch(
             search!
         )}${this.normalizeHash(hash)}`;

package/src/modules/docHelpers/amfStyle/amfStyle.css

@@ -166,12 +166,12 @@ api-security-documentation {
     --anypoint-button-emphasis-high-active-background-color: transparent;
 
     /* api example */
-    --api-example-accent-color: rgb(250, 250, 250);
-    --api-example-background-color: rgb(250, 250, 250);
+    --api-example-accent-color: rgb(250 250 250);
+    --api-example-background-color: rgb(250 250 250);
     --api-example-title-background-color: transparent;
 
     /* code snippets */
-    --http-code-snippet-container-background-color: rgb(250, 250, 250);
+    --http-code-snippet-container-background-color: rgb(250 250 250);
     --http-code-snippet-container-padding: var(--dx-g-spacing-md);
 
     /* prism */
@@ -208,7 +208,7 @@ api-endpoint-documentation {
     );
 
     /* description */
-    --api-endpoint-documentation-description-color: rgb(24, 24, 24);
+    --api-endpoint-documentation-description-color: rgb(24 24 24);
 }
 
 api-endpoint-documentation,
@@ -271,11 +271,11 @@ api-method-documentation {
     --api-method-documentation-http-method-label-font-weight: var(
         --dx-g-font-bold
     );
-    --api-method-documentation-description-color: rgb(24, 24, 24);
+    --api-method-documentation-description-color: rgb(24 24 24);
     --api-method-documentation-operation-id-color: var(--dx-g-gray-50);
 
     /* body */
-    --api-body-document-description-color: rgb(24, 24, 24);
+    --api-body-document-description-color: rgb(24 24 24);
     --api-body-document-media-type-selector-color: var(--dx-g-blue-vibrant-20);
     --api-body-document-media-type-selector-font-size: var(
         --amf-h8-mod-font-size

package/src/modules/docHelpers/status/status.css

@@ -9,7 +9,7 @@
 }
 
 .doc-status-container {
-    background-color: rgb(254, 243, 217);
+    background-color: rgb(254 243 217);
     border-color: var(--dx-g-yellow-vibrant-80);
 }