@coveo/atomic 3.33.9-pre.a8ae421e2e → 3.33.9-pre.a90e222cec

package/docs/atomic-docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-10-01T19:11:19",
+  "timestamp": "2025-10-01T20:22:26",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.20.0",
@@ -2081,6 +2081,723 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "src/components/search/facets/atomic-facet/atomic-facet.tsx",
+      "encapsulation": "shadow",
+      "tag": "atomic-facet",
+      "docs": "A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences).\nAn `atomic-facet` displays a facet of the results for the current query.",
+      "docsTags": [
+        {
+          "name": "part",
+          "text": "facet - The wrapper for the entire facet."
+        },
+        {
+          "name": "part",
+          "text": "placeholder - The placeholder shown before the first search is executed."
+        },
+        {
+          "name": "part",
+          "text": "label-button - The button that displays the label and allows to expand/collapse the facet."
+        },
+        {
+          "name": "part",
+          "text": "label-button-icon - The label button icon."
+        },
+        {
+          "name": "part",
+          "text": "clear-button - The button that resets the actively selected facet values."
+        },
+        {
+          "name": "part",
+          "text": "clear-button-icon - The clear button icon."
+        },
+        {
+          "name": "part",
+          "text": "search-wrapper - The search box wrapper."
+        },
+        {
+          "name": "part",
+          "text": "search-input - The search box input."
+        },
+        {
+          "name": "part",
+          "text": "search-icon - The search box submit button."
+        },
+        {
+          "name": "part",
+          "text": "search-clear-button - The button to clear the search box of input."
+        },
+        {
+          "name": "part",
+          "text": "more-matches - The label indicating there are more matches for the current facet search query."
+        },
+        {
+          "name": "part",
+          "text": "no-matches - The label indicating there are no matches for the current facet search query."
+        },
+        {
+          "name": "part",
+          "text": "matches-query - The highlighted query inside the matches labels."
+        },
+        {
+          "name": "part",
+          "text": "search-highlight - The highlighted query inside the facet values."
+        },
+        {
+          "name": "part",
+          "text": "values - The facet values container."
+        },
+        {
+          "name": "part",
+          "text": "value-label - The facet value label, common for all displays."
+        },
+        {
+          "name": "part",
+          "text": "value-count - The facet value count, common for all displays."
+        },
+        {
+          "name": "part",
+          "text": "value-checkbox - The facet value checkbox, available when display is 'checkbox'."
+        },
+        {
+          "name": "part",
+          "text": "value-checkbox-checked - The checked facet value checkbox, available when display is 'checkbox'."
+        },
+        {
+          "name": "part",
+          "text": "value-checkbox-label - The facet value checkbox clickable label, available when display is 'checkbox'."
+        },
+        {
+          "name": "part",
+          "text": "value-checkbox-icon - The facet value checkbox icon, available when display is 'checkbox'."
+        },
+        {
+          "name": "part",
+          "text": "value-link - The facet value when display is 'link'."
+        },
+        {
+          "name": "part",
+          "text": "value-link-selected - The selected facet value when display is 'link'."
+        },
+        {
+          "name": "part",
+          "text": "value-box - The facet value when display is 'box'."
+        },
+        {
+          "name": "part",
+          "text": "value-box-selected - The selected facet value when display is 'box'."
+        },
+        {
+          "name": "part",
+          "text": "value-exclude-button - The button to exclude a facet value, available when display is 'checkbox'."
+        },
+        {
+          "name": "part",
+          "text": "show-more - The show more results button."
+        },
+        {
+          "name": "part",
+          "text": "show-less - The show less results button."
+        },
+        {
+          "name": "part",
+          "text": "show-more-less-icon - The icons of the show more & show less buttons."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "allowedValues",
+          "type": "string | string[]",
+          "complexType": {
+            "original": "string[] | string",
+            "resolved": "string | string[]",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "allowed-values",
+          "reflectToAttr": false,
+          "docs": "Specifies an explicit list of `allowedValues` in the Search API request, as a JSON string representation.\n\nIf you specify a list of values for this option, the facet uses only these values (if they are available in\nthe current result set).\n\nExample:\n\nThe following facet only uses the `Contact`, `Account`, and `File` values of the `objecttype` field. Even if the\ncurrent result set contains other `objecttype` values, such as `Message`, or `Product`, the facet does not use\nthose other values.\n\n```html\n<atomic-facet field=\"objecttype\" allowed-values='[\"Contact\",\"Account\",\"File\"]'></atomic-facet>\n```\n\nThe maximum amount of allowed values is 25.\n\nDefault value is `undefined`, and the facet uses all available values for its `field` in the current result set.",
+          "docsTags": [],
+          "default": "'[]'",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "string[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "customSort",
+          "type": "string | string[]",
+          "complexType": {
+            "original": "string[] | string",
+            "resolved": "string | string[]",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "custom-sort",
+          "reflectToAttr": false,
+          "docs": "Identifies the facet values that must appear at the top, in this order.\nThis parameter can be used in conjunction with the `sortCriteria` parameter.\n\nFacet values not part of the `customSort` list will be sorted according to the `sortCriteria`.\n\nExample:\n\nThe following facet will sort the `Contact`, `Account`, and `File` values at the top of the list for the `objecttype` field.\n\nIf there are more than these 3 values available, the rest of the list will be sorted using `occurrences`.\n\n```html\n<atomic-facet field=\"objecttype\" custom-sort='[\"Contact\",\"Account\",\"File\"]' sort-criteria='occurrences'></atomic-facet>\n```\nThe maximum amount of custom sort values is 25.\n\nThe default value is `undefined`, and the facet values will be sorted using only the `sortCriteria`.",
+          "docsTags": [],
+          "default": "'[]'",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "string[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "dependsOn",
+          "type": "{ [x: string]: string; }",
+          "complexType": {
+            "original": "Record<string, string>",
+            "resolved": "{ [x: string]: string; }",
+            "references": {
+              "Record": {
+                "location": "global",
+                "id": "global::Record"
+              }
+            }
+          },
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The required facets and values for this facet to be displayed.\nExamples:\n```html\n<atomic-facet facet-id=\"abc\" field=\"objecttype\" ...></atomic-facet>\n\n<!-- To show the facet when any value is selected in the facet with id \"abc\": -->\n<atomic-facet\n  depends-on-abc\n  ...\n></atomic-facet>\n\n<!-- To show the facet when value \"doc\" is selected in the facet with id \"abc\": -->\n<atomic-facet\n  depends-on-abc=\"doc\"\n  ...\n></atomic-facet>\n```",
+          "docsTags": [],
+          "default": "{}",
+          "values": [
+            {
+              "type": "{ [x: string]: string; }"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "displayValuesAs",
+          "type": "\"box\" | \"checkbox\" | \"link\"",
+          "complexType": {
+            "original": "'checkbox' | 'link' | 'box'",
+            "resolved": "\"box\" | \"checkbox\" | \"link\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "display-values-as",
+          "reflectToAttr": true,
+          "docs": "Whether to display the facet values as checkboxes (multiple selection), links (single selection) or boxes (multiple selection).\nPossible values are 'checkbox', 'link', and 'box'.",
+          "docsTags": [],
+          "default": "'checkbox'",
+          "values": [
+            {
+              "value": "box",
+              "type": "string"
+            },
+            {
+              "value": "checkbox",
+              "type": "string"
+            },
+            {
+              "value": "link",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "enableExclusion",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "enable-exclusion",
+          "reflectToAttr": true,
+          "docs": "Whether to allow excluding values from the facet.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "facetId",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "facet-id",
+          "reflectToAttr": true,
+          "docs": "Specifies a unique identifier for the facet.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "field",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "field",
+          "reflectToAttr": true,
+          "docs": "The field whose values you want to display in the facet.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "filterFacetCount",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "filter-facet-count",
+          "reflectToAttr": true,
+          "docs": "Whether to exclude the parents of folded results when estimating the result count for each facet value.\n\n\nNote: Resulting count is only an estimation, in some cases this value could be incorrect.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "headingLevel",
+          "type": "number",
+          "complexType": {
+            "original": "number",
+            "resolved": "number",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "heading-level",
+          "reflectToAttr": true,
+          "docs": "The [heading level](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements) to use for the heading over the facet, from 1 to 6.",
+          "docsTags": [],
+          "default": "0",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "injectionDepth",
+          "type": "number",
+          "complexType": {
+            "original": "number",
+            "resolved": "number",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "injection-depth",
+          "reflectToAttr": false,
+          "docs": "The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.\nNote: A high injectionDepth may negatively impact the facet request performance.\nMinimum: `0`\nDefault: `1000`",
+          "docsTags": [],
+          "default": "1000",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "isCollapsed",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "is-collapsed",
+          "reflectToAttr": true,
+          "docs": "Specifies whether the facet is collapsed. When the facet is the child of an `atomic-facet-manager` component, the facet manager controls this property.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "label",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "label",
+          "reflectToAttr": true,
+          "docs": "The non-localized label for the facet.\nUsed in the `atomic-breadbox` component through the bindings store.",
+          "docsTags": [],
+          "default": "'no-label'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "numberOfValues",
+          "type": "number",
+          "complexType": {
+            "original": "number",
+            "resolved": "number",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "number-of-values",
+          "reflectToAttr": true,
+          "docs": "The number of values to request for this facet.\nAlso determines the number of additional values to request each time more values are shown.",
+          "docsTags": [],
+          "default": "8",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "resultsMustMatch",
+          "type": "\"allValues\" | \"atLeastOneValue\"",
+          "complexType": {
+            "original": "FacetResultsMustMatch",
+            "resolved": "\"allValues\" | \"atLeastOneValue\"",
+            "references": {
+              "FacetResultsMustMatch": {
+                "location": "import",
+                "path": "@coveo/headless",
+                "id": "../headless/dist/definitions/index.d.ts::FacetResultsMustMatch"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "results-must-match",
+          "reflectToAttr": true,
+          "docs": "Specifies how a result must match the selected facet values.\nAllowed values:\n- `atLeastOneValue`: A result will match if at least one of the corresponding facet values is selected.\n- `allValues`: A result will match if all corresponding facet values are selected.",
+          "docsTags": [],
+          "default": "'atLeastOneValue'",
+          "values": [
+            {
+              "value": "allValues",
+              "type": "string"
+            },
+            {
+              "value": "atLeastOneValue",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "sortCriteria",
+          "type": "\"alphanumeric\" | \"alphanumericDescending\" | \"alphanumericNatural\" | \"alphanumericNaturalDescending\" | \"automatic\" | \"occurrences\" | \"score\"",
+          "complexType": {
+            "original": "FacetSortCriterion",
+            "resolved": "\"alphanumeric\" | \"alphanumericDescending\" | \"alphanumericNatural\" | \"alphanumericNaturalDescending\" | \"automatic\" | \"occurrences\" | \"score\"",
+            "references": {
+              "FacetSortCriterion": {
+                "location": "import",
+                "path": "@coveo/headless",
+                "id": "../headless/dist/definitions/index.d.ts::FacetSortCriterion"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "sort-criteria",
+          "reflectToAttr": true,
+          "docs": "The sort criterion to apply to the returned facet values.\nPossible values are 'score', 'alphanumeric', 'alphanumericDescending', 'occurrences', alphanumericNatural', 'alphanumericNaturalDescending' and 'automatic'.",
+          "docsTags": [],
+          "default": "'automatic'",
+          "values": [
+            {
+              "value": "alphanumeric",
+              "type": "string"
+            },
+            {
+              "value": "alphanumericDescending",
+              "type": "string"
+            },
+            {
+              "value": "alphanumericNatural",
+              "type": "string"
+            },
+            {
+              "value": "alphanumericNaturalDescending",
+              "type": "string"
+            },
+            {
+              "value": "automatic",
+              "type": "string"
+            },
+            {
+              "value": "occurrences",
+              "type": "string"
+            },
+            {
+              "value": "score",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "tabsExcluded",
+          "type": "string | string[]",
+          "complexType": {
+            "original": "string[] | string",
+            "resolved": "string | string[]",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "tabs-excluded",
+          "reflectToAttr": true,
+          "docs": "The tabs on which this facet must not be displayed. This property should not be used at the same time as `tabs-included`.\n\nSet this property as a stringified JSON array, e.g.,\n```html\n <atomic-facet tabs-excluded='[\"tabIDA\", \"tabIDB\"]'></atomic-facet>\n```\nIf you don't set this property, the facet can be displayed on any tab. Otherwise, the facet won't be displayed on any of the specified tabs.",
+          "docsTags": [],
+          "default": "'[]'",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "string[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "tabsIncluded",
+          "type": "string | string[]",
+          "complexType": {
+            "original": "string[] | string",
+            "resolved": "string | string[]",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "tabs-included",
+          "reflectToAttr": true,
+          "docs": "The tabs on which the facet can be displayed. This property should not be used at the same time as `tabs-excluded`.\n\nSet this property as a stringified JSON array, e.g.,\n```html\n <atomic-facet tabs-included='[\"tabIDA\", \"tabIDB\"]'></atomic-facet>\n```\nIf you don't set this property, the facet can be displayed on any tab. Otherwise, the facet can only be displayed on the specified tabs.",
+          "docsTags": [],
+          "default": "'[]'",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "string[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "withSearch",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "with-search",
+          "reflectToAttr": true,
+          "docs": "Whether this facet should contain a search box.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [
+        {
+          "name": "clear-button",
+          "docs": "The button that resets the actively selected facet values."
+        },
+        {
+          "name": "clear-button-icon",
+          "docs": "The clear button icon."
+        },
+        {
+          "name": "facet",
+          "docs": "The wrapper for the entire facet."
+        },
+        {
+          "name": "label-button",
+          "docs": "The button that displays the label and allows to expand/collapse the facet."
+        },
+        {
+          "name": "label-button-icon",
+          "docs": "The label button icon."
+        },
+        {
+          "name": "matches-query",
+          "docs": "The highlighted query inside the matches labels."
+        },
+        {
+          "name": "more-matches",
+          "docs": "The label indicating there are more matches for the current facet search query."
+        },
+        {
+          "name": "no-matches",
+          "docs": "The label indicating there are no matches for the current facet search query."
+        },
+        {
+          "name": "placeholder",
+          "docs": "The placeholder shown before the first search is executed."
+        },
+        {
+          "name": "search-clear-button",
+          "docs": "The button to clear the search box of input."
+        },
+        {
+          "name": "search-highlight",
+          "docs": "The highlighted query inside the facet values."
+        },
+        {
+          "name": "search-icon",
+          "docs": "The search box submit button."
+        },
+        {
+          "name": "search-input",
+          "docs": "The search box input."
+        },
+        {
+          "name": "search-wrapper",
+          "docs": "The search box wrapper."
+        },
+        {
+          "name": "show-less",
+          "docs": "The show less results button."
+        },
+        {
+          "name": "show-more",
+          "docs": "The show more results button."
+        },
+        {
+          "name": "show-more-less-icon",
+          "docs": "The icons of the show more & show less buttons."
+        },
+        {
+          "name": "value-box",
+          "docs": "The facet value when display is 'box'."
+        },
+        {
+          "name": "value-box-selected",
+          "docs": "The selected facet value when display is 'box'."
+        },
+        {
+          "name": "value-checkbox",
+          "docs": "The facet value checkbox, available when display is 'checkbox'."
+        },
+        {
+          "name": "value-checkbox-checked",
+          "docs": "The checked facet value checkbox, available when display is 'checkbox'."
+        },
+        {
+          "name": "value-checkbox-icon",
+          "docs": "The facet value checkbox icon, available when display is 'checkbox'."
+        },
+        {
+          "name": "value-checkbox-label",
+          "docs": "The facet value checkbox clickable label, available when display is 'checkbox'."
+        },
+        {
+          "name": "value-count",
+          "docs": "The facet value count, common for all displays."
+        },
+        {
+          "name": "value-exclude-button",
+          "docs": "The button to exclude a facet value, available when display is 'checkbox'."
+        },
+        {
+          "name": "value-label",
+          "docs": "The facet value label, common for all displays."
+        },
+        {
+          "name": "value-link",
+          "docs": "The facet value when display is 'link'."
+        },
+        {
+          "name": "value-link-selected",
+          "docs": "The selected facet value when display is 'link'."
+        },
+        {
+          "name": "values",
+          "docs": "The facet values container."
+        }
+      ],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "src/components/search/atomic-facet-manager/atomic-facet-manager.tsx",
       "encapsulation": "none",