@coveo/atomic 3.34.0-pre.d729012f68 → 3.34.0-pre.d9575786e7

package/docs/atomic-docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-10-07T14:10:26",
+  "timestamp": "2025-10-07T17:12:25",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
@@ -9473,7 +9473,8 @@
       "dependents": [
         "atomic-folded-result-list",
         "atomic-result-children",
-        "atomic-result-list"
+        "atomic-result-list",
+        "atomic-search-box-instant-results"
       ],
       "dependencies": [],
       "dependencyGraph": {
@@ -9485,6 +9486,9 @@
         ],
         "atomic-result-list": [
           "atomic-result"
+        ],
+        "atomic-search-box-instant-results": [
+          "atomic-result"
         ]
       }
     },
@@ -12231,6 +12235,223 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/search/search-box-suggestions/atomic-search-box-instant-results/atomic-search-box-instant-results.tsx",
+      "encapsulation": "shadow",
+      "tag": "atomic-search-box-instant-results",
+      "docs": "The `atomic-search-box-instant-results` component can be added as a child of an `atomic-search-box` component, allowing for the configuration of instant results behavior.\n\nThis component does not support accessibility out-of-the-box. To do so, see [Instant Results Accessibility](https://docs.coveo.com/en/atomic/latest/usage/accessibility/#instant-results-accessibility).\n\nThis component is not supported on mobile.",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "default - The default slot where the instant results are rendered."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "ariaLabelGenerator",
+          "type": "((bindings: Bindings, result: Result) => string | undefined) | undefined",
+          "complexType": {
+            "original": "AriaLabelGenerator",
+            "resolved": "((bindings: Bindings, result: Result) => string | undefined) | undefined",
+            "references": {
+              "AriaLabelGenerator": {
+                "location": "local",
+                "path": "/home/runner/work/ui-kit/ui-kit/packages/atomic/src/components/search/search-box-suggestions/atomic-search-box-instant-results/atomic-search-box-instant-results.tsx",
+                "id": "src/components/search/search-box-suggestions/atomic-search-box-instant-results/atomic-search-box-instant-results.tsx::AriaLabelGenerator"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The callback to generate an [`aria-label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label) for a given result so that accessibility tools can fully describe what's visually rendered by a result.\n\nBy default, or if an empty string is returned, `result.title` is used.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "((bindings: Bindings, result: Result) => string"
+            },
+            {
+              "type": "undefined)"
+            },
+            {
+              "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": true,
+          "docs": "The spacing of various elements in the result list, including the gap between results, the gap between parts of a result, and the font sizes of different parts in a result.",
+          "docsTags": [],
+          "default": "'normal'",
+          "values": [
+            {
+              "value": "comfortable",
+              "type": "string"
+            },
+            {
+              "value": "compact",
+              "type": "string"
+            },
+            {
+              "value": "normal",
+              "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": true,
+          "docs": "The expected size of the image displayed in the results.",
+          "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": "maxResultsPerQuery",
+          "type": "number",
+          "complexType": {
+            "original": "number",
+            "resolved": "number",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "max-results-per-query",
+          "reflectToAttr": true,
+          "docs": "The maximum number of results to show.",
+          "docsTags": [],
+          "default": "4",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "setRenderFunction",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(resultRenderingFunction: ItemRenderingFunction) => Promise<void>",
+            "parameters": [
+              {
+                "name": "resultRenderingFunction",
+                "type": "((result: AnyItem, root: HTMLElement, linkContainer?: HTMLElement | undefined) => string) | undefined",
+                "docs": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "ItemRenderingFunction": {
+                "location": "import",
+                "path": "../../../common/item-list/stencil-item-list-common",
+                "id": "src/components/common/item-list/stencil-item-list-common.tsx::ItemRenderingFunction"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "setRenderFunction(resultRenderingFunction: ItemRenderingFunction) => Promise<void>",
+          "parameters": [
+            {
+              "name": "resultRenderingFunction",
+              "type": "((result: AnyItem, root: HTMLElement, linkContainer?: HTMLElement | undefined) => string) | undefined",
+              "docs": ""
+            }
+          ],
+          "docs": "Sets a rendering function to bypass the standard HTML template mechanism for rendering results.\nYou can use this function while working with web frameworks that don't use plain HTML syntax, e.g., React, Angular or Vue.\n\nDo not use this method if you integrate Atomic in a plain HTML deployment.",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "resultRenderingFunction"
+            }
+          ]
+        }
+      ],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "default",
+          "docs": "The default slot where the instant results are rendered."
+        }
+      ],
+      "parts": [
+        {
+          "name": "outline",
+          "docs": ""
+        }
+      ],
+      "dependents": [],
+      "dependencies": [
+        "atomic-result"
+      ],
+      "dependencyGraph": {
+        "atomic-search-box-instant-results": [
+          "atomic-result"
+        ]
+      }
+    },
     {
       "filePath": "src/components/search/search-box-suggestions/atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.tsx",
       "encapsulation": "shadow",
@@ -14935,11 +15156,6 @@
       "docstring": "The recommendation engine configuration.",
       "path": "src/components/recommendations/atomic-recs-interface/atomic-recs-interface.tsx"
     },
-    "src/components/common/layout/display-options.ts::ItemDisplayLayout": {
-      "declaration": "export type ItemDisplayLayout = ItemDisplayBasicLayout | 'table';",
-      "docstring": "",
-      "path": "src/components/common/layout/display-options.ts"
-    },
     "src/components/common/layout/display-options.ts::ItemDisplayDensity": {
       "declaration": "export type ItemDisplayDensity = 'comfortable' | 'normal' | 'compact';",
       "docstring": "",
@@ -14950,6 +15166,21 @@
       "docstring": "",
       "path": "src/components/common/layout/display-options.ts"
     },
+    "src/components/search/search-box-suggestions/atomic-search-box-instant-results/atomic-search-box-instant-results.tsx::AriaLabelGenerator": {
+      "declaration": "(\n  bindings: Bindings,\n  result: Result\n) => string | undefined",
+      "docstring": "",
+      "path": "src/components/search/search-box-suggestions/atomic-search-box-instant-results/atomic-search-box-instant-results.tsx"
+    },
+    "src/components/common/item-list/stencil-item-list-common.tsx::ItemRenderingFunction": {
+      "declaration": "export type ItemRenderingFunction<SpecificResult extends AnyItem = AnyItem> =\n  | ((\n      result: SpecificResult,\n      root: HTMLElement,\n      linkContainer?: HTMLElement\n    ) => string)\n  | undefined;",
+      "docstring": "",
+      "path": "src/components/common/item-list/stencil-item-list-common.tsx"
+    },
+    "src/components/common/layout/display-options.ts::ItemDisplayLayout": {
+      "declaration": "export type ItemDisplayLayout = ItemDisplayBasicLayout | 'table';",
+      "docstring": "",
+      "path": "src/components/common/layout/display-options.ts"
+    },
     "src/components/common/suggestions/suggestions-types.ts::SearchBoxSuggestionElement": {
       "declaration": "export interface SearchBoxSuggestionElement {\n  /**\n   * Stable identity which enables Stencil to reuse DOM elements for better performance.\n   * The best way to pick a key is to use a string that uniquely identifies that list item among its siblings (often your data will already have IDs).\n   */\n  key: string;\n  /**\n   * Rendered content of the element.\n   *\n   * @remarks\n   * The `VNode` type will be deprecated in v4 as we are detaching from Stencil.\n   */\n  content: Element | VNode;\n  /**\n   * Hook called when the selection is selected.\n   * @param e DOM event.\n   */\n  onSelect?(e: Event): void;\n  /**\n   * The query associated with the suggestion which will replace the query in the search box if the suggestion is selected.\n   */\n  query?: string;\n  /**\n   * For improved accessibility, provide this property with additional information.\n   * https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label\n   */\n  ariaLabel?: string;\n  /**\n   * Adds a specific shadow part attribute that can be selected with the CSS ::part pseudo-element.\n   * https://developer.mozilla.org/en-US/docs/Web/CSS/::part\n   */\n  part?: string;\n  /**\n   * Hide the suggestion if it's the last in the list.\n   */\n  hideIfLast?: boolean;\n}",
       "docstring": "Element which will be rendered in the list of suggestions.",
@@ -15055,11 +15286,6 @@
       "docstring": "",
       "path": "src/components/insight/atomic-insight-interface/store.ts"
     },
-    "src/components/common/item-list/stencil-item-list-common.tsx::ItemRenderingFunction": {
-      "declaration": "export type ItemRenderingFunction<SpecificResult extends AnyItem = AnyItem> =\n  | ((\n      result: SpecificResult,\n      root: HTMLElement,\n      linkContainer?: HTMLElement\n    ) => string)\n  | undefined;",
-      "docstring": "",
-      "path": "src/components/common/item-list/stencil-item-list-common.tsx"
-    },
     "../headless/dist/definitions/index.d.ts::ResultTemplateCondition": {
       "declaration": "any",
       "docstring": "",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coveo/atomic",
   "type": "module",
-  "version": "3.34.0-pre.d729012f68",
+  "version": "3.34.0-pre.d9575786e7",
   "description": "A web-component library for building modern UIs interfacing with the Coveo platform",
   "homepage": "https://docs.coveo.com/en/atomic/latest/",
   "repository": {

package/dist/atomic/components/components/common/item-list/item-template-provider.js

@@ -1,28 +0,0 @@
-import { buildResultTemplatesManager, } from '@coveo/headless';
-import { TemplateProvider, } from '../template-provider/template-provider';
-export class ItemTemplateProvider extends TemplateProvider {
-    constructor(props, gridCellLinkTarget) {
-        super(props, () => buildResultTemplatesManager(props.bindings.engine));
-        this.gridCellLinkTarget = gridCellLinkTarget;
-    }
-    // TODO: Add JSX support for default template
-    makeDefaultTemplate() {
-        const content = document.createDocumentFragment();
-        const linkEl = document.createElement('atomic-result-link');
-        content.appendChild(linkEl);
-        const linkContent = document.createDocumentFragment();
-        const linkMarkup = `
-      <atomic-result-link>
-      ${this.gridCellLinkTarget ? `<a slot="attributes" target="${this.gridCellLinkTarget}"></a>` : ''}
-      </atomic-result-link>
-    `;
-        const linkTemplate = document.createElement('template');
-        linkTemplate.innerHTML = linkMarkup.trim();
-        linkContent.appendChild(linkTemplate.content);
-        return {
-            content,
-            linkContent,
-            conditions: [],
-        };
-    }
-}