@coveo/atomic 3.35.0-pre.ebf3345026 → 3.35.0-pre.ef36eacfa0

package/docs/atomic-docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-10-09T21:56:20",
+  "timestamp": "2025-10-10T05:39:44",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
@@ -3337,13 +3337,23 @@
       ],
       "dependents": [],
       "dependencies": [
+        "atomic-result",
         "atomic-result-placeholder",
         "atomic-result-table-placeholder"
       ],
       "dependencyGraph": {
         "atomic-folded-result-list": [
+          "atomic-result",
           "atomic-result-placeholder",
           "atomic-result-table-placeholder"
+        ],
+        "atomic-result-placeholder": [
+          "atomic-result-section-visual",
+          "atomic-result-section-badges",
+          "atomic-result-section-actions",
+          "atomic-result-section-title",
+          "atomic-result-section-excerpt",
+          "atomic-result-section-bottom-metadata"
         ]
       }
     },
@@ -7896,6 +7906,14 @@
           "atomic-recs-result",
           "atomic-result-placeholder",
           "atomic-result-table-placeholder"
+        ],
+        "atomic-result-placeholder": [
+          "atomic-result-section-visual",
+          "atomic-result-section-badges",
+          "atomic-result-section-actions",
+          "atomic-result-section-title",
+          "atomic-result-section-excerpt",
+          "atomic-result-section-bottom-metadata"
         ]
       }
     },
