@salesforcedevs/docs-components 1.20.0-rnb-scroll-3 → 1.20.2

package/LICENSE

@@ -0,0 +1,12 @@
+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.

package/package.json

@@ -1,16 +1,11 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.20.0-rnb-scroll-3",
+    "version": "1.20.2",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
     "engines": {
-        "node": "20.x",
-        "yarn": "1.22.19"
-    },
-    "volta": {
-        "node": "20.18.2",
-        "yarn": "1.22.19"
+        "node": "20.x"
     },
     "publishConfig": {
         "access": "public"
@@ -30,5 +25,5 @@
         "@types/lodash.orderby": "4.6.9",
         "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
+    "gitHead": "10311f28b3791b85639bde33ade200feb8ccd06d"
 }

package/src/modules/doc/contentCallout/contentCallout.css

@@ -4,6 +4,7 @@
 
 .dx-callout {
     border-radius: 4px;
+    margin: var(--dx-g-spacing-md) 0;
 }
 
 .dx-callout-base,

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

@@ -269,28 +269,13 @@ export default class ContentLayout extends LightningElement {
             });
 
             // Adjusting the right nav bar on scroll.
-            // setting maxheight to make the RNB scrollable based on different parent elements
             if (rightNavBarEl) {
-                const docPhaseElHeight = docPhaseEl
-                    ? docPhaseEl.getBoundingClientRect().height
-                    : 0;
-                const viewportHeight = window.innerHeight;
-                const maxHeight =
-                    viewportHeight -
-                    (docPhaseElHeight + totalHeaderHeight + 24); //added some margin of dx-toc
-
-                rightNavBarEl.style.top = `${
-                    totalHeaderHeight + docPhaseElHeight
-                }px`;
-
-                const toc = rightNavBarEl.querySelector("dx-toc");
-                const listContainer = toc?.shadowRoot?.querySelector(
-                    ".toc"
-                ) as HTMLElement;
-
-                if (listContainer) {
-                    listContainer.style.maxHeight = `${maxHeight}px`;
-                }
+                rightNavBarEl.style.top = docPhaseEl
+                    ? `${
+                          totalHeaderHeight +
+                          docPhaseEl.getBoundingClientRect().height
+                      }px`
+                    : `${totalHeaderHeight}px`;
             }
 
             // If doc phase element exists, we need to account for its sticky position. Mobile should include the sidebar height (since it becomes sticky aswell).

package/src/modules/doc/specificationContent/specificationContent.html

@@ -160,11 +160,11 @@
                     </tr>
                 </thead>
                 <tbody>
-                    <template for:each={events} for:item="event">
+                    <template for:each={processedEvents} for:item="event">
                         <tr key={event.name}>
                             <td>
                                 <span class="code">
-                                    {event.nameInKebabCase}
+                                    {event.nameCapitalized}
                                 </span>
                             </td>
                             <td>{event.description}</td>

package/src/modules/doc/specificationContent/specificationContent.ts

@@ -17,6 +17,7 @@ export default class SpecificationContent extends LightningElement {
     private methods: Method[] = [];
     private slots: Specification[] = [];
     private events: Specification[] = [];
+    private _processedEvents: Specification[] = [];
 
     /* TODO: For now setting the timeout to 300ms,
      * post integration with CX-Router API will test and change if required.
@@ -60,6 +61,20 @@ export default class SpecificationContent extends LightningElement {
                     slots: this.slots,
                     events: this.events
                 } = this.data);
+
+                // Process events once when data is set
+                this._processedEvents = this.events
+                    ? this.events.map((event) => {
+                          const capitalizedName = event.name
+                              ? event.name.charAt(0).toUpperCase() +
+                                event.name.slice(1)
+                              : "";
+                          return {
+                              ...event,
+                              nameCapitalized: capitalizedName
+                          };
+                      })
+                    : [];
             }
         } catch (error) {
             this.data = {};
@@ -92,6 +107,15 @@ export default class SpecificationContent extends LightningElement {
         });
     }
 
+    /**
+     * Returns the preprocessed events for easier rendering in the template.
+     * Each event is augmented with a capitalized name property that capitalizes the first letter
+     * while maintaining camelCase format.
+     */
+    get processedEvents(): Specification[] {
+        return this._processedEvents;
+    }
+
     get hasAttributes() {
         return this.attributes?.length > 0;
     }