@salesforcedevs/docs-components 1.3.194-search2-alpha → 1.3.196-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.194-search2-alpha",
+    "version": "1.3.196-alpha.10",
     "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.updateTags(selectedItemMetaData.navTitle);
+                    this.updateNavTitleMetaTag(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.updateTags(referenceDetails.topicTitle);
+                this.updateNavTitleMetaTag(referenceDetails.topicTitle);
             }
 
             this.versions = this.getVersions();
@@ -1304,67 +1311,22 @@ export default class AmfReference extends LightningElement {
         this.showVersionBanner = false;
     }
 
-    private updateTags(navTitle = ""): void {
-        if (!navTitle) {
-            return;
-        }
-
+    private updateNavTitleMetaTag(navTitle = ""): void {
         // 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"]');
-        // eslint-disable-next-line @lwc/lwc/no-document-query
-        const titleTag = document.querySelector("title");
-        const TITLE_SEPARATOR = " | ";
-
-        if (metaNavTitle) {
+        if (metaNavTitle && navTitle) {
             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>.
-         * Example: Following is a sample project structure.
-         * - Project Name
-         *  - Ref Spec1
-         *      - Summary
-         *      - Endpoints
-         *          - E1
-         *          - E2
-         *  - Ref Spec2
-         *      - Summary
-         *      - Endpoints
-         *          - E1 (Selected)
-         *          - E2
-         * Previous Title: Ref Spec2 | Project Name | Salesforce Developer
-         * New Title: E1 | Ref Spec2 | Project Name | Salesforce Developer
-         *
-         */
-        if (titleTag) {
-            let titleTagValue = titleTag.textContent;
-            const titleTagSectionValues: string[] =
-                titleTagValue?.split(TITLE_SEPARATOR);
-            if (titleTagSectionValues) {
-                if (titleTagSectionValues.length <= 3) {
-                    titleTagValue = navTitle + TITLE_SEPARATOR + titleTagValue;
-                } else {
-                    titleTagSectionValues[0] = navTitle;
-                    titleTagValue = titleTagSectionValues.join(TITLE_SEPARATOR);
-                }
-            }
-            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
@@ -1399,7 +1361,7 @@ export default class AmfReference extends LightningElement {
                         this.coveoAnalyticsToken
                     );
                     this.updateUrlWithSelected(parentReferencePath, metaVal);
-                    this.updateTags(metadata.navTitle);
+                    this.updateNavTitleMetaTag(metadata.navTitle);
                 } else {
                     if (this.isParentReferencePath(name)) {
                         this.loadNewReferenceItem(name);
@@ -1419,8 +1381,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/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,9 +259,8 @@ 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 = `${
@@ -323,14 +322,17 @@ 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
@@ -390,9 +392,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