@@ -8757,6 +8775,319 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/search/atomic-result/atomic-result.tsx",
+      "encapsulation": "shadow",
+      "tag": "atomic-result",
+      "docs": "The `atomic-result` component is used internally by the `atomic-result-list` component.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "classes",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "classes",
+          "reflectToAttr": false,
+          "docs": "The classes to add to the result element.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "content",
+          "type": "ParentNode | undefined",
+          "complexType": {
+            "original": "ParentNode",
+            "resolved": "ParentNode | undefined",
+            "references": {
+              "ParentNode": {
+                "location": "global",
+                "id": "global::ParentNode"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The result content to display.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "ParentNode"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "density",
+          "type": "\"comfortable\" | \"compact\" | \"normal\"",
+          "complexType": {
+            "original": "ItemDisplayDensity",
+            "resolved": "\"comfortable\" | \"compact\" | \"normal\"",
+            "references": {
+              "ItemDisplayDensity": {
+                "location": "import",
+                "path": "../../common/layout/display-options",
+                "id": "src/components/common/layout/display-options.ts::ItemDisplayDensity"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "density",
+          "reflectToAttr": false,
+          "docs": "How large or small results should be.",
+          "docsTags": [],
+          "default": "'normal'",
+          "values": [
+            {
+              "value": "comfortable",
+              "type": "string"
+            },
+            {
+              "value": "compact",
+              "type": "string"
+            },
+            {
+              "value": "normal",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "display",
+          "type": "\"grid\" | \"list\" | \"table\"",
+          "complexType": {
+            "original": "ItemDisplayLayout",
+            "resolved": "\"grid\" | \"list\" | \"table\"",
+            "references": {
+              "ItemDisplayLayout": {
+                "location": "import",
+                "path": "../../common/layout/display-options",
+                "id": "src/components/common/layout/display-options.ts::ItemDisplayLayout"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "display",
+          "reflectToAttr": false,
+          "docs": "How results should be displayed.",
+          "docsTags": [],
+          "default": "'list'",
+          "values": [
+            {
+              "value": "grid",
+              "type": "string"
+            },
+            {
+              "value": "list",
+              "type": "string"
+            },
+            {
+              "value": "table",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "imageSize",
+          "type": "\"icon\" | \"large\" | \"none\" | \"small\"",
+          "complexType": {
+            "original": "ItemDisplayImageSize",
+            "resolved": "\"icon\" | \"large\" | \"none\" | \"small\"",
+            "references": {
+              "ItemDisplayImageSize": {
+                "location": "import",
+                "path": "../../common/layout/display-options",
+                "id": "src/components/common/layout/display-options.ts::ItemDisplayImageSize"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "image-size",
+          "reflectToAttr": false,
+          "docs": "The size of the visual section in result list items.\n\nThis is overwritten by the image size defined in the result content, if it exists.",
+          "docsTags": [],
+          "default": "'icon'",
+          "values": [
+            {
+              "value": "icon",
+              "type": "string"
+            },
+            {
+              "value": "large",
+              "type": "string"
+            },
+            {
+              "value": "none",
+              "type": "string"
+            },
+            {
+              "value": "small",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "linkContent",
+          "type": "ParentNode",
+          "complexType": {
+            "original": "ParentNode",
+            "resolved": "ParentNode",
+            "references": {
+              "ParentNode": {
+                "location": "global",
+                "id": "global::ParentNode"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The result link to use when the result is clicked in a grid layout.",
+          "docsTags": [
+            {
+              "name": "default",
+              "text": "- An `atomic-result-link` without any customization."
+            }
+          ],
+          "default": "new DocumentFragment()",
+          "values": [
+            {
+              "type": "ParentNode"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "result",
+          "type": "FoldedResult | Result",
+          "complexType": {
+            "original": "Result | FoldedResult",
+            "resolved": "FoldedResult | Result",
+            "references": {
+              "Result": {
+                "location": "import",
+                "path": "@coveo/headless",
+                "id": "../headless/dist/definitions/index.d.ts::Result"
+              },
+              "FoldedResult": {
+                "location": "import",
+                "path": "@coveo/headless",
+                "id": "../headless/dist/definitions/index.d.ts::FoldedResult"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The result item.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "FoldedResult"
+            },
+            {
+              "type": "Result"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "stopPropagation",
+          "type": "boolean | undefined",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "stop-propagation",
+          "reflectToAttr": false,
+          "docs": "Whether an atomic-result-link inside atomic-result should stop click event propagation.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [
+        {
+          "event": "atomic/resolveResult",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "atomic/resolveInteractiveResult",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "atomic/resolveStopPropagation",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "atomic/resolveResultDisplayConfig",
+          "capture": false,
+          "passive": false
+        },
+        {
+          "event": "click",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-folded-result-list",
+        "atomic-result-children",
+        "atomic-result-list"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-folded-result-list": [
+          "atomic-result"
+        ],
+        "atomic-result-children": [
+          "atomic-result"
+        ],
+        "atomic-result-list": [
+          "atomic-result"
+        ]
+      }
+    },
     {
       "filePath": "src/components/search/result-template-components/atomic-result-badge/atomic-result-badge.tsx",
       "encapsulation": "shadow",
@@ -9047,13 +9378,23 @@
       ],
       "dependents": [],
       "dependencies": [
+        "atomic-result",
         "atomic-result-placeholder",
         "atomic-result-table-placeholder"
       ],
       "dependencyGraph": {
         "atomic-result-children": [
+          "atomic-result",
           "atomic-result-placeholder",
           "atomic-result-table-placeholder"
+        ],
+        "atomic-result-placeholder": [
+          "atomic-result-section-visual",
+          "atomic-result-section-badges",
+          "atomic-result-section-actions",
+          "atomic-result-section-title",
+          "atomic-result-section-excerpt",
+          "atomic-result-section-bottom-metadata"
         ]
       }
     },
@@ -9907,15 +10248,25 @@
       ],
       "dependents": [],
       "dependencies": [
+        "atomic-result",
         "atomic-result-placeholder",
         "atomic-result-table-placeholder",
         "atomic-text"
       ],
       "dependencyGraph": {
         "atomic-result-list": [
+          "atomic-result",
           "atomic-result-placeholder",
           "atomic-result-table-placeholder",
           "atomic-text"
+        ],
+        "atomic-result-placeholder": [
+          "atomic-result-section-visual",
+          "atomic-result-section-badges",
+          "atomic-result-section-actions",
+          "atomic-result-section-title",
+          "atomic-result-section-excerpt",
+          "atomic-result-section-bottom-metadata"
         ]
       }
     },
@@ -10362,6 +10713,248 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-actions.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-actions",
+      "docs": "This section allows the information seeker to perform an action on an item without having to view its details.\nFor example, in Commerce you can add an item to the cart directly or add it to a wish list to view at a later time.\n\nBehavior:\n* Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.\n** You should ensure that elements inside of it have `height: var(--line-height)`.\n* Is a wrapping flexbox with a gap.\n* May appear over, next to, or beneath the visual section.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-result-placeholder"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-result-placeholder": [
+          "atomic-result-section-actions"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-badges.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-badges",
+      "docs": "This section provides badges that highlight special features of the item.\n\nBehavior:\n* Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.\n** You should ensure that elements inside of it have `height: var(--line-height)`.\n* Is a wrapping flexbox with a gap.\n* May appear over, next to, or beneath the visual section.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-result-placeholder"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-result-placeholder": [
+          "atomic-result-section-badges"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-bottom-metadata.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-bottom-metadata",
+      "docs": "This section displays additional descriptive information about the item.\n\nBehavior:\n* Has a maximum height of two lines.\n** We recommend that you use `atomic-result-fields-list` to ensure that the fields in this section don’t overflow.\n* Exposes the `--line-height` variable so child elements can adjust to the current line height.\n* Has a defined CSS `color` property for text.\n* Has a font weight.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-result-placeholder"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-result-placeholder": [
+          "atomic-result-section-bottom-metadata"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-children.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-children",
+      "docs": "This section displays the folded results, available when using the <atomic-result-children> component.\n\nBehavior:\n* Shows children at the bottom of the result, indented and wrapped in a border.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-emphasized.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-emphasized",
+      "docs": "This section displays the field that's important for its search criteria.\nFor example, in Commerce, a product's cost is often more important than the title itself.\n\nBehavior:\n* Has a very large font size.\n* Is the second closest element beneath the title section.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-excerpt.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-excerpt",
+      "docs": "This section contains an informative summary of the item's content.\n\nBehavior:\n* Has a fixed height of one to three lines, depending on the layout and density.\n* Ellipses overflowing text.\n* Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.\n* Has a defined CSS `color` property for text.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-result-placeholder"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-result-placeholder": [
+          "atomic-result-section-excerpt"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-title.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-title",
+      "docs": "This section identifies the item by its name, and its main use is to make the result list scannable.\nThis is usually the page title.\n\nBehavior:\n* Has a fixed height of two lines on grid layouts.\n* Exposes the `--line-height` CSS variable so child elements can adjust to the current line height.\n* Has a defined CSS `color` property for text.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-result-placeholder"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-result-placeholder": [
+          "atomic-result-section-title"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-title-metadata.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-title-metadata",
+      "docs": "This section surfaces some fields that are directly related to the title of the item.\nFor example, in Commerce, this could be the item's rating, which is tied to the nature of the product itself,\nrather than to the product's description.\n\nBehavior:\n* Has a very small font size.\n* Is the closest element beneath the title section.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/search/result-template-components/atomic-result-sections/atomic-result-section-visual.tsx",
+      "encapsulation": "none",
+      "tag": "atomic-result-section-visual",
+      "docs": "This section provides visual information about the item.\nFor example, in Commerce, an image is a great shorthand for a product category.\nAn icon can quickly show the item type, or an avatar can help identify to whom it is related.\n\nBehavior:\n* Has a fixed size that depends on the specified image size, the layout, the density, and the screen size.\n** When the image size is set to `icon`, this section stays very small.\n** You should ensure that elements inside of it take the available space.\n* Always has a 1:1 aspect ratio.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "imageSize",
+          "type": "\"icon\" | \"large\" | \"none\" | \"small\" | undefined",
+          "complexType": {
+            "original": "ItemDisplayImageSize",
+            "resolved": "\"icon\" | \"large\" | \"none\" | \"small\" | undefined",
+            "references": {
+              "ItemDisplayImageSize": {
+                "location": "import",
+                "path": "../../../common/layout/display-options",
+                "id": "src/components/common/layout/display-options.ts::ItemDisplayImageSize"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "image-size",
+          "reflectToAttr": true,
+          "docs": "How large or small the visual section of results using this template should be.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "icon",
+              "type": "string"
+            },
+            {
+              "value": "large",
+              "type": "string"
+            },
+            {
+              "value": "none",
+              "type": "string"
+            },
+            {
+              "value": "small",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "atomic-result-placeholder"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "atomic-result-placeholder": [
+          "atomic-result-section-visual"
+        ]
+      }
+    },
     {
       "filePath": "src/components/search/result-templates/atomic-result-template/atomic-result-template.tsx",
       "encapsulation": "shadow",
@@ -14013,6 +14606,21 @@
       "docstring": "",
       "path": "src/utils/initialization-utils.tsx"
     },
+    "../headless/dist/definitions/index.d.ts::FoldedResult": {
+      "declaration": "any",
+      "docstring": "",
+      "path": "../headless/dist/definitions/index.d.ts"
+    },
+    "../headless/dist/definitions/index.d.ts::InteractiveResult": {
+      "declaration": "any",
+      "docstring": "",
+      "path": "../headless/dist/definitions/index.d.ts"
+    },
+    "src/components/search/atomic-search-interface/store.ts::SearchStore": {
+      "declaration": "export type SearchStore = BaseStore<Data> & {\n  unsetLoadingFlag(loadingFlag: string): void;\n  setLoadingFlag(flag: string): void;\n  isMobile(): boolean;\n  registerFacet<T extends FacetType, U extends string>(\n    facetType: T,\n    data: Data[T][U] & {facetId: U; element: HTMLElement}\n  ): void;\n  getFacetElements(): HTMLElement[];\n  waitUntilAppLoaded(callback: () => void): void;\n  getUniqueIDFromEngine(engine: SearchEngine): string;\n  hasLoadingFlag(loadingFlag: string): boolean;\n  getAllFacets(): FacetInfoMap;\n  addFieldsToInclude(fields: string[]): void;\n};",
+      "docstring": "",
+      "path": "src/components/search/atomic-search-interface/store.ts"
+    },
     "src/components/common/search-box/redirection-payload.ts::RedirectionPayload": {
       "declaration": "export interface RedirectionPayload {\n  /**\n   * The Url to redirect to.\n   */\n  redirectTo: string;\n  /**\n   * The current query in the search box.\n   */\n  value: string;\n}",
       "docstring": "",