@salesforcedevs/docs-components 0.64.2-reference-attributes-1 → 0.65.0

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,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.64.2-reference-attributes-1",
+    "version": "0.65.0",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -24,5 +24,5 @@
         "@types/lodash.orderby": "^4.6.7",
         "@types/lodash.uniqby": "^4.7.7"
     },
-    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
+    "gitHead": "1c5bd3f00f0ac08aaa480c3d0ccd8a870b4c4035"
 }

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

@@ -363,6 +363,21 @@ export default class AmfReference extends LightningElement {
         return parentReferenceIndex !== -1;
     }
 
+    /**
+     * Expands the children of Markdown-based References.
+     */
+    private expandChildrenForMarkdownReferences(
+        children: ParsedMarkdownTopic[]
+    ): void {
+        if (!children) {
+            return;
+        }
+        for (const childNode of children) {
+            childNode.isExpanded = true;
+            this.expandChildrenForMarkdownReferences(childNode.children);
+        }
+    }
+
     /**
      * Populates reference Items from amfConfigList and assigns it to navigation for sidebar
      */
@@ -383,6 +398,15 @@ export default class AmfReference extends LightningElement {
                 }
                 isChildrenLoading = true;
             } else {
+                const isExpandChildrenEnabled = this.isExpandChildrenEnabled(
+                    amfConfig.id
+                );
+                // check whether we should expand all the child nodes, this is required for Coveo to crawl.
+                if (isExpandChildrenEnabled) {
+                    this.expandChildrenForMarkdownReferences(
+                        amfConfig.topic.children
+                    );
+                }
                 navItemChildren = amfConfig.topic.children;
             }
             // store nav items for each spec in order

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

@@ -68,6 +68,7 @@ export interface ParsedMarkdownTopic {
         href: string;
         target?: string;
     };
+    isExpanded?: boolean;
 }
 
 export interface AmfConfig {

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

@@ -78,8 +78,8 @@ api-security-documentation {
     --arc-font-h3-margin: var(--amf-h8-margin);
 
     /* p */
-    --arc-font-body1-font-size: var(--dx-g-text-sm);
-    --arc-font-body1-line-height: var(--dx-g-spacing-mlg);
+    --arc-font-body1-font-size: var(--dx-g-text-base);
+    --arc-font-body1-line-height: var(--dx-g-spacing-lg);
 
     /* code */
     --arc-font-code-family: var(--dx-g-font-mono);
@@ -133,14 +133,33 @@ api-security-documentation {
     /* api */
     --api-parameters-document-title-border: 0;
     --api-body-document-title-border: 0;
-    --api-type-document-trait-font-family: var(--dx-g-font-sans);
+    --api-type-document-property-parent-color: rgb(112, 110, 107);
+    --api-type-document-property-title-font-family: var(--dx-g-font-sans);
+    --api-type-document-property-title-font-size: var(--dx-g-text-base);
+    --api-type-document-property-title-font-weight: var(--dx-g-font-bold);
+    --api-type-document-property-title-color: var(--dx-g-blue-vibrant-20);
+    --api-type-document-type-font-family: var(--dx-g-font-mono);
+    --api-type-document-type-background-color: var(--dx-g-gray-95);
+    --api-type-document-type-color: rgb(24, 24, 24);
+    --api-type-document-type-attribute-color: rgb(24, 24, 24);
+    --api-type-document-trait-font-family: var(--dx-g-font-mono);
+    --api-type-document-trait-color: rgb(24, 24, 24);
+    --api-type-document-trait-padding: 0 var(--dx-g-spacing-xs);
+    --api-type-document-trait-data-type-padding: 0 var(--dx-g-spacing-xs);
+    --api-type-document-trait-font-size: var(--dx-g-text-sm);
+    --api-type-document-trait-border-radius: var(--dx-g-spacing-xs);
+    --api-type-document-trait-background-color: var(--dx-g-gray-95);
     --api-type-document-union-button-active-background-color: transparent;
     --api-type-document-union-button-active-color: var(--dx-g-blue-vibrant-20);
     --api-type-document-union-button-background-color: transparent;
     --api-type-document-union-button-color: var(--dx-g-blue-vibrant-50);
     --api-type-document-media-button-border-color: transparent;
     --property-shape-document-padding: 24px 0;
-    --property-shape-document-title-font-family: var(--dx-g-font-mono);
+    --property-shape-document-title-font-family: var(--dx-g-font-sans);
+    --property-shape-document-title-font-size: var(--dx-g-text-base);
+    --property-shape-document-title-font-weight: var(--dx-g-font-bold);
+    --property-shape-document-title-line-height: 20px;
+    --property-shape-document-title-margin: 8px 0 8px 0;
     --property-shape-document-object-color: var(--dx-g-blue-vibrant-90);
     --property-shape-document-array-color: var(--dx-g-blue-vibrant-90);
     --property-shape-document-union-color: var(--dx-g-blue-vibrant-90);