{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/cdn.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "Components", "declaration": { "name": "_Components", "module": "src/index.ts" } }, { "kind": "js", "name": "JSX", "declaration": { "name": "_Components", "module": "src/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/loader.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/versions.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/autoloader/index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/insight/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/insight/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/ipx/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/insight/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/insight/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/ipx/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/recommendations/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/insight/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/insight/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/ipx/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/insight/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/commerce/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/common/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/insight/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/ipx/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/recommendations/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/search/index.js" } } ] }, { "kind": "javascript-module", "path": "src/components/lazy-index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/converters/array-converter.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/converters/boolean-converter.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/converters/legacy-array-string-converter.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/decorators/bind-state.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/decorators/binding-guard.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/decorators/bindings.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/decorators/error-guard.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/decorators/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/decorators/watch.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/decorators/with-tailwind-styles.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/directives/hierarchical-path.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/directives/localized-string.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/directives/multi-class-map.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/generated/dayjs-locales-data.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/global/environment.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mixins/bindings-mixin.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mixins/children-update-complete-mixin.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mixins/item-section-mixin.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mixins/light-dom.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mixins/mixin-common.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/mixins/slots-for-no-shadow-dom-mixin.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/accessibility-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/asset-path-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/color-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/compare-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/date-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/dayjs-locales.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/debounce-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/device-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/dom-utils.ts", "declarations": [ { "kind": "function", "name": "closest", "return": { "type": { "text": "HTMLElementTagNameMap[K] | null" } }, "parameters": [ { "name": "element", "type": { "text": "Element | null" } }, { "name": "selector", "type": { "text": "K" } } ] }, { "kind": "function", "name": "closest", "return": { "type": { "text": "SVGElementTagNameMap[K] | null" } }, "parameters": [ { "name": "element", "type": { "text": "Element | null" } }, { "name": "selector", "type": { "text": "K" } } ] }, { "kind": "function", "name": "closest", "return": { "type": { "text": "E | null" } }, "parameters": [ { "name": "element", "type": { "text": "Element | null" } }, { "name": "selector", "type": { "text": "string" } } ] }, { "kind": "function", "name": "closest", "return": { "type": { "text": "HTMLElement | null" } }, "parameters": [ { "name": "element", "type": { "text": "Element | null" } }, { "name": "selector", "type": { "text": "string" } } ] } ], "exports": [ { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } }, { "kind": "js", "name": "closest", "declaration": { "name": "closest", "module": "src/utils/dom-utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/event-utils.ts", "declarations": [ { "kind": "function", "name": "listenOnce", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: HTMLElementEventMap[K]) => void" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ] }, { "kind": "function", "name": "listenOnce", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "type", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListenerOrEventListenerObject" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ] }, { "kind": "function", "name": "listenOnce", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "type", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListenerOrEventListenerObject" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ] } ], "exports": [ { "kind": "js", "name": "listenOnce", "declaration": { "name": "listenOnce", "module": "src/utils/event-utils.ts" } }, { "kind": "js", "name": "listenOnce", "declaration": { "name": "listenOnce", "module": "src/utils/event-utils.ts" } }, { "kind": "js", "name": "listenOnce", "declaration": { "name": "listenOnce", "module": "src/utils/event-utils.ts" } }, { "kind": "js", "name": "listenOnce", "declaration": { "name": "listenOnce", "module": "src/utils/event-utils.ts" } }, { "kind": "js", "name": "listenOnce", "declaration": { "name": "listenOnce", "module": "src/utils/event-utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/field-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/functional-component-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/hidden-state-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/init-queue.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/initialization-common-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/item-section-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/local-storage-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/memoize.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/object-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/promise-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/props-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/replace-breakpoint-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/resource-url-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/result-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/ripple-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/set.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/slot-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/string-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/tab-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/xss-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/lazy-index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/button-style.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/carousel.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/checkbox.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/fieldset-group.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/heading.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/icon-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/lazy-index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/radio-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/switch.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/table-element-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/triStateCheckbox.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/insight/index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/insight/lazy-index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/ipx/index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/ipx/lazy-index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/recommendations/index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/recommendations/lazy-index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/search/index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/search/lazy-index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/storybook-docs/e2e/storybook-docs.e2e.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/storybook-manager/e2e/storybook-manager.e2e.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-breadbox/atomic-commerce-breadbox.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-breadbox` component creates breadcrumbs that display a summary of the currently active facet values.", "name": "AtomicCommerceBreadbox", "cssParts": [ { "description": "The container of the whole component, list, and label.", "name": "container" }, { "description": "The container of the list of breadcrumb buttons.", "name": "breadcrumb-list-container" }, { "description": "The list of breadcrumb buttons.", "name": "breadcrumb-list" }, { "description": "A single breadcrumb button.", "name": "breadcrumb-button" }, { "description": "The breadcrumb label, associated with the facet.", "name": "breadcrumb-label" }, { "description": "The breadcrumb formatted value.", "name": "breadcrumb-value" }, { "description": "The button to clear individual filters.", "name": "breadcrumb-clear" }, { "description": "The button to display all breadcrumbs.", "name": "show-more" }, { "description": "The button to display less breadcrumbs.", "name": "show-less" }, { "description": "The \"Filters\" label.", "name": "label" }, { "description": "The button to clear all filters.", "name": "clear" } ], "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ pathLimit: new NumberValue({ default: 3, min: 1, required: false, }), })" }, { "kind": "field", "name": "resizeObserver", "type": { "text": "ResizeObserver | undefined" }, "privacy": "private" }, { "kind": "field", "name": "lastRemovedBreadcrumbIndex", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "numberOfBreadcrumbs", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "numberOfCollapsedBreadcrumbs", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "firstExpandedBreadcrumbIndex", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbRemovedFocus", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbShowMoreFocus", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbShowLessFocus", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbManager", "type": { "text": "BreadcrumbManager" }, "privacy": "private" }, { "kind": "field", "name": "context", "type": { "text": "Context" }, "privacy": "private" }, { "kind": "field", "name": "contextState", "type": { "text": "ContextState" }, "privacy": "private" }, { "kind": "field", "name": "searchOrListing", "type": { "text": "Search | ProductListing" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbManagerState", "type": { "text": "BreadcrumbManagerState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "isCollapsed", "type": { "text": "boolean" }, "privacy": "private", "default": "true" }, { "kind": "field", "name": "showMoreText", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "disableCollapse", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the collapsing behavior of breadcrumbs.\n\nWhen set, all breadcrumbs are always displayed in a wrapping layout\ninstead of being collapsed into a single row with a \"+ N\" show more button.", "attribute": "disable-collapse" }, { "kind": "field", "name": "breadboxAriaMessage", "privacy": "private", "default": "new AriaLiveRegionController(this, 'breadbox', true)" }, { "kind": "field", "name": "pathLimit", "type": { "text": "number" }, "default": "3", "description": "This prop allows you to control the display depth\nof the path by specifying the number of parent or ancestor\nbreadcrumbs links relative to the currently selected value.\n\nIf the path size is equal to or less than the pathLimit, all values in\nthe path will be displayed without truncation.\n\nIf the path size exceeds the pathLimit, it will truncate the path by\nreplacing the middle values with ellipses ('...').\n\nMinimum: `1`", "attribute": "path-limit" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "breadcrumbs", "privacy": "private", "readonly": true }, { "kind": "field", "name": "showMoreButton", "privacy": "private", "readonly": true }, { "kind": "field", "name": "showLessButton", "privacy": "private", "readonly": true }, { "kind": "method", "name": "hide", "privacy": "private", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "show", "privacy": "private", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "showAllBreadcrumbs", "privacy": "private" }, { "kind": "method", "name": "adaptBreadcrumbs", "privacy": "private" }, { "kind": "method", "name": "updateShowLessDisplay", "privacy": "private" }, { "kind": "method", "name": "hideOverflowingBreadcrumbs", "privacy": "private" }, { "kind": "field", "name": "isOverflowing", "privacy": "private", "readonly": true }, { "kind": "method", "name": "updateShowMoreValue", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "getNumberFormatter", "privacy": "private", "parameters": [ { "name": "field", "type": { "text": "string" } } ] }, { "kind": "field", "name": "valueForFacetType", "privacy": "private" }, { "kind": "method", "name": "buildBreadcrumb", "privacy": "private", "parameters": [ { "name": "breadcrumb", "type": { "text": "Breadcrumb" } } ] }, { "kind": "method", "name": "renderBreadcrumbs", "privacy": "private", "parameters": [ { "name": "breadcrumbs", "type": { "text": "BreadboxBreadcrumb[]" } } ] } ], "attributes": [ { "name": "disable-collapse", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the collapsing behavior of breadcrumbs.\n\nWhen set, all breadcrumbs are always displayed in a wrapping layout\ninstead of being collapsed into a single row with a \"+ N\" show more button.", "fieldName": "disableCollapse" }, { "name": "path-limit", "type": { "text": "number" }, "default": "3", "description": "This prop allows you to control the display depth\nof the path by specifying the number of parent or ancestor\nbreadcrumbs links relative to the currently selected value.\n\nIf the path size is equal to or less than the pathLimit, all values in\nthe path will be displayed without truncation.\n\nIf the path size exceeds the pathLimit, it will truncate the path by\nreplacing the middle values with ellipses ('...').\n\nMinimum: `1`", "fieldName": "pathLimit" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-breadbox", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceBreadbox", "declaration": { "name": "AtomicCommerceBreadbox", "module": "src/components/commerce/atomic-commerce-breadbox/atomic-commerce-breadbox.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-breadbox", "declaration": { "name": "AtomicCommerceBreadbox", "module": "src/components/commerce/atomic-commerce-breadbox/atomic-commerce-breadbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-category-facet/atomic-commerce-category-facet.ts", "declarations": [ { "kind": "class", "description": "A facet is a list of values for a certain field occurring in the products.\nAn `atomic-commerce-category-facet` displays a facet of values in a browsable, hierarchical fashion.", "name": "AtomicCommerceCategoryFacet", "cssParts": [ { "description": "The wrapper for the entire facet.", "name": "facet" }, { "description": "The placeholder shown before the first search is executed.", "name": "placeholder" }, { "description": "The button that displays the label and allows to expand/collapse the facet.", "name": "label-button" }, { "description": "The label button icon.", "name": "label-button-icon" }, { "description": "The search box wrapper.", "name": "search-wrapper" }, { "description": "The search box input.", "name": "search-input" }, { "description": "The search box submit button.", "name": "search-icon" }, { "description": "The button to clear the search box input.", "name": "search-clear-button" }, { "description": "The label indicating there are more matches for the current facet search query.", "name": "more-matches" }, { "description": "The label indicating there are no matches for the current facet search query.", "name": "no-matches" }, { "description": "The highlighted query inside the matches labels.", "name": "matches-query" }, { "description": "The facet search results container.", "name": "search-results" }, { "description": "The facet search result value.", "name": "search-result" }, { "description": "The facet search result path.", "name": "search-result-path" }, { "description": "The highlighted query inside the facet values.", "name": "search-highlight" }, { "description": "The container surrounding the whole hierarchy of values.", "name": "parents" }, { "description": "The container surrounding a sub-hierarchy of values.", "name": "sub-parents" }, { "description": "The container surrounding either the children of the active value or the values at the base.", "name": "values" }, { "description": "The \"All categories\" button displayed first within the parents.", "name": "all-categories-button" }, { "description": "The clickable parent button displayed first within sub-parents.", "name": "parent-button" }, { "description": "The clickable active parent displayed first within the last sub-parents.", "name": "active-parent" }, { "description": "The clickable value displayed first within values.", "name": "value-link" }, { "description": "The back arrow displayed before the clickable parents.", "name": "back-arrow" }, { "description": "The facet value label within a value button.", "name": "value-label" }, { "description": "The facet value count within a value button.", "name": "value-count" }, { "description": "A facet value with no child value.", "name": "leaf-value" }, { "description": "A facet value with child values.", "name": "node-value" }, { "description": "The \"Show more\" button.", "name": "show-more" }, { "description": "The \"Show less\" button.", "name": "show-less" }, { "description": "The icons of the \"Show more\" and \"Show less\" buttons.", "name": "show-more-less-icon" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "description": "The summary controller instance.", "attribute": "summary", "privacy": "private" }, { "kind": "field", "name": "facet", "type": { "text": "CategoryFacet" }, "privacy": "private", "description": "The category facet controller instance.", "attribute": "facet" }, { "kind": "field", "name": "isCollapsed", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the facet is collapsed.", "attribute": "is-collapsed", "reflects": true }, { "kind": "field", "name": "field", "type": { "text": "string" }, "description": "The field identifier for this facet.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "facetState", "type": { "text": "CategoryFacetState" }, "privacy": "private" }, { "kind": "field", "name": "summaryState", "type": { "text": "SearchSummaryState | ProductListingSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "resultIndexToFocusOnShowMore", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "showLessFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "showMoreFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "headerFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "activeValueFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "facetSearchAriaMessage", "privacy": "private", "default": "new AriaLiveRegionController(this, 'facet-search')" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "displayName", "privacy": "private", "readonly": true }, { "kind": "field", "name": "focusTargets", "privacy": "private", "readonly": true }, { "kind": "field", "name": "hasParents", "privacy": "private", "readonly": true }, { "kind": "method", "name": "renderHeader", "privacy": "private" }, { "kind": "method", "name": "renderValuesTree", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "parents", "type": { "text": "CategoryFacetValue[]" } }, { "name": "isRoot", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "renderChild", "privacy": "private", "parameters": [ { "name": "facetValue", "type": { "text": "CategoryFacetValue" } }, { "name": "isShowLessFocusTarget", "type": { "text": "boolean" } }, { "name": "isShowMoreFocusTarget", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "renderChildren", "privacy": "private" }, { "kind": "method", "name": "renderSearchResults", "privacy": "private" }, { "kind": "method", "name": "renderShowMoreLess", "privacy": "private" }, { "kind": "method", "name": "validateFacet", "privacy": "private" } ], "attributes": [ { "name": "is-collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the facet is collapsed.", "fieldName": "isCollapsed" }, { "name": "field", "type": { "text": "string" }, "description": "The field identifier for this facet.", "fieldName": "field" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-category-facet", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceCategoryFacet", "declaration": { "name": "AtomicCommerceCategoryFacet", "module": "src/components/commerce/atomic-commerce-category-facet/atomic-commerce-category-facet.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-category-facet", "declaration": { "name": "AtomicCommerceCategoryFacet", "module": "src/components/commerce/atomic-commerce-category-facet/atomic-commerce-category-facet.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-did-you-mean/atomic-commerce-did-you-mean.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-did-you-mean` component is responsible for handling query corrections. When a query returns no products but finds a possible query correction, the component either suggests the correction or automatically triggers a new query with the suggested term.", "name": "AtomicCommerceDidYouMean", "cssParts": [ { "description": "The text displayed when there are no products.", "name": "no-results" }, { "description": "The text displayed for the automatically corrected query.", "name": "auto-corrected" }, { "description": "The first paragraph of the text displayed when a query trigger changes a query.", "name": "showing-results-for" }, { "description": "The second paragraph of the text displayed when a query trigger changes a query.", "name": "search-instead-for" }, { "description": "The text displayed around the button to manually correct a query.", "name": "did-you-mean" }, { "description": "The button used to manually correct a query.", "name": "correction-btn" }, { "description": "The button used to undo a query changed by a query trigger.", "name": "undo-btn" }, { "description": "The query highlights.", "name": "highlight" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "didYouMean", "type": { "text": "DidYouMean" }, "privacy": "private" }, { "kind": "field", "name": "queryTrigger", "type": { "text": "QueryTrigger" }, "privacy": "private" }, { "kind": "field", "name": "didYouMeanState", "type": { "text": "DidYouMeanState" }, "privacy": "private" }, { "kind": "field", "name": "queryTriggerState", "type": { "text": "QueryTriggerState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "content", "privacy": "private", "readonly": true } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-did-you-mean", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceDidYouMean", "declaration": { "name": "AtomicCommerceDidYouMean", "module": "src/components/commerce/atomic-commerce-did-you-mean/atomic-commerce-did-you-mean.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-did-you-mean", "declaration": { "name": "AtomicCommerceDidYouMean", "module": "src/components/commerce/atomic-commerce-did-you-mean/atomic-commerce-did-you-mean.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-facet/atomic-commerce-facet.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-facet` component renders a commerce facet that the end user can interact with to filter products.", "name": "AtomicCommerceFacet", "cssParts": [ { "description": "The wrapper for the entire facet.", "name": "facet" }, { "description": "The placeholder shown before the first search is executed.", "name": "placeholder" }, { "description": "The button that displays the label and allows to expand/collapse the facet.", "name": "label-button" }, { "description": "The label button icon.", "name": "label-button-icon" }, { "description": "The button that resets the actively selected facet values.", "name": "clear-button" }, { "description": "The clear button icon.", "name": "clear-button-icon" }, { "description": "The facet search box wrapper.", "name": "search-wrapper" }, { "description": "The facet search box input.", "name": "search-input" }, { "description": "The facet search box submit button.", "name": "search-icon" }, { "description": "The button to clear the facet search box of input.", "name": "search-clear-button" }, { "description": "The label indicating there are more matches for the current facet search query.", "name": "more-matches" }, { "description": "The label indicating there are no matches for the current facet search query.", "name": "no-matches" }, { "description": "The highlighted query inside the matches labels.", "name": "matches-query" }, { "description": "The highlighted query inside the facet values.", "name": "search-highlight" }, { "description": "The facet values container.", "name": "values" }, { "description": "The facet value label, common for all displays.", "name": "value-label" }, { "description": "The facet value count, common for all displays.", "name": "value-count" }, { "description": "The facet value checkbox, available when display is 'checkbox'.", "name": "value-checkbox" }, { "description": "The checked facet value checkbox, available when display is 'checkbox'.", "name": "value-checkbox-checked" }, { "description": "The facet value checkbox clickable label, available when display is 'checkbox'.", "name": "value-checkbox-label" }, { "description": "The facet value checkbox icon, available when display is 'checkbox'.", "name": "value-checkbox-icon" }, { "description": "The show more values button.", "name": "show-more" }, { "description": "The show less values button.", "name": "show-less" }, { "description": "The icons of the show more and show less buttons.", "name": "show-more-less-icon" } ], "members": [ { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "description": "The Summary controller instance.", "attribute": "summary", "privacy": "private" }, { "kind": "field", "name": "facet", "type": { "text": "RegularFacet" }, "privacy": "private", "description": "The facet controller instance.", "attribute": "facet" }, { "kind": "field", "name": "isCollapsed", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the facet is collapsed.", "attribute": "is-collapsed", "reflects": true }, { "kind": "field", "name": "field", "type": { "text": "string" }, "description": "The field identifier for this facet.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "summaryState", "type": { "text": "SearchSummaryState | ProductListingSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "facetState", "type": { "text": "RegularFacetState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "showLessFocus", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "showMoreFocus", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "headerFocus", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "unsubscribeFacetController", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "ariaLiveRegion", "privacy": "private", "default": "new AriaLiveRegionController(this, 'facet-search')" }, { "kind": "field", "name": "valuesBeforeShowMore", "privacy": "private", "default": "new Set()" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "renderHeader", "privacy": "private" }, { "kind": "method", "name": "renderBody", "privacy": "private" }, { "kind": "method", "name": "renderValuesContainer", "privacy": "private", "parameters": [ { "name": "children", "type": { "text": "unknown" } }, { "name": "query", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "renderSearchResults", "privacy": "private" }, { "kind": "method", "name": "renderValues", "privacy": "private" }, { "kind": "method", "name": "renderShowMoreLess", "privacy": "private" }, { "kind": "method", "name": "renderMatches", "privacy": "private" }, { "kind": "field", "name": "activeValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "displayName", "privacy": "private", "readonly": true }, { "kind": "field", "name": "facetValueProps", "type": { "text": "Pick<\n FacetValueProps,\n 'facetSearchQuery' | 'enableExclusion' | 'field' | 'i18n' | 'displayValuesAs'\n >" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "initFocusTargets", "privacy": "private" }, { "kind": "method", "name": "initAriaLive", "privacy": "private" }, { "kind": "field", "name": "focusTargets", "type": { "text": "{\n showLess: FocusTargetController;\n showMore: FocusTargetController;\n header: FocusTargetController;\n }" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "isFacetState", "privacy": "private", "return": { "type": { "text": "state is RegularFacetState" } }, "parameters": [ { "name": "state", "type": { "text": "unknown" } }, { "name": "propName", "type": { "text": "string" } } ] }, { "kind": "method", "name": "ensureSubscribed", "privacy": "private" }, { "kind": "method", "name": "validateFacet", "privacy": "private" } ], "attributes": [ { "name": "is-collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the facet is collapsed.", "fieldName": "isCollapsed" }, { "name": "field", "type": { "text": "string" }, "description": "The field identifier for this facet.", "fieldName": "field" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-facet", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceFacet", "declaration": { "name": "AtomicCommerceFacet", "module": "src/components/commerce/atomic-commerce-facet/atomic-commerce-facet.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-facet", "declaration": { "name": "AtomicCommerceFacet", "module": "src/components/commerce/atomic-commerce-facet/atomic-commerce-facet.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-facet-number-input/atomic-commerce-facet-number-input.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-facets/atomic-commerce-facets.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-facets` component automatically renders commerce facets based on the Commerce API response.\nUnlike regular facets, which require explicit definition and request in the query, the `atomic-commerce-facets` component dynamically generates facets.", "name": "AtomicCommerceFacets", "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ collapseFacetsAfter: new NumberValue({min: -1, required: true}), })" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "facetGeneratorState", "type": { "text": "string[]" }, "privacy": "private" }, { "kind": "field", "name": "facetGenerator", "type": { "text": "FacetGenerator" }, "privacy": "private" }, { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "privacy": "private" }, { "kind": "field", "name": "collapseFacetsAfter", "type": { "text": "number" }, "privacy": "public", "default": "4", "description": "The maximum number of facets to expand.\nRemaining facets are automatically collapsed.\n\nUsing the value `0` collapses all facets.\nUsing the value `-1` disables the feature and keeps all facets expanded.", "attribute": "collapse-facets-after", "reflects": true }, { "kind": "field", "name": "isAppLoaded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "isProductListing", "privacy": "private" }, { "kind": "field", "name": "controllerBuilder", "privacy": "private", "readonly": true }, { "kind": "method", "name": "validateProps", "privacy": "private" }, { "kind": "method", "name": "shouldCollapseFacet", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "index", "type": { "text": "number" } }, { "name": "facet", "type": { "text": "MappedGeneratedFacetController[FacetType]" } } ] }, { "kind": "method", "name": "renderFacetPlaceholders", "privacy": "private" }, { "kind": "method", "name": "renderFacets", "privacy": "private" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "collapse-facets-after", "type": { "text": "number" }, "default": "4", "description": "The maximum number of facets to expand.\nRemaining facets are automatically collapsed.\n\nUsing the value `0` collapses all facets.\nUsing the value `-1` disables the feature and keeps all facets expanded.", "fieldName": "collapseFacetsAfter" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-facets", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceFacets", "declaration": { "name": "AtomicCommerceFacets", "module": "src/components/commerce/atomic-commerce-facets/atomic-commerce-facets.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-facets", "declaration": { "name": "AtomicCommerceFacets", "module": "src/components/commerce/atomic-commerce-facets/atomic-commerce-facets.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-interface/analytics-config.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-interface/atomic-commerce-interface.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-interface` component is the parent to all other atomic commerce components in a commerce page\n(except for `atomic-commerce-recommendation-list`, which must have\n`atomic-commerce-recommendation-interface` as a parent). It handles the headless commerce engine and localization\nconfigurations.", "name": "AtomicCommerceInterface", "slots": [ { "description": "The default slot where you can add child components to the interface.", "name": "default" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "context", "type": { "text": "Context" }, "privacy": "private" }, { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "privacy": "private" }, { "kind": "field", "name": "urlManager", "type": { "text": "UrlManager" }, "privacy": "public" }, { "kind": "field", "name": "searchOrListing", "type": { "text": "Search | ProductListing" }, "privacy": "public" }, { "kind": "field", "name": "unsubscribeUrlManager", "type": { "text": "Unsubscribe" }, "privacy": "private" }, { "kind": "field", "name": "unsubscribeSummary", "type": { "text": "Unsubscribe" }, "privacy": "private" }, { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "store", "type": { "text": "CommerceStore" }, "privacy": "private" }, { "kind": "field", "name": "i18Initialized", "type": { "text": "Promise" }, "privacy": "private", "default": "promise" }, { "kind": "field", "name": "interfaceController", "privacy": "private", "default": "new InterfaceController( this, 'CoveoAtomic', HEADLESS_VERSION )" }, { "kind": "field", "name": "type", "type": { "text": "'search' | 'product-listing'" }, "privacy": "public", "default": "'search'", "description": "The type of the interface.\n- 'search': Indicates that the interface is used for Search.\n- 'product-listing': Indicates that the interface is used for Product listing.", "attribute": "type", "reflects": true }, { "kind": "field", "name": "analytics", "type": { "text": "boolean" }, "privacy": "public", "default": "true", "description": "Whether analytics should be enabled.", "attribute": "analytics", "reflects": true }, { "kind": "field", "name": "logLevel", "type": { "text": "LogLevel" }, "privacy": "public", "description": "The minimum severity level of messages to log in the console.\nMessages with a severity level below this threshold will not be logged.\nPossible values are `trace`, `debug`, `info`, `warn`, `error`, `fatal`, or `silent`.", "attribute": "log-level", "reflects": true }, { "kind": "field", "name": "i18n", "type": { "text": "i18n" }, "privacy": "public", "description": "The commerce interface i18next instance." }, { "kind": "field", "name": "language", "type": { "text": "string" }, "privacy": "public", "description": "The commerce interface language.\n\nWill default to the value set in the Headless engine context if not\nprovided.", "deprecated": "- This property will be removed in the next major version of\nAtomic (v4). Rather than using this property, set the initial language\nthrough the engine configuration when calling `initializeWithEngine`, and\nupdate the language as needed using the `updateLocale` method.", "attribute": "language", "reflects": true }, { "kind": "field", "name": "engine", "type": { "text": "CommerceEngine | undefined" }, "privacy": "public", "description": "The commerce interface headless engine." }, { "kind": "field", "name": "reflectStateInUrl", "type": { "text": "boolean" }, "default": "true", "description": "Whether the state should be reflected in the URL parameters.", "deprecated": "- replaced by `disable-state-reflection-in-url` (this defaults to `true`, while the replacement defaults to `false`).", "attribute": "reflect-state-in-url", "reflects": true }, { "kind": "field", "name": "disableStateReflectionInUrl", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable state reflection in the URL parameters.", "attribute": "disable-state-reflection-in-url", "reflects": true }, { "kind": "field", "name": "scrollContainer", "type": { "text": "string" }, "privacy": "public", "default": "'atomic-commerce-interface'", "description": "The CSS selector for the container where the interface will scroll back to.", "attribute": "scroll-container", "reflects": true }, { "kind": "field", "name": "languageAssetsPath", "type": { "text": "string" }, "privacy": "public", "default": "'./lang'", "description": "The language assets path. By default, this will be a relative URL pointing to `./lang`.\n\nExample: \"/mypublicpath/languages\"", "attribute": "language-assets-path", "reflects": true }, { "kind": "field", "name": "iconAssetsPath", "type": { "text": "string" }, "privacy": "public", "default": "'./assets'", "description": "The icon assets path. By default, this will be a relative URL pointing to `./assets`.\n\nExample: \"/mypublicpath/icons\"", "attribute": "icon-assets-path", "reflects": true }, { "kind": "method", "name": "initialize", "privacy": "public", "parameters": [ { "name": "options", "type": { "text": "CommerceInitializationOptions" } } ], "description": "Initializes the connection with the headless commerce engine using the specified options." }, { "kind": "method", "name": "initializeWithEngine", "privacy": "public", "parameters": [ { "name": "engine", "type": { "text": "CommerceEngine" } } ], "description": "Initializes the connection with a preconfigured [headless commerce engine](https://docs.coveo.com/en/headless/latest/reference/interfaces/Commerce.CommerceEngine.html), as opposed to the `initialize` method, which internally creates a new commerce engine instance.\nThis bypasses the properties set on the component, such as analytics and language." }, { "kind": "method", "name": "executeFirstRequest", "privacy": "public", "description": "\nExecutes the first request after initializing connection to the headless commerce engine." }, { "kind": "method", "name": "updateLocale", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "language", "optional": true, "type": { "text": "string" }, "description": "(Optional) The IETF language code tag (for example, `en`)." }, { "name": "country", "optional": true, "type": { "text": "string" }, "description": "(Optional) The ISO-3166-1 country tag (for example, `US`)." }, { "name": "currency", "optional": true, "type": { "text": "CurrencyCodeISO4217" }, "description": "(Optional) The ISO-4217 currency code (for example, `USD`)." } ], "description": "Updates the locale settings for the commerce interface and headless commerce\nengine. Only the provided parameters will be updated.\n\nCalling this method affects the localization of the interface as well as\nthe catalog configuration being used by the Commerce API. If the resulting\nlanguage-country-currency combination matches no existing catalog\nconfiguration in your Coveo organization, requests made through the\ncommerce engine will start failing." }, { "kind": "method", "name": "toggleAnalytics", "privacy": "public" }, { "kind": "method", "name": "updateLanguage", "privacy": "public" }, { "kind": "method", "name": "updateIconAssetsPath", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "handleInitialization", "privacy": "private" }, { "kind": "method", "name": "getBindings", "privacy": "private", "return": { "type": { "text": "CommerceBindings" } } }, { "kind": "method", "name": "initEngine", "privacy": "private", "parameters": [ { "name": "options", "type": { "text": "CommerceInitializationOptions" } } ] }, { "kind": "field", "name": "fragment", "privacy": "private", "readonly": true }, { "kind": "method", "name": "initContext", "privacy": "private" }, { "kind": "method", "name": "initLanguage", "privacy": "private" }, { "kind": "method", "name": "initRequestStatus", "privacy": "private" }, { "kind": "method", "name": "initSummary", "privacy": "private" }, { "kind": "method", "name": "initUrlManager", "privacy": "private" }, { "kind": "method", "name": "internalInitialization", "privacy": "private", "parameters": [ { "name": "initEngine", "type": { "text": "() => void" } } ] }, { "kind": "method", "name": "isNewLocale", "privacy": "private", "parameters": [ { "name": "language", "optional": true, "type": { "text": "string" } }, { "name": "country", "optional": true, "type": { "text": "string" } }, { "name": "currency", "optional": true, "type": { "text": "string" } } ] }, { "kind": "field", "name": "onHashChange", "privacy": "private" }, { "kind": "method", "name": "scrollToTop", "privacy": "public" }, { "kind": "method", "name": "updateHash", "privacy": "private" }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "type", "type": { "text": "'search' | 'product-listing'" }, "default": "'search'", "description": "The type of the interface.\n- 'search': Indicates that the interface is used for Search.\n- 'product-listing': Indicates that the interface is used for Product listing.", "fieldName": "type" }, { "name": "analytics", "type": { "text": "boolean" }, "default": "true", "description": "Whether analytics should be enabled.", "fieldName": "analytics" }, { "name": "log-level", "type": { "text": "LogLevel" }, "description": "The minimum severity level of messages to log in the console.\nMessages with a severity level below this threshold will not be logged.\nPossible values are `trace`, `debug`, `info`, `warn`, `error`, `fatal`, or `silent`.", "fieldName": "logLevel" }, { "name": "language", "type": { "text": "string" }, "description": "The commerce interface language.\n\nWill default to the value set in the Headless engine context if not\nprovided.", "deprecated": "- This property will be removed in the next major version of\nAtomic (v4). Rather than using this property, set the initial language\nthrough the engine configuration when calling `initializeWithEngine`, and\nupdate the language as needed using the `updateLocale` method.", "fieldName": "language" }, { "name": "reflect-state-in-url", "type": { "text": "boolean" }, "default": "true", "description": "Whether the state should be reflected in the URL parameters.", "deprecated": "- replaced by `disable-state-reflection-in-url` (this defaults to `true`, while the replacement defaults to `false`).", "fieldName": "reflectStateInUrl" }, { "name": "disable-state-reflection-in-url", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable state reflection in the URL parameters.", "fieldName": "disableStateReflectionInUrl" }, { "name": "scroll-container", "type": { "text": "string" }, "default": "'atomic-commerce-interface'", "description": "The CSS selector for the container where the interface will scroll back to.", "fieldName": "scrollContainer" }, { "name": "language-assets-path", "type": { "text": "string" }, "default": "'./lang'", "description": "The language assets path. By default, this will be a relative URL pointing to `./lang`.\n\nExample: \"/mypublicpath/languages\"", "fieldName": "languageAssetsPath" }, { "name": "icon-assets-path", "type": { "text": "string" }, "default": "'./assets'", "description": "The icon assets path. By default, this will be a relative URL pointing to `./assets`.\n\nExample: \"/mypublicpath/icons\"", "fieldName": "iconAssetsPath" } ], "mixins": [ { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-interface", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceInterface", "declaration": { "name": "AtomicCommerceInterface", "module": "src/components/commerce/atomic-commerce-interface/atomic-commerce-interface.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-interface", "declaration": { "name": "AtomicCommerceInterface", "module": "src/components/commerce/atomic-commerce-interface/atomic-commerce-interface.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-interface/store.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-layout/atomic-commerce-layout.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-layout` helps organize elements in the commerce page.", "name": "AtomicCommerceLayout", "cssProperties": [ { "description": "The maximum width that the search box input will take.", "name": "--atomic-layout-max-search-box-input-width:" }, { "description": "The maximum width that the search box suggestions will take when displaying a double list.", "name": "--atomic-layout-max-search-box-double-suggestions-width:" }, { "description": "The width of the left list when displaying a double list.", "name": "--atomic-layout-search-box-left-suggestions-width:" } ], "members": [ { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "mobileBreakpoint", "type": { "text": "string" }, "default": "DEFAULT_MOBILE_BREAKPOINT", "description": "The viewport width at which the layout goes from desktop to mobile.\nFor example: 800px, 65rem.", "attribute": "mobile-breakpoint", "reflects": true }, { "kind": "field", "name": "layoutStylesController", "privacy": "private", "default": "new LayoutStylesController( this, buildCommerceLayout, 'atomic-commerce-layout-' )" }, { "kind": "method", "name": "emitBreakpointChangeEvent", "privacy": "private" }, { "kind": "method", "name": "onMobileBreakpointChange", "privacy": "public" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "mobile-breakpoint", "type": { "text": "string" }, "default": "DEFAULT_MOBILE_BREAKPOINT", "description": "The viewport width at which the layout goes from desktop to mobile.\nFor example: 800px, 65rem.", "fieldName": "mobileBreakpoint" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" }, { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-layout", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceLayout", "declaration": { "name": "AtomicCommerceLayout", "module": "src/components/commerce/atomic-commerce-layout/atomic-commerce-layout.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-layout", "declaration": { "name": "AtomicCommerceLayout", "module": "src/components/commerce/atomic-commerce-layout/atomic-commerce-layout.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-layout/atomic-commerce-layout.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-layout/commerce-layout.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-load-more-products/atomic-commerce-load-more-products.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-load-more-products` component allows the user to load additional products if more are available.", "name": "AtomicCommerceLoadMoreProducts", "cssProperties": [ { "description": "Color of the start of the gradient for the load more products progress bar.", "name": "--atomic-more-results-progress-bar-color-from" }, { "description": "Color of the end of the gradient for the load more products progress bar.", "name": "--atomic-more-results-progress-bar-color-to" } ], "cssParts": [ { "description": "The container of the component.", "name": "container" }, { "description": "The summary displaying which products are shown and how many are available.", "name": "showing-results" }, { "description": "The highlighted number of products displayed and number of products available.", "name": "highlight" }, { "description": "The progress bar displaying a percentage of products shown over the total number of products available.", "name": "progress-bar" }, { "description": "The \"Load more products\" button.", "name": "load-more-results-button" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "pagination", "type": { "text": "Pagination" }, "privacy": "private" }, { "kind": "field", "name": "listingOrSearch", "type": { "text": "ProductListing | Search" }, "privacy": "private" }, { "kind": "field", "name": "isAppLoaded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "paginationState", "type": { "text": "PaginationState" }, "privacy": "private" }, { "kind": "field", "name": "productListingOrSearchState", "type": { "text": "ProductListingState | SearchState" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "lastProduct", "privacy": "private", "readonly": true }, { "kind": "method", "name": "onClick", "privacy": "private" }, { "kind": "field", "name": "shouldRender", "privacy": "private", "readonly": true } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-load-more-products", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceLoadMoreProducts", "declaration": { "name": "AtomicCommerceLoadMoreProducts", "module": "src/components/commerce/atomic-commerce-load-more-products/atomic-commerce-load-more-products.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-load-more-products", "declaration": { "name": "AtomicCommerceLoadMoreProducts", "module": "src/components/commerce/atomic-commerce-load-more-products/atomic-commerce-load-more-products.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-no-products/atomic-commerce-no-products.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-no-products` component displays search tips when there are no products. Any additional content slotted inside of its element will be displayed as well.", "name": "AtomicCommerceNoProducts", "cssParts": [ { "description": "The text indicating that no products were found for the search.", "name": "no-results" }, { "description": "The search tips to help the user correct the query.", "name": "search-tips" }, { "description": "The highlighted query.", "name": "highlight" }, { "description": "The magnifying glass icon.", "name": "icon" } ], "slots": [ { "description": "Any additional content slotted inside of its element will be displayed as well.", "name": "default" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "privacy": "private" }, { "kind": "field", "name": "summaryState", "type": { "text": "SearchSummaryState | ProductListingSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "ariaMessage", "privacy": "protected", "default": "new AriaLiveRegionController(this, 'no-products')" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "renderNoItems", "privacy": "private" }, { "kind": "method", "name": "renderSearchTips", "privacy": "private" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-no-products", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceNoProducts", "declaration": { "name": "AtomicCommerceNoProducts", "module": "src/components/commerce/atomic-commerce-no-products/atomic-commerce-no-products.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-no-products", "declaration": { "name": "AtomicCommerceNoProducts", "module": "src/components/commerce/atomic-commerce-no-products/atomic-commerce-no-products.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-numeric-facet/atomic-commerce-numeric-facet.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-numeric-facet` component renders a commerce facet that allows the user to filter products using numeric ranges.", "name": "AtomicCommerceNumericFacet", "cssParts": [ { "description": "The wrapper around the entire facet.", "name": "facet" }, { "description": "The clickable label button that toggles facet visibility.", "name": "label-button" }, { "description": "The icon displayed in the label button (expand/collapse arrow).", "name": "label-button-icon" }, { "description": "The button to clear all selected facet values.", "name": "clear-button" }, { "description": "The icon displayed in the clear button.", "name": "clear-button-icon" }, { "description": "The list container for all facet values.", "name": "values" }, { "description": "The text label for individual facet values.", "name": "value-label" }, { "description": "The count indicator showing the number of products for each value.", "name": "value-count" }, { "description": "The label associated with facet value checkboxes.", "name": "value-checkbox-label" }, { "description": "The button to exclude specific facet values.", "name": "value-exclude-button" }, { "description": "The form container for numeric range inputs.", "name": "input-form" }, { "description": "The label for the minimum value input field.", "name": "label-start" }, { "description": "The input field to enter the minimum numeric value.", "name": "input-start" }, { "description": "The label for the maximum value input field.", "name": "label-end" }, { "description": "The input field to enter the maximum numeric value.", "name": "input-end" }, { "description": "The button to apply custom numeric range values.", "name": "input-apply-button" } ], "members": [ { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "description": "The Summary controller instance.", "attribute": "summary", "privacy": "private" }, { "kind": "field", "name": "facet", "type": { "text": "NumericFacet" }, "description": "The facet controller instance.", "attribute": "facet", "privacy": "private" }, { "kind": "field", "name": "isCollapsed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the facet is collapsed.", "attribute": "is-collapsed", "reflects": true }, { "kind": "field", "name": "field", "type": { "text": "string" }, "description": "The field identifier for this facet.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "context", "type": { "text": "Context" }, "privacy": "private" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "facetState", "type": { "text": "NumericFacetState" }, "privacy": "private" }, { "kind": "field", "name": "summaryState", "type": { "text": "SearchSummaryState | ProductListingSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "contextState", "type": { "text": "ContextState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "headerFocus", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "unsubscribeFacetController", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "formatter", "privacy": "private", "readonly": true }, { "kind": "field", "name": "focusTarget", "type": { "text": "FocusTargetController" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "displayName", "privacy": "private", "readonly": true }, { "kind": "field", "name": "numberOfSelectedValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "hasInputRange", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "valuesToRender", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderInput", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderFacet", "privacy": "private", "readonly": true }, { "kind": "method", "name": "ensureSubscribed", "privacy": "private" }, { "kind": "method", "name": "renderValues", "privacy": "private" }, { "kind": "method", "name": "onNumberInputApply", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "validateFacet", "privacy": "private" } ], "attributes": [ { "name": "is-collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the facet is collapsed.", "fieldName": "isCollapsed" }, { "name": "field", "type": { "text": "string" }, "description": "The field identifier for this facet.", "fieldName": "field" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-numeric-facet", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceNumericFacet", "declaration": { "name": "AtomicCommerceNumericFacet", "module": "src/components/commerce/atomic-commerce-numeric-facet/atomic-commerce-numeric-facet.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-numeric-facet", "declaration": { "name": "AtomicCommerceNumericFacet", "module": "src/components/commerce/atomic-commerce-numeric-facet/atomic-commerce-numeric-facet.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-pager/atomic-commerce-pager.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-pager` component enables users to navigate through paginated products.", "name": "AtomicCommercePager", "cssParts": [ { "description": "The list of all buttons rendered by the component.", "name": "buttons" }, { "description": "The list of all page buttons.", "name": "page-buttons" }, { "description": "The individual page buttons.", "name": "page-button" }, { "description": "The active page button.", "name": "active-page-button" }, { "description": "The \"previous page\" button.", "name": "previous-button" }, { "description": "The \"next page\" button.", "name": "next-button" }, { "description": "The \"previous page\" button icon.", "name": "previous-button-icon" }, { "description": "The \"next page\" button icon.", "name": "next-button-icon" } ], "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ numberOfPages: new NumberValue({min: 0}), })" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "isAppLoaded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "pager", "type": { "text": "Pagination" }, "privacy": "private" }, { "kind": "field", "name": "listingOrSearch", "type": { "text": "ProductListing | Search" }, "privacy": "private" }, { "kind": "field", "name": "pagerState", "type": { "text": "PaginationState" }, "privacy": "private" }, { "kind": "field", "name": "numberOfPages", "type": { "text": "number" }, "default": "5", "description": "The maximum number of page buttons to display.", "attribute": "number-of-pages", "reflects": true }, { "kind": "field", "name": "previousButtonIcon", "type": { "text": "string" }, "default": "ArrowLeftIcon", "description": "The SVG icon to use to display the Previous button.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.", "attribute": "previous-button-icon", "reflects": true }, { "kind": "field", "name": "nextButtonIcon", "type": { "text": "string" }, "default": "ArrowRightIcon", "description": "The SVG icon to use to display the Next button.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.", "attribute": "next-button-icon", "reflects": true }, { "kind": "field", "name": "ariaMessage", "privacy": "protected", "default": "new AriaLiveRegionController(this, 'atomic-pager')" }, { "kind": "field", "name": "previousButton", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "nextButton", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "initFocusTargets", "privacy": "private" }, { "kind": "method", "name": "focusOnFirstResultAndScrollToTop", "privacy": "private" }, { "kind": "method", "name": "announcePageLoaded", "privacy": "private" } ], "events": [ { "description": "Emitted when the user clicks the next or previous button, or a page button.", "name": "atomic/scrollToTop" } ], "attributes": [ { "name": "number-of-pages", "type": { "text": "number" }, "default": "5", "description": "The maximum number of page buttons to display.", "fieldName": "numberOfPages" }, { "name": "previous-button-icon", "type": { "text": "string" }, "default": "ArrowLeftIcon", "description": "The SVG icon to use to display the Previous button.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.", "fieldName": "previousButtonIcon" }, { "name": "next-button-icon", "type": { "text": "string" }, "default": "ArrowRightIcon", "description": "The SVG icon to use to display the Next button.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.", "fieldName": "nextButtonIcon" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-commerce-pager", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommercePager", "declaration": { "name": "AtomicCommercePager", "module": "src/components/commerce/atomic-commerce-pager/atomic-commerce-pager.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-pager", "declaration": { "name": "AtomicCommercePager", "module": "src/components/commerce/atomic-commerce-pager/atomic-commerce-pager.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-product-list/atomic-commerce-product-list.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-product-list` component is responsible for displaying products.", "name": "AtomicCommerceProductList", "cssParts": [ { "description": "The outline of each product when the display prop is set to \"grid\" or \"list\".", "name": "outline" }, { "description": "The element containing all products when the display prop is set to \"grid\" or \"list\".", "name": "result-list" }, { "description": "The clickable wrapper containing each product when the display prop is set to \"grid\".", "name": "result-list-grid-clickable-container" }, { "description": "The table element when the display prop is set to \"table\".", "name": "result-table" }, { "description": "The thead element when the display prop is set to \"table\".", "name": "result-table-heading" }, { "description": "The tr element nested under the thead when the display prop is set to \"table\".", "name": "result-table-heading-row" }, { "description": "The `th` elements nested under `thead` > `tr` when the display prop is set to \"table\".", "name": "result-table-heading-cell" }, { "description": "The tbody element when the display prop is set to \"table\".", "name": "result-table-body" }, { "description": "All tr elements nested under tbody when the display prop is set to \"table\".", "name": "result-table-row" }, { "description": "The even tr elements nested under tbody when the display prop is set to \"table\".", "name": "result-table-row-even" }, { "description": "The odd tr elements nested under tbody when the display prop is set to \"table\".", "name": "result-table-row-odd" }, { "description": "The `td` elements nested under each `tbody` > `tr` when the display prop is set to \"table\".", "name": "result-table-cell" } ], "slots": [ { "description": "The default slot where the product templates are defined.", "name": "default" } ], "members": [ { "kind": "field", "name": "searchOrListing", "type": { "text": "Search | ProductListing" }, "privacy": "private" }, { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "privacy": "private" }, { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ density: new StringValue({ constrainTo: ['normal', 'comfortable', 'compact'], }), display: new StringValue({constrainTo: ['grid', 'list', 'table']}), imageSize: new StringValue({ constrainTo: ['small', 'large', 'icon', 'none'], }), numberOfPlaceholders: new NumberValue({min: 0}), })" }, { "kind": "field", "name": "itemRenderingFunction", "type": { "text": "ItemRenderingFunction" }, "privacy": "private" }, { "kind": "field", "name": "loadingFlag", "privacy": "private" }, { "kind": "field", "name": "nextNewResultTarget", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "productListCommon", "type": { "text": "ItemListCommon" }, "privacy": "private" }, { "kind": "field", "name": "productTemplateProvider", "type": { "text": "ProductTemplateProvider" }, "privacy": "private" }, { "kind": "field", "name": "unsubscribeSummary", "type": { "text": "() => void" }, "privacy": "private" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "isAppLoaded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "isEveryProductReady", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "resultTemplateRegistered", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "templateHasError", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "searchOrListingState", "type": { "text": "SearchState | ProductListingState" }, "privacy": "private" }, { "kind": "field", "name": "summaryState", "type": { "text": "SearchSummaryState | ProductListingSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "density", "type": { "text": "ItemDisplayDensity" }, "privacy": "public", "default": "'normal'", "description": "The spacing of various elements in the product list, including the gap between products, the gap between parts of a\nproduct, and the font sizes of different parts in a product.", "attribute": "density", "reflects": true }, { "kind": "field", "name": "display", "type": { "text": "ItemDisplayLayout" }, "privacy": "public", "default": "'grid'", "description": "The desired layout to use when displaying products. Layouts affect how many products to display per row and how\nvisually distinct they are from each other.", "attribute": "display", "reflects": true }, { "kind": "field", "name": "imageSize", "type": { "text": "ItemDisplayImageSize" }, "privacy": "public", "default": "'small'", "description": "The expected size of the image displayed for products.", "attribute": "image-size", "reflects": true }, { "kind": "field", "name": "numberOfPlaceholders", "type": { "text": "number" }, "default": "24", "description": "The desired number of placeholders to display while the product list is loading.", "attribute": "number-of-placeholders", "reflects": true }, { "kind": "method", "name": "setRenderFunction", "privacy": "public", "parameters": [ { "name": "productRenderingFunction", "type": { "text": "ItemRenderingFunction" } } ], "description": "Sets a rendering function to bypass the standard HTML template mechanism for rendering products.\nYou can use this function while working with web frameworks that don't use plain HTML syntax such as React, Angular,\nor Vue.\n\nDo not use this method if you integrate Atomic in a plain HTML deployment." }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "updateProductsReadyState", "privacy": "private" }, { "kind": "method", "name": "validateProps", "privacy": "private" }, { "kind": "method", "name": "initSearchOrListing", "privacy": "private" }, { "kind": "method", "name": "initSummary", "privacy": "private" }, { "kind": "method", "name": "initProductTemplateProvider", "privacy": "private" }, { "kind": "method", "name": "initProductListCommon", "privacy": "private" }, { "kind": "method", "name": "createSelectChildProductListener", "privacy": "private" }, { "kind": "method", "name": "selectChildProductCallback", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "computeListDisplayClasses", "privacy": "private" }, { "kind": "method", "name": "getProductId", "privacy": "private", "parameters": [ { "name": "product", "type": { "text": "ProductListingState['products'][number]" } } ] }, { "kind": "method", "name": "renderGrid", "privacy": "private" }, { "kind": "method", "name": "renderList", "privacy": "private" }, { "kind": "method", "name": "renderTable", "privacy": "private" }, { "kind": "field", "name": "focusTarget", "privacy": "private", "readonly": true }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "density", "type": { "text": "ItemDisplayDensity" }, "default": "'normal'", "description": "The spacing of various elements in the product list, including the gap between products, the gap between parts of a\nproduct, and the font sizes of different parts in a product.", "fieldName": "density" }, { "name": "display", "type": { "text": "ItemDisplayLayout" }, "default": "'grid'", "description": "The desired layout to use when displaying products. Layouts affect how many products to display per row and how\nvisually distinct they are from each other.", "fieldName": "display" }, { "name": "image-size", "type": { "text": "ItemDisplayImageSize" }, "default": "'small'", "description": "The expected size of the image displayed for products.", "fieldName": "imageSize" }, { "name": "number-of-placeholders", "type": { "text": "number" }, "default": "24", "description": "The desired number of placeholders to display while the product list is loading.", "fieldName": "numberOfPlaceholders" } ], "mixins": [ { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-product-list", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceProductList", "declaration": { "name": "AtomicCommerceProductList", "module": "src/components/commerce/atomic-commerce-product-list/atomic-commerce-product-list.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-product-list", "declaration": { "name": "AtomicCommerceProductList", "module": "src/components/commerce/atomic-commerce-product-list/atomic-commerce-product-list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-products-per-page/atomic-commerce-products-per-page.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-products-per-page` component lets the end user select how many products to display per page.", "name": "AtomicCommerceProductsPerPage", "cssParts": [ { "description": "The \"Products per page\" label.", "name": "label" }, { "description": "The list of buttons.", "name": "buttons" }, { "description": "The individual products per page buttons.", "name": "button" }, { "description": "The active products per page button.", "name": "active-button" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "pagination", "type": { "text": "Pagination" }, "privacy": "private" }, { "kind": "field", "name": "paginationState", "type": { "text": "PaginationState" }, "privacy": "private" }, { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "privacy": "private" }, { "kind": "field", "name": "summaryState", "type": { "text": "SearchSummaryState | ProductListingSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "isAppLoaded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "choices", "type": { "text": "number[]" }, "privacy": "private" }, { "kind": "field", "name": "radioGroupName", "privacy": "private", "readonly": true }, { "kind": "field", "name": "choicesDisplayed", "type": { "text": "string" }, "default": "'10,25,50,100'", "description": "A list of choices for the number of products to display per page, separated by commas.", "attribute": "choices-displayed", "reflects": true }, { "kind": "field", "name": "initialChoice", "type": { "text": "number" }, "description": "The initial selection for the number of product per page. This should be part of the `choicesDisplayed` option. By default, this is set to the first value in `choicesDisplayed`.", "attribute": "initial-choice", "reflects": true }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "scrollToTopEvent", "privacy": "private" }, { "kind": "field", "name": "label", "privacy": "private", "readonly": true } ], "attributes": [ { "name": "choices-displayed", "type": { "text": "string" }, "default": "'10,25,50,100'", "description": "A list of choices for the number of products to display per page, separated by commas.", "fieldName": "choicesDisplayed" }, { "name": "initial-choice", "type": { "text": "number" }, "description": "The initial selection for the number of product per page. This should be part of the `choicesDisplayed` option. By default, this is set to the first value in `choicesDisplayed`.", "fieldName": "initialChoice" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-products-per-page", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceProductsPerPage", "declaration": { "name": "AtomicCommerceProductsPerPage", "module": "src/components/commerce/atomic-commerce-products-per-page/atomic-commerce-products-per-page.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-products-per-page", "declaration": { "name": "AtomicCommerceProductsPerPage", "module": "src/components/commerce/atomic-commerce-products-per-page/atomic-commerce-products-per-page.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-query-error/atomic-commerce-query-error.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-query-error` component handles fatal errors when performing a query on the Commerce API. When the error is known, it displays a link to relevant documentation for debugging purposes. When the error is unknown, it displays a small text area with the JSON content of the error.", "name": "AtomicCommerceQueryError", "cssParts": [ { "description": "The SVG related to the error.", "name": "icon" }, { "description": "The title of the error.", "name": "title" }, { "description": "A description of the error.", "name": "description" }, { "description": "A link to the relevant documentation.", "name": "doc-link" }, { "description": "A button to request additional error information.", "name": "more-info-btn" }, { "description": "Additional error information.", "name": "error-info" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "searchOrListing", "type": { "text": "Search | ProductListing" }, "privacy": "private" }, { "kind": "field", "name": "searchOrListingState", "type": { "text": "SearchState | ProductListingState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "showMoreInfo", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "ariaMessage", "privacy": "protected", "default": "new AriaLiveRegionController(this, 'commerce-query-error')" }, { "kind": "method", "name": "initialize", "privacy": "public" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-query-error", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceQueryError", "declaration": { "name": "AtomicCommerceQueryError", "module": "src/components/commerce/atomic-commerce-query-error/atomic-commerce-query-error.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-query-error", "declaration": { "name": "AtomicCommerceQueryError", "module": "src/components/commerce/atomic-commerce-query-error/atomic-commerce-query-error.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-query-summary/atomic-commerce-query-summary.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-query-summary` component displays information about the current range of products (for example, \"Products 1-10 of 123\").", "name": "AtomicCommerceQuerySummary", "cssParts": [ { "description": "The container for the whole summary.", "name": "container" }, { "description": "The summary highlights.", "name": "highlight" }, { "description": "The summary highlighted query.", "name": "query" }, { "description": "The query summary placeholder used while the commerce interface is initializing.", "name": "placeholder" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "listingOrSearchSummaryState", "type": { "text": "SearchSummaryState | ProductListingSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "listingOrSearchSummary", "type": { "text": "Summary" }, "privacy": "private" }, { "kind": "field", "name": "ariaMessage", "privacy": "protected", "default": "new AriaLiveRegionController(this, 'query-summary')" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "isSearch", "privacy": "private", "return": { "type": { "text": "state is SearchSummaryState" } }, "parameters": [ { "name": "state", "type": { "text": "ProductListingSummaryState | SearchSummaryState" } } ] } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-query-summary", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceQuerySummary", "declaration": { "name": "AtomicCommerceQuerySummary", "module": "src/components/commerce/atomic-commerce-query-summary/atomic-commerce-query-summary.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-query-summary", "declaration": { "name": "AtomicCommerceQuerySummary", "module": "src/components/commerce/atomic-commerce-query-summary/atomic-commerce-query-summary.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-recommendation-interface/atomic-commerce-recommendation-interface.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-recommendation-interface` component is meant to be used\nas the parent of one or more `atomic-commerce-recommendation-list`\ncomponents. It handles the headless engine and localization\nconfigurations.", "name": "AtomicCommerceRecommendationInterface", "slots": [ { "description": "The default slot where you can add child components to the interface.", "name": "default" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "context", "type": { "text": "Context" }, "privacy": "private" }, { "kind": "field", "name": "store", "type": { "text": "CommerceRecommendationStore" }, "privacy": "private" }, { "kind": "field", "name": "interfaceController", "privacy": "private", "default": "new InterfaceController( this, 'CoveoAtomic', HEADLESS_VERSION )" }, { "kind": "field", "name": "i18n", "type": { "text": "i18n" }, "description": "The commerce interface i18next instance." }, { "kind": "field", "name": "engine", "type": { "text": "CommerceEngine | undefined" }, "description": "The commerce interface headless engine." }, { "kind": "field", "name": "scrollContainer", "type": { "text": "string" }, "default": "'atomic-commerce-recommendation-interface'", "description": "The CSS selector for the container the interface will scroll back to.", "attribute": "scroll-container", "reflects": true }, { "kind": "field", "name": "languageAssetsPath", "type": { "text": "string" }, "default": "'./lang'", "description": "The language assets path. By default, this will be a relative URL pointing to `./lang`.\n\nExample: \"/mypublicpath/languages\"", "attribute": "language-assets-path", "reflects": true }, { "kind": "field", "name": "iconAssetsPath", "type": { "text": "string" }, "default": "'./assets'", "description": "The icon assets path. By default, this will be a relative URL pointing to `./assets`.\n\nExample: \"/mypublicpath/icons\"", "attribute": "icon-assets-path", "reflects": true }, { "kind": "field", "name": "language", "type": { "text": "string" }, "description": "The commerce interface language.\n\nWill default to the value set in the Headless engine context if not\nprovided.", "deprecated": "- This property will be removed in the next major version of\nAtomic (v4). Rather than using this property, set the initial language\nthrough the engine configuration when calling `initializeWithEngine`, and\nupdate the language as needed using the `updateLocale` method.", "attribute": "language", "reflects": true }, { "kind": "field", "name": "analytics", "type": { "text": "boolean" }, "default": "true", "description": "Whether to enable analytics.", "attribute": "analytics", "reflects": true }, { "kind": "field", "name": "i18Initialized", "type": { "text": "Promise" }, "privacy": "private", "default": "promise" }, { "kind": "method", "name": "initializeWithEngine", "privacy": "public", "parameters": [ { "name": "engine", "type": { "text": "CommerceEngine" } } ], "description": "Initializes the connection with an already preconfigured [headless commerce engine](https://docs.coveo.com/en/headless/latest/reference/interfaces/Commerce.CommerceEngine.html)." }, { "kind": "method", "name": "updateLocale", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "language", "optional": true, "type": { "text": "string" }, "description": "(Optional) The IETF language code tag (for example, `en`)." }, { "name": "country", "optional": true, "type": { "text": "string" }, "description": "(Optional) The ISO-3166-1 country tag (for example, `US`)." }, { "name": "currency", "optional": true, "type": { "text": "CurrencyCodeISO4217" }, "description": "(Optional) The ISO-4217 currency code (for example, `USD`)." } ], "description": "Updates the locale settings for the commerce recommendation interface and\nheadless commerce engine. Only the provided parameters will be updated.\n\nCalling this method affects the localization of the interface as well as\nthe catalog configuration being used by the Commerce API. If the resulting\nlanguage-country-currency combination matches no existing catalog\nconfiguration in your Coveo organization, requests made through the\ncommerce engine will start failing." }, { "kind": "method", "name": "toggleAnalytics", "privacy": "public" }, { "kind": "method", "name": "updateIconAssetsPath", "privacy": "public" }, { "kind": "method", "name": "updateLanguage", "privacy": "public" }, { "kind": "field", "name": "handleInitialization", "privacy": "private" }, { "kind": "method", "name": "scrollToTop", "privacy": "private" }, { "kind": "method", "name": "internalInitialization", "privacy": "private", "parameters": [ { "name": "initEngine", "type": { "text": "() => void" } } ] }, { "kind": "method", "name": "initContext", "privacy": "private" }, { "kind": "method", "name": "getBindings", "privacy": "private", "return": { "type": { "text": "CommerceBindings" } } }, { "kind": "method", "name": "initLanguage", "privacy": "private" }, { "kind": "method", "name": "isNewLocale", "privacy": "private", "parameters": [ { "name": "language", "optional": true, "type": { "text": "string" } }, { "name": "country", "optional": true, "type": { "text": "string" } }, { "name": "currency", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "scroll-container", "type": { "text": "string" }, "default": "'atomic-commerce-recommendation-interface'", "description": "The CSS selector for the container the interface will scroll back to.", "fieldName": "scrollContainer" }, { "name": "language-assets-path", "type": { "text": "string" }, "default": "'./lang'", "description": "The language assets path. By default, this will be a relative URL pointing to `./lang`.\n\nExample: \"/mypublicpath/languages\"", "fieldName": "languageAssetsPath" }, { "name": "icon-assets-path", "type": { "text": "string" }, "default": "'./assets'", "description": "The icon assets path. By default, this will be a relative URL pointing to `./assets`.\n\nExample: \"/mypublicpath/icons\"", "fieldName": "iconAssetsPath" }, { "name": "language", "type": { "text": "string" }, "description": "The commerce interface language.\n\nWill default to the value set in the Headless engine context if not\nprovided.", "deprecated": "- This property will be removed in the next major version of\nAtomic (v4). Rather than using this property, set the initial language\nthrough the engine configuration when calling `initializeWithEngine`, and\nupdate the language as needed using the `updateLocale` method.", "fieldName": "language" }, { "name": "analytics", "type": { "text": "boolean" }, "default": "true", "description": "Whether to enable analytics.", "fieldName": "analytics" } ], "mixins": [ { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-recommendation-interface", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceRecommendationInterface", "declaration": { "name": "AtomicCommerceRecommendationInterface", "module": "src/components/commerce/atomic-commerce-recommendation-interface/atomic-commerce-recommendation-interface.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-recommendation-interface", "declaration": { "name": "AtomicCommerceRecommendationInterface", "module": "src/components/commerce/atomic-commerce-recommendation-interface/atomic-commerce-recommendation-interface.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-recommendation-interface/store.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-recommendation-list/atomic-commerce-recommendation-list.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-recommendation-list` component displays a list of product recommendations by applying one or more product templates.", "name": "AtomicCommerceRecommendationList", "cssProperties": [ { "description": "The number of columns in the grid.", "name": "--atomic-recs-number-of-columns" }, { "description": "The number of rows in the grid.", "name": "--atomic-recs-number-of-rows" } ], "cssParts": [ { "description": "The element containing the list of product recommendations.", "name": "result-list" }, { "description": "The parent of a recommended product and the clickable link encompassing it.", "name": "result-list-grid-clickable-container" }, { "description": "The clickable link encompassing a recommended product.", "name": "result-list-grid-clickable" }, { "description": "The outline of a recommended product.", "name": "outline" }, { "description": "The label of the recommendation list.", "name": "label" }, { "description": "The previous button.", "name": "previous-button" }, { "description": "The next button.", "name": "next-button" }, { "description": "The list of indicators.", "name": "indicators" }, { "description": "A single indicator.", "name": "indicator" }, { "description": "The active indicator.", "name": "active-indicator" } ], "slots": [ { "description": "The default slot where the product templates are defined.", "name": "default" } ], "members": [ { "kind": "field", "name": "recommendations", "type": { "text": "Recommendations" }, "privacy": "private" }, { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "privacy": "private" }, { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ density: new StringValue({ constrainTo: ['normal', 'comfortable', 'compact'], }), display: new StringValue({constrainTo: ['grid', 'list', 'table']}), imageSize: new StringValue({ constrainTo: ['small', 'large', 'icon', 'none'], }), productsPerPage: new NumberValue({min: 0}), slotId: new StringValue({emptyAllowed: false}), })" }, { "kind": "field", "name": "itemRenderingFunction", "type": { "text": "ItemRenderingFunction" }, "privacy": "private" }, { "kind": "field", "name": "loadingFlag", "privacy": "private" }, { "kind": "field", "name": "nextNewProductTarget", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "productListCommon", "type": { "text": "ItemListCommon" }, "privacy": "private" }, { "kind": "field", "name": "productTemplateProvider", "type": { "text": "ProductTemplateProvider" }, "privacy": "private" }, { "kind": "field", "name": "unsubscribeSummary", "type": { "text": "() => void" }, "privacy": "private" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "isAppLoaded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "productTemplateRegistered", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "templateHasError", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "isEveryProductReady", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "recommendationsState", "type": { "text": "RecommendationsState" }, "privacy": "private" }, { "kind": "field", "name": "summaryState", "type": { "text": "RecommendationsSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "currentPage", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "slotId", "type": { "text": "string" }, "privacy": "public", "description": "The identifier used by the Commerce API to retrieve the desired recommendation list for the component.\nYou can configure recommendation lists and get their respective slot IDs through the Coveo Merchandising Hub (CMH).\nYou can include multiple `atomic-commerce-recommendation-list` components with different slot IDs in the same page to display several recommendation lists.", "attribute": "slot-id", "reflects": true }, { "kind": "field", "name": "productId", "type": { "text": "string" }, "privacy": "public", "description": "The unique identifier of the product to use for seeded recommendations.", "attribute": "product-id", "reflects": true }, { "kind": "field", "name": "display", "type": { "text": "ItemDisplayBasicLayout" }, "privacy": "public", "default": "'list'", "description": "The layout to apply when displaying the products. This does not affect the display of the surrounding list itself.\nTo modify the number of products per column and row, modify the `--atomic-recs-number-of-columns` and `--atomic-recs-number-of-rows` CSS variables.", "attribute": "display", "reflects": true }, { "kind": "field", "name": "density", "type": { "text": "ItemDisplayDensity" }, "privacy": "public", "default": "'normal'", "description": "The spacing of various elements in the product list, including the gap between products, the gap between parts of a product, and the font sizes of the parts of a product.", "attribute": "density", "reflects": true }, { "kind": "field", "name": "imageSize", "type": { "text": "ItemDisplayImageSize" }, "privacy": "public", "default": "'small'", "description": "The expected size of the image displayed on the recommended products.", "attribute": "image-size", "reflects": true }, { "kind": "field", "name": "productsPerPage", "type": { "text": "number" }, "privacy": "public", "description": "The number of products to display per page.\nThe products will be displayed in a carousel if this property is set.\nThis does not affect the display of the list itself, only the number of recommendation pages.\nIf you want to display the recommendations in a carousel with a single row, set the `--atomic-recs-number-of-columns` CSS variable to the same value as this property.", "attribute": "products-per-page", "reflects": true }, { "kind": "field", "name": "headingLevel", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The [heading level](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements) to use for the heading label, from 1 to 6.\nWhen set to 0, a `div` will be used instead of an Heading Element.", "attribute": "heading-level", "reflects": true }, { "kind": "method", "name": "watchNumberOfRecommendationsPerPage", "privacy": "public" }, { "kind": "method", "name": "setRenderFunction", "privacy": "public", "parameters": [ { "name": "productRenderingFunction", "type": { "text": "ItemRenderingFunction" } } ], "description": "Sets a rendering function to bypass the standard HTML template mechanism when rendering products.\nYou can use this function while working with web frameworks that don't use plain HTML syntax such as React, Angular, or Vue.\n\nDo not use this method if you integrate Atomic in a plain HTML implementation." }, { "kind": "method", "name": "previousPage", "privacy": "public", "description": "Moves to the previous page, when the carousel is activated." }, { "kind": "method", "name": "nextPage", "privacy": "public", "description": "Moves to the next page, when the carousel is activated." }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "updateProductsReadyState", "privacy": "private" }, { "kind": "field", "name": "focusTarget", "privacy": "private", "readonly": true }, { "kind": "field", "name": "augmentedRecommendationListState", "privacy": "private", "readonly": true }, { "kind": "method", "name": "validateProps", "privacy": "private" }, { "kind": "method", "name": "validateSlotID", "privacy": "private" }, { "kind": "method", "name": "renderListHeading", "privacy": "private" }, { "kind": "field", "name": "subsetRecommendations", "privacy": "private", "readonly": true }, { "kind": "field", "name": "numberOfPages", "privacy": "private", "readonly": true }, { "kind": "field", "name": "currentIndex", "privacy": "private", "readonly": true }, { "kind": "field", "name": "hasNoProducts", "privacy": "private", "readonly": true }, { "kind": "method", "name": "initRecommendations", "privacy": "private" }, { "kind": "method", "name": "initSummary", "privacy": "private" }, { "kind": "method", "name": "getProductId", "privacy": "private", "parameters": [ { "name": "product", "type": { "text": "Product" } } ] }, { "kind": "method", "name": "getAtomicProductProps", "privacy": "private", "parameters": [ { "name": "product", "type": { "text": "Product" } } ] }, { "kind": "method", "name": "initProductTemplateProvider", "privacy": "private" }, { "kind": "method", "name": "initProductListCommon", "privacy": "private" }, { "kind": "method", "name": "createSelectChildProductListener", "privacy": "private" }, { "kind": "method", "name": "selectChildProductCallback", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "computeListDisplayClasses", "privacy": "private" }, { "kind": "method", "name": "renderAsGrid", "privacy": "private" }, { "kind": "method", "name": "renderRecommendationList", "privacy": "private" }, { "kind": "field", "name": "shouldRender", "privacy": "private", "readonly": true }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "slot-id", "type": { "text": "string" }, "description": "The identifier used by the Commerce API to retrieve the desired recommendation list for the component.\nYou can configure recommendation lists and get their respective slot IDs through the Coveo Merchandising Hub (CMH).\nYou can include multiple `atomic-commerce-recommendation-list` components with different slot IDs in the same page to display several recommendation lists.", "fieldName": "slotId" }, { "name": "product-id", "type": { "text": "string" }, "description": "The unique identifier of the product to use for seeded recommendations.", "fieldName": "productId" }, { "name": "display", "type": { "text": "ItemDisplayBasicLayout" }, "default": "'list'", "description": "The layout to apply when displaying the products. This does not affect the display of the surrounding list itself.\nTo modify the number of products per column and row, modify the `--atomic-recs-number-of-columns` and `--atomic-recs-number-of-rows` CSS variables.", "fieldName": "display" }, { "name": "density", "type": { "text": "ItemDisplayDensity" }, "default": "'normal'", "description": "The spacing of various elements in the product list, including the gap between products, the gap between parts of a product, and the font sizes of the parts of a product.", "fieldName": "density" }, { "name": "image-size", "type": { "text": "ItemDisplayImageSize" }, "default": "'small'", "description": "The expected size of the image displayed on the recommended products.", "fieldName": "imageSize" }, { "name": "products-per-page", "type": { "text": "number" }, "description": "The number of products to display per page.\nThe products will be displayed in a carousel if this property is set.\nThis does not affect the display of the list itself, only the number of recommendation pages.\nIf you want to display the recommendations in a carousel with a single row, set the `--atomic-recs-number-of-columns` CSS variable to the same value as this property.", "fieldName": "productsPerPage" }, { "name": "heading-level", "type": { "text": "number" }, "default": "0", "description": "The [heading level](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements) to use for the heading label, from 1 to 6.\nWhen set to 0, a `div` will be used instead of an Heading Element.", "fieldName": "headingLevel" } ], "mixins": [ { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-recommendation-list", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceRecommendationList", "declaration": { "name": "AtomicCommerceRecommendationList", "module": "src/components/commerce/atomic-commerce-recommendation-list/atomic-commerce-recommendation-list.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-recommendation-list", "declaration": { "name": "AtomicCommerceRecommendationList", "module": "src/components/commerce/atomic-commerce-recommendation-list/atomic-commerce-recommendation-list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-refine-modal/atomic-commerce-refine-modal.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-refine-modal` is automatically created as a child of the `atomic-commerce-search-interface` when the `atomic-commerce-refine-toggle` is initialized.\n\nWhen the modal is opened, the class `atomic-modal-opened` is added to the interface element and the body, allowing further customization.", "name": "AtomicCommerceRefineModal", "cssParts": [ { "description": "The title of the modal.", "name": "title" }, { "description": "The button in the header that closes the modal.", "name": "close-button" }, { "description": "The icon of the close button.", "name": "close-icon" }, { "description": "The wrapper around the content inside the footer of the modal, containing the button to view the products.", "name": "footer-content" }, { "description": "The button in the footer that closes the modal.", "name": "footer-button" }, { "description": "The text inside the button in the footer that closes the modal.", "name": "footer-button-text" }, { "description": "The count inside the button in the footer that closes the modal.", "name": "footer-button-count" }, { "description": "The wrapper around the content inside the body of the modal.", "name": "content" }, { "description": "The `` element.", "name": "label" }, { "description": "The `` element of the dropdown list.", "name": "select" }, { "description": "The element separating the select from the icon.", "name": "select-separator" }, { "description": "The dropdown placeholder for while the interface is initializing.", "name": "placeholder" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "dropdownId", "privacy": "private", "readonly": true }, { "kind": "field", "name": "sort", "type": { "text": "Sort" }, "privacy": "private" }, { "kind": "field", "name": "sortState", "type": { "text": "SortState" }, "privacy": "private" }, { "kind": "field", "name": "searchOrListing", "type": { "text": "Search | ProductListing" }, "privacy": "private" }, { "kind": "field", "name": "searchOrListingState", "type": { "text": "SearchState | ProductListingState | undefined" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "select", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "sortLabelTemplate", "privacy": "private" }, { "kind": "method", "name": "sortSelectTemplate", "privacy": "private" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-sort-dropdown", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceSortDropdown", "declaration": { "name": "AtomicCommerceSortDropdown", "module": "src/components/commerce/atomic-commerce-sort-dropdown/atomic-commerce-sort-dropdown.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-sort-dropdown", "declaration": { "name": "AtomicCommerceSortDropdown", "module": "src/components/commerce/atomic-commerce-sort-dropdown/atomic-commerce-sort-dropdown.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-text/atomic-commerce-text.ts", "declarations": [ { "kind": "class", "description": "The `atomic-commerce-text` component leverages the I18n translation module through the atomic-commerce-interface.", "name": "AtomicCommerceText", "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The string key value.", "attribute": "value", "reflects": true }, { "kind": "field", "name": "count", "type": { "text": "number" }, "description": "The count value used for plurals.", "attribute": "count", "reflects": true }, { "kind": "field", "name": "strings", "privacy": "private", "readonly": true }, { "kind": "method", "name": "initialize", "privacy": "public" } ], "attributes": [ { "name": "value", "type": { "text": "string" }, "description": "The string key value.", "fieldName": "value" }, { "name": "count", "type": { "text": "number" }, "description": "The count value used for plurals.", "fieldName": "count" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-text", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceText", "declaration": { "name": "AtomicCommerceText", "module": "src/components/commerce/atomic-commerce-text/atomic-commerce-text.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-text", "declaration": { "name": "AtomicCommerceText", "module": "src/components/commerce/atomic-commerce-text/atomic-commerce-text.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-commerce-timeframe-facet/atomic-commerce-timeframe-facet.ts", "declarations": [ { "kind": "class", "description": "A facet is a list of values for a certain field occurring in the products.\nAn `atomic-commerce-timeframe-facet` displays a facet of the products for the current query as date intervals.", "name": "AtomicCommerceTimeframeFacet", "cssParts": [ { "description": "The wrapper for the entire facet.", "name": "facet" }, { "description": "The header button to expand/collapse the facet.", "name": "label-button" }, { "description": "The expand/collapse icon in the header.", "name": "label-button-icon" }, { "description": "The button to clear all selected values.", "name": "clear-button" }, { "description": "The icon in the clear button.", "name": "clear-button-icon" }, { "description": "The container for the facet values list.", "name": "values" }, { "description": "A facet value button.", "name": "value-link" }, { "description": "A selected facet value button.", "name": "value-link-selected" }, { "description": "The product count for a facet value.", "name": "value-count" }, { "description": "The label text of a facet value.", "name": "value-label" }, { "description": "The label for date input fields.", "name": "input-label" }, { "description": "The start date input field.", "name": "input-start" }, { "description": "The end date input field.", "name": "input-end" }, { "description": "The button to apply date range selection.", "name": "input-apply-button" } ], "members": [ { "kind": "field", "name": "summary", "type": { "text": "Summary" }, "description": "The Summary controller instance.", "attribute": "summary", "privacy": "private" }, { "kind": "field", "name": "facet", "type": { "text": "DateFacet" }, "description": "The date facet controller instance.", "attribute": "facet", "privacy": "private" }, { "kind": "field", "name": "isCollapsed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the facet is collapsed.", "attribute": "is-collapsed", "reflects": true }, { "kind": "field", "name": "field", "type": { "text": "string" }, "description": "The field identifier for this facet.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "summaryState", "type": { "text": "SearchSummaryState | ProductListingSummaryState" }, "privacy": "private" }, { "kind": "field", "name": "facetState", "type": { "text": "DateFacetState" }, "privacy": "private" }, { "kind": "field", "name": "inputRange", "type": { "text": "DateFilterRange | undefined" }, "privacy": "private" }, { "kind": "field", "name": "headerFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "displayName", "privacy": "private", "readonly": true }, { "kind": "field", "name": "focusTarget", "type": { "text": "FocusTargetController" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "applyDateInput", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "field", "name": "valuesToRender", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderFacet", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderInput", "privacy": "private", "readonly": true }, { "kind": "field", "name": "numberOfSelectedValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "hasInputRange", "privacy": "private", "readonly": true }, { "kind": "method", "name": "resetRange", "privacy": "private" }, { "kind": "method", "name": "formatFacetValue", "privacy": "private", "parameters": [ { "name": "facetValue", "type": { "text": "DateFacetValue" } } ] }, { "kind": "method", "name": "renderValues", "privacy": "private" }, { "kind": "method", "name": "renderValue", "privacy": "private", "parameters": [ { "name": "facetValue", "type": { "text": "DateFacetValue" } } ] }, { "kind": "method", "name": "renderValuesContainer", "privacy": "private", "parameters": [ { "name": "children", "type": { "text": "unknown[]" } } ] }, { "kind": "method", "name": "renderHeader", "privacy": "private" }, { "kind": "method", "name": "renderDateInput", "privacy": "private" }, { "kind": "method", "name": "validateFacet", "privacy": "private" } ], "attributes": [ { "name": "is-collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the facet is collapsed.", "fieldName": "isCollapsed" }, { "name": "field", "type": { "text": "string" }, "description": "The field identifier for this facet.", "fieldName": "field" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-commerce-timeframe-facet", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicCommerceTimeframeFacet", "declaration": { "name": "AtomicCommerceTimeframeFacet", "module": "src/components/commerce/atomic-commerce-timeframe-facet/atomic-commerce-timeframe-facet.ts" } }, { "kind": "custom-element-definition", "name": "atomic-commerce-timeframe-facet", "declaration": { "name": "AtomicCommerceTimeframeFacet", "module": "src/components/commerce/atomic-commerce-timeframe-facet/atomic-commerce-timeframe-facet.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product/atomic-product.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product` component is used internally by the `atomic-commerce-product-list` and `atomic-commerce-recommendation-list` components.", "name": "AtomicProduct", "members": [ { "kind": "field", "name": "productRootRef", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "linkContainerRef", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "itemLayoutController", "type": { "text": "ItemLayoutController" }, "privacy": "private" }, { "kind": "field", "name": "stopPropagation", "type": { "text": "boolean" }, "description": "Whether `atomic-product-link` components nested in the `atomic-product` should stop click event propagation.", "attribute": "stop-propagation", "reflects": true }, { "kind": "field", "name": "product", "type": { "text": "Product" }, "description": "The product item.", "attribute": "product" }, { "kind": "field", "name": "interactiveProduct", "type": { "text": "InteractiveProduct" }, "description": "The InteractiveProduct item.", "attribute": "interactive-product" }, { "kind": "field", "name": "store", "type": { "text": "CommerceStore | CommerceRecommendationStore" }, "description": "Global Atomic state.", "attribute": "store" }, { "kind": "field", "name": "content", "type": { "text": "ParentNode" }, "description": "The product content to display.", "attribute": "content" }, { "kind": "field", "name": "linkContent", "type": { "text": "ParentNode" }, "default": "new DocumentFragment()", "description": "The product link to use when the product is clicked in a grid layout.", "attribute": "link-content" }, { "kind": "field", "name": "display", "type": { "text": "ItemDisplayLayout" }, "default": "'list'", "description": "How products should be displayed.", "attribute": "display", "reflects": true }, { "kind": "field", "name": "density", "type": { "text": "ItemDisplayDensity" }, "default": "'normal'", "description": "How large or small products should be.", "attribute": "density", "reflects": true }, { "kind": "field", "name": "imageSize", "type": { "text": "ItemDisplayImageSize" }, "default": "'icon'", "description": "The size of the visual section in product list items.\n\nThis is overwritten by the image size defined in the product content, if it exists.", "attribute": "image-size", "reflects": true }, { "kind": "field", "name": "classes", "type": { "text": "string" }, "default": "''", "description": "The classes to add to the product element.", "attribute": "classes" }, { "kind": "field", "name": "resolveProduct", "privacy": "public" }, { "kind": "field", "name": "resolveInteractiveProduct", "privacy": "public" }, { "kind": "field", "name": "resolveStopPropagation", "privacy": "public" }, { "kind": "field", "name": "resolveProductDisplayConfig", "privacy": "public" }, { "kind": "field", "name": "handleClick", "privacy": "public" }, { "kind": "field", "name": "clickLinkContainer", "privacy": "public" }, { "kind": "method", "name": "getContentHTML", "privacy": "private" }, { "kind": "method", "name": "getLinkHTML", "privacy": "private" }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "stop-propagation", "type": { "text": "boolean" }, "description": "Whether `atomic-product-link` components nested in the `atomic-product` should stop click event propagation.", "fieldName": "stopPropagation" }, { "name": "product", "type": { "text": "Product" }, "description": "The product item.", "fieldName": "product" }, { "name": "interactive-product", "type": { "text": "InteractiveProduct" }, "description": "The InteractiveProduct item.", "fieldName": "interactiveProduct" }, { "name": "store", "type": { "text": "CommerceStore | CommerceRecommendationStore" }, "description": "Global Atomic state.", "fieldName": "store" }, { "name": "content", "type": { "text": "ParentNode" }, "description": "The product content to display.", "fieldName": "content" }, { "name": "link-content", "type": { "text": "ParentNode" }, "default": "new DocumentFragment()", "description": "The product link to use when the product is clicked in a grid layout.", "fieldName": "linkContent" }, { "name": "display", "type": { "text": "ItemDisplayLayout" }, "default": "'list'", "description": "How products should be displayed.", "fieldName": "display" }, { "name": "density", "type": { "text": "ItemDisplayDensity" }, "default": "'normal'", "description": "How large or small products should be.", "fieldName": "density" }, { "name": "image-size", "type": { "text": "ItemDisplayImageSize" }, "default": "'icon'", "description": "The size of the visual section in product list items.\n\nThis is overwritten by the image size defined in the product content, if it exists.", "fieldName": "imageSize" }, { "name": "classes", "type": { "text": "string" }, "default": "''", "description": "The classes to add to the product element.", "fieldName": "classes" } ], "mixins": [ { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProduct", "declaration": { "name": "AtomicProduct", "module": "src/components/commerce/atomic-product/atomic-product.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product", "declaration": { "name": "AtomicProduct", "module": "src/components/commerce/atomic-product/atomic-product.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product/atomic-product.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-children/atomic-product-children.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-children` component renders a section that allows the user to select a nested product (for example, a color variant of a given product).\n\nThis component leverages the [product grouping](https://docs.coveo.com/en/l78i2152/) feature.\n\nThe component displays up to 5 child products before showing a \"+N\" button for additional variants.\nThis limit ensures consistent UI layout while preventing performance issues with large product variant collections.", "name": "AtomicProductChildren", "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "childProducts", "type": { "text": "ChildProduct[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "activeChildId", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "method", "name": "initialize" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "default": "'available-in'", "description": "The i18n key for the localized label to display for the product children section.\n\nSet this to an empty string if you do not want to render the label at all.", "attribute": "label" }, { "kind": "field", "name": "field", "type": { "text": "string" }, "default": "'ec_thumbnails'", "description": "The child product field to use to render product children images. Fields in the `additionalFields` property of the child products are supported.\n\nThis field should be defined on each child product, and its value should be an image URL (or an array of image URLs, in which case the component will use the first one in the array).", "attribute": "field", "reflects": true }, { "kind": "field", "name": "fallback", "type": { "text": "string" }, "default": "'data:image/svg+xml,%3Csvg xmlns=\"http://www.w3.org/2000/svg\" width=\"50\" height=\"50\" viewBox=\"0 0 50 50\"%3E%3Crect width=\"50\" height=\"50\" fill=\"none\" stroke=\"gray\"%3E%3C/rect%3E%3C/svg%3E'", "description": "The fallback image URL to use when the specified `field` is not defined on a given child product, or when its value is invalid.", "attribute": "fallback", "reflects": true }, { "kind": "method", "name": "onSelectChild", "privacy": "private", "parameters": [ { "name": "child", "type": { "text": "ChildProduct" } } ] }, { "kind": "method", "name": "getImageUrl", "privacy": "private", "parameters": [ { "name": "child", "type": { "text": "ChildProduct" } } ] }, { "kind": "field", "name": "handleClick", "privacy": "private" }, { "kind": "method", "name": "renderChild", "privacy": "private", "parameters": [ { "name": "child", "type": { "text": "ChildProduct" } } ] }, { "kind": "method", "name": "renderLabel", "privacy": "private" }, { "kind": "field", "name": "count", "description": "Gets the total count of items, including the parent item itself.\n\nThe calculation subtracts the number of child items from the total number of children,\nthen adds 1 to include the parent item in the count. This is necessary because\n`children.length` only represents the number of children of the parent, while\nthe parent is also included in the `atomic-product-children` component.", "return": { "type": { "text": "" } }, "readonly": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "'available-in'", "description": "The i18n key for the localized label to display for the product children section.\n\nSet this to an empty string if you do not want to render the label at all.", "fieldName": "label" }, { "name": "field", "type": { "text": "string" }, "default": "'ec_thumbnails'", "description": "The child product field to use to render product children images. Fields in the `additionalFields` property of the child products are supported.\n\nThis field should be defined on each child product, and its value should be an image URL (or an array of image URLs, in which case the component will use the first one in the array).", "fieldName": "field" }, { "name": "fallback", "type": { "text": "string" }, "default": "'data:image/svg+xml,%3Csvg xmlns=\"http://www.w3.org/2000/svg\" width=\"50\" height=\"50\" viewBox=\"0 0 50 50\"%3E%3Crect width=\"50\" height=\"50\" fill=\"none\" stroke=\"gray\"%3E%3C/rect%3E%3C/svg%3E'", "description": "The fallback image URL to use when the specified `field` is not defined on a given child product, or when its value is invalid.", "fieldName": "fallback" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-children", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductChildren", "declaration": { "name": "AtomicProductChildren", "module": "src/components/commerce/atomic-product-children/atomic-product-children.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-children", "declaration": { "name": "AtomicProductChildren", "module": "src/components/commerce/atomic-product-children/atomic-product-children.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-children/select-child-product-event.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-description/atomic-product-description.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-description` component renders the description of a product.", "name": "AtomicProductDescription", "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ truncateAfter: new StringValue({ constrainTo: ['none', '1', '2', '3', '4'], }), field: new StringValue({ constrainTo: ['ec_shortdesc', 'ec_description'], }), })" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "isExpanded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "isTruncated", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "resizeObserver", "type": { "text": "ResizeObserver" }, "privacy": "private", "default": "new ResizeObserver(() => { if (this.descriptionRef.value) { this.isTruncated = this.descriptionRef.value.scrollHeight > this.descriptionRef.value.clientHeight; } })" }, { "kind": "field", "name": "descriptionRef", "privacy": "private" }, { "kind": "field", "name": "truncateAfter", "type": { "text": "TruncateAfter" }, "privacy": "public", "default": "'2'", "description": "The number of lines after which the product description should be truncated. A value of \"none\" will disable truncation.", "attribute": "truncate-after" }, { "kind": "field", "name": "field", "type": { "text": "'ec_description' | 'ec_shortdesc'" }, "privacy": "public", "default": "'ec_shortdesc'", "description": "The name of the description field to use.", "attribute": "field" }, { "kind": "field", "name": "isCollapsible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the description should be collapsible after being expanded.", "attribute": "is-collapsible" }, { "kind": "method", "name": "initialize" }, { "kind": "method", "name": "validateProps", "privacy": "private" }, { "kind": "field", "name": "onToggleExpand", "privacy": "private" }, { "kind": "field", "name": "product", "type": { "text": "Product | null" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "truncate-after", "type": { "text": "TruncateAfter" }, "default": "'2'", "description": "The number of lines after which the product description should be truncated. A value of \"none\" will disable truncation.", "fieldName": "truncateAfter" }, { "name": "field", "type": { "text": "'ec_description' | 'ec_shortdesc'" }, "default": "'ec_shortdesc'", "description": "The name of the description field to use.", "fieldName": "field" }, { "name": "is-collapsible", "type": { "text": "boolean" }, "default": "false", "description": "Whether the description should be collapsible after being expanded.", "fieldName": "isCollapsible" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-description", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductDescription", "declaration": { "name": "AtomicProductDescription", "module": "src/components/commerce/atomic-product-description/atomic-product-description.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-description", "declaration": { "name": "AtomicProductDescription", "module": "src/components/commerce/atomic-product-description/atomic-product-description.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-excerpt/atomic-product-excerpt.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-excerpt` component renders the excerpt of a product.", "name": "AtomicProductExcerpt", "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ truncateAfter: new StringValue({ constrainTo: ['none', '1', '2', '3', '4'], }), })" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "isExpanded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "isTruncated", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "resizeObserver", "type": { "text": "ResizeObserver" }, "privacy": "private", "default": "new ResizeObserver(() => { if (this.excerptRef.value) { this.isTruncated = this.excerptRef.value.scrollHeight > this.excerptRef.value.clientHeight; } })" }, { "kind": "field", "name": "excerptRef", "privacy": "private" }, { "kind": "field", "name": "truncateAfter", "type": { "text": "TruncateAfter" }, "privacy": "public", "default": "'2'", "description": "The number of lines after which the product excerpt should be truncated. A value of \"none\" will disable truncation.", "attribute": "truncate-after" }, { "kind": "field", "name": "isCollapsible", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the excerpt should be collapsible after being expanded.", "attribute": "is-collapsible" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "validateProps", "privacy": "private" }, { "kind": "method", "name": "onToggleExpand", "privacy": "private", "parameters": [ { "name": "e", "optional": true, "type": { "text": "MouseEvent" } } ] }, { "kind": "field", "name": "product", "type": { "text": "Product | null" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "truncate-after", "type": { "text": "TruncateAfter" }, "default": "'2'", "description": "The number of lines after which the product excerpt should be truncated. A value of \"none\" will disable truncation.", "fieldName": "truncateAfter" }, { "name": "is-collapsible", "type": { "text": "boolean" }, "default": "false", "description": "Whether the excerpt should be collapsible after being expanded.", "fieldName": "isCollapsible" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-excerpt", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductExcerpt", "declaration": { "name": "AtomicProductExcerpt", "module": "src/components/commerce/atomic-product-excerpt/atomic-product-excerpt.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-excerpt", "declaration": { "name": "AtomicProductExcerpt", "module": "src/components/commerce/atomic-product-excerpt/atomic-product-excerpt.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-field-condition/atomic-product-field-condition.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-field-condition` component renders its children only when all of the conditions specified through its props are satisfied.\nThe condition properties can be based on any top-level product property of the `product` object, not restricted to fields (for example, `ec_name`).", "name": "AtomicProductFieldCondition", "slots": [ { "description": "The content to render if the conditions are met.", "name": "default" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "ifDefined", "type": { "text": "string" }, "description": "A condition that is satisfied when the specified field is defined on a product (for example, `if-defined=\"cat_gender\"` is satisfied when a product has the `cat_gender` field).", "attribute": "if-defined" }, { "kind": "field", "name": "ifNotDefined", "type": { "text": "string" }, "description": "A condition that is satisfied when the specified field is not defined on a product (for example, `if-not-defined=\"cat_gender\"` is satisfied when a product does not have the `cat_gender` field).", "attribute": "if-not-defined" }, { "kind": "field", "name": "mustMatch", "type": { "text": "Record" }, "description": "A condition that is satisfied when the specified field matches one of the specified values on a product (for example, `must-match-ec_color=\"Pink,Purple\"` is satisfied when a product is either pink or purple)." }, { "kind": "field", "name": "mustNotMatch", "type": { "text": "Record" }, "description": "A condition that is satisfied when the specified field does not match any of the specified values on a product (for example, `must-not-match-ec_color=\"Green,Black\"` is satisfied when a product is neither green nor black)." }, { "kind": "method", "name": "initialize" }, { "kind": "field", "name": "conditions", "type": { "text": "ProductTemplateCondition[]" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "if-defined", "type": { "text": "string" }, "description": "A condition that is satisfied when the specified field is defined on a product (for example, `if-defined=\"cat_gender\"` is satisfied when a product has the `cat_gender` field).", "fieldName": "ifDefined" }, { "name": "if-not-defined", "type": { "text": "string" }, "description": "A condition that is satisfied when the specified field is not defined on a product (for example, `if-not-defined=\"cat_gender\"` is satisfied when a product does not have the `cat_gender` field).", "fieldName": "ifNotDefined" }, { "name": "must-match", "fieldName": "mustMatch" }, { "name": "must-not-match", "fieldName": "mustNotMatch" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-field-condition", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductFieldCondition", "declaration": { "name": "AtomicProductFieldCondition", "module": "src/components/commerce/atomic-product-field-condition/atomic-product-field-condition.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-field-condition", "declaration": { "name": "AtomicProductFieldCondition", "module": "src/components/commerce/atomic-product-field-condition/atomic-product-field-condition.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-image/atomic-product-image.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-image` component renders an image from a product field. When the product has multiple images, it displays a carousel with navigation buttons and indicators.", "name": "AtomicProductImage", "cssParts": [ { "description": "The image element that displays the product image.", "name": "product-image" }, { "description": "The container for the previous image button in the carousel.", "name": "previous-button" }, { "description": "The container for the next image button in the carousel.", "name": "next-button" }, { "description": "The icon for the next image button in the carousel.", "name": "next-icon" }, { "description": "The icon for the previous image button in the carousel.", "name": "previous-icon" }, { "description": "The container for the carousel indicators.", "name": "indicators" }, { "description": "The individual indicator for each image in the carousel.", "name": "indicator" }, { "description": "The currently active indicator in the carousel.", "name": "active-indicator" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "Bindings" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "public" }, { "kind": "field", "name": "product", "type": { "text": "Product" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "useFallback", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "currentImage", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "isFallbackMissing", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "field", "type": { "text": "string" }, "default": "'ec_thumbnails'", "description": "The product field which the component should use. This will look for the field in the product object first, then in the product.additionalFields object.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "imageAltField", "type": { "text": "string" }, "description": "The product field that contains the alt text for the images. This will look for the field in the product object first, then in the product.additionalFields object.\nIf the product has multiple images, the value of the `imageAltField` will be used as the alt text for every image.\n\nIf the field is not specified, or does not contain a valid value, the alt text will be set to \"Image {index} out of {totalImages} for {productName}\".", "attribute": "image-alt-field", "reflects": true }, { "kind": "field", "name": "fallback", "type": { "text": "string" }, "default": "'data:image/svg+xml,%3Csvg xmlns=\"http://www.w3.org/2000/svg\" width=\"50\" height=\"50\" viewBox=\"0 0 50 50\"%3E%3Crect width=\"50\" height=\"50\" fill=\"none\" stroke=\"none\"%3E%3C/rect%3E%3C/svg%3E'", "description": "An fallback image URL that will be used in case the specified image is not available or an error is encountered.", "attribute": "fallback", "reflects": true }, { "kind": "method", "name": "previousImage", "privacy": "private" }, { "kind": "method", "name": "nextImage", "privacy": "private" }, { "kind": "method", "name": "navigateToImage", "privacy": "private", "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "logWarning", "privacy": "private", "parameters": [ { "name": "message", "type": { "text": "string" } } ] }, { "kind": "method", "name": "handleImageError", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "handleMissingFallback", "privacy": "private", "parameters": [ { "name": "message", "type": { "text": "string" } } ] }, { "kind": "method", "name": "validateUrl", "privacy": "private", "parameters": [ { "name": "url", "type": { "text": "string | undefined" } } ] }, { "kind": "method", "name": "filterValidImageUrls", "privacy": "private", "return": { "type": { "text": "string[]" } } }, { "kind": "method", "name": "getAltText", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "index", "type": { "text": "number" } }, { "name": "max", "type": { "text": "number" } }, { "name": "validImageAlt", "type": { "text": "string | null" } } ] }, { "kind": "method", "name": "buildImage", "privacy": "private", "return": { "type": { "text": "Image" } }, "parameters": [ { "name": "url", "type": { "text": "string" } }, { "name": "index", "type": { "text": "number" } } ] }, { "kind": "field", "name": "images", "type": { "text": "Image[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "imageUrls", "privacy": "private", "readonly": true }, { "kind": "field", "name": "imageAlt", "privacy": "private", "readonly": true }, { "kind": "field", "name": "numberOfImages", "privacy": "private", "readonly": true }, { "kind": "method", "name": "renderCurrentImage", "privacy": "private", "parameters": [ { "name": "image", "type": { "text": "Image | null" } } ] } ], "attributes": [ { "name": "field", "type": { "text": "string" }, "default": "'ec_thumbnails'", "description": "The product field which the component should use. This will look for the field in the product object first, then in the product.additionalFields object.", "fieldName": "field" }, { "name": "image-alt-field", "type": { "text": "string" }, "description": "The product field that contains the alt text for the images. This will look for the field in the product object first, then in the product.additionalFields object.\nIf the product has multiple images, the value of the `imageAltField` will be used as the alt text for every image.\n\nIf the field is not specified, or does not contain a valid value, the alt text will be set to \"Image {index} out of {totalImages} for {productName}\".", "fieldName": "imageAltField" }, { "name": "fallback", "type": { "text": "string" }, "default": "'data:image/svg+xml,%3Csvg xmlns=\"http://www.w3.org/2000/svg\" width=\"50\" height=\"50\" viewBox=\"0 0 50 50\"%3E%3Crect width=\"50\" height=\"50\" fill=\"none\" stroke=\"none\"%3E%3C/rect%3E%3C/svg%3E'", "description": "An fallback image URL that will be used in case the specified image is not available or an error is encountered.", "fieldName": "fallback" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-image", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductImage", "declaration": { "name": "AtomicProductImage", "module": "src/components/commerce/atomic-product-image/atomic-product-image.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-image", "declaration": { "name": "AtomicProductImage", "module": "src/components/commerce/atomic-product-image/atomic-product-image.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-link/atomic-product-link.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-link` component automatically transforms a product `ec_name` into a clickable link that points to the original item.", "name": "AtomicProductLink", "slots": [ { "description": "The content to display inside the link.", "name": "default" }, { "description": "Use `` to pass custom attributes to the generated link.", "name": "attributes" } ], "members": [ { "kind": "field", "name": "hrefTemplate", "type": { "text": "string" }, "description": "The [template literal](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Template_literals) from which to generate the `href` attribute value\n\nThe template literal can reference any number of product properties from the parent product. It can also reference the window object.\n\nFor example, the following markup generates an `href` value such as `http://uri.com?id=itemTitle`, using the product's `clickUri` and `itemtitle` fields.\n```html\n\n```", "attribute": "href-template", "reflects": true }, { "kind": "field", "name": "product", "type": { "text": "Product | undefined" }, "privacy": "public" }, { "kind": "field", "name": "interactiveProduct", "type": { "text": "InteractiveProduct | undefined" }, "privacy": "public" }, { "kind": "field", "name": "productController", "privacy": "public" }, { "kind": "field", "name": "interactiveProductController", "privacy": "public" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "linkAttributes", "type": { "text": "Attr[] | undefined" }, "privacy": "private" }, { "kind": "field", "name": "stopPropagation", "type": { "text": "boolean | undefined" }, "privacy": "private" }, { "kind": "field", "name": "removeLinkEventHandlers", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "method", "name": "logWarningIfNeeded", "privacy": "private", "parameters": [ { "name": "warning", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "initialize" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "adoptChildren", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Reads the initial child nodes, sorts them into the `slots` map,\nand removes them from the DOM temporarily.", "inheritedFrom": { "name": "SlotsForNoShadowDOMMixin", "module": "src/mixins/slots-for-no-shadow-dom-mixin.ts" } }, { "kind": "method", "name": "isTextNodeEmpty", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "node", "type": { "text": "Text" } } ], "inheritedFrom": { "name": "SlotsForNoShadowDOMMixin", "module": "src/mixins/slots-for-no-shadow-dom-mixin.ts" } }, { "kind": "method", "name": "isSlotEmpty", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "slot", "type": { "text": "string" } } ], "inheritedFrom": { "name": "SlotsForNoShadowDOMMixin", "module": "src/mixins/slots-for-no-shadow-dom-mixin.ts" } }, { "kind": "method", "name": "renderDefaultSlotContent", "privacy": "public", "return": { "type": { "text": "" } }, "parameters": [ { "name": "defaultContent", "optional": true, "type": { "text": "unknown" }, "description": "Optional content to render if the default slot is empty." } ], "description": "Returns the content for the default slot.\nIf no nodes are assigned to the default slot, returns the provided fallback content.", "inheritedFrom": { "name": "SlotsForNoShadowDOMMixin", "module": "src/mixins/slots-for-no-shadow-dom-mixin.ts" } }, { "kind": "method", "name": "createSlotPlaceholder", "privacy": "private", "return": { "type": { "text": "[Comment]" } }, "parameters": [ { "name": "nodes", "type": { "text": "AdoptedNode[]" } } ], "description": "Creates a placeholder comment that will be replaced in `updated`.", "inheritedFrom": { "name": "SlotsForNoShadowDOMMixin", "module": "src/mixins/slots-for-no-shadow-dom-mixin.ts" } } ], "attributes": [ { "name": "href-template", "type": { "text": "string" }, "description": "The [template literal](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Template_literals) from which to generate the `href` attribute value\n\nThe template literal can reference any number of product properties from the parent product. It can also reference the window object.\n\nFor example, the following markup generates an `href` value such as `http://uri.com?id=itemTitle`, using the product's `clickUri` and `itemtitle` fields.\n```html\n\n```", "fieldName": "hrefTemplate" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" }, { "name": "SlotsForNoShadowDOMMixin", "package": "@/src/mixins/slots-for-no-shadow-dom-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-link", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductLink", "declaration": { "name": "AtomicProductLink", "module": "src/components/commerce/atomic-product-link/atomic-product-link.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-link", "declaration": { "name": "AtomicProductLink", "module": "src/components/commerce/atomic-product-link/atomic-product-link.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-link/atomic-product-link.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-multi-value-text/atomic-product-multi-value-text.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-multi-value-text` component renders the values of a multi-value string field.", "name": "AtomicProductMultiValueText", "cssParts": [ { "description": "The list of field values.", "name": "product-multi-value-text-list" }, { "description": "The separator to display between each of the field values.", "name": "product-multi-value-text-separator" }, { "description": "A field value.", "name": "product-multi-value-text-value" }, { "description": "A label indicating some values were omitted.", "name": "product-multi-value-text-value-more" } ], "slots": [ { "description": "A custom caption value that's specified for a given part of a multi-text field value. For example, if you want to use `Off-Campus Resident` as a caption value for `Off-campus apartment` in `Off-campus apartment;On-campus apartment`, you'd use `Off-Campus Resident`). The suffix of this slot corresponds with the field value, written in kebab case.", "name": "product-multi-value-text-value-*" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbManager", "type": { "text": "BreadcrumbManager" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "field", "type": { "text": "string" }, "privacy": "public", "description": "The field that the component should use.\nThe component will try to find this field in the `Product.additionalFields` object unless it finds it in the `Product` object first.\nMake sure this field is present in the `fieldsToInclude` property of the `atomic-commerce-interface` component.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "maxValuesToDisplay", "type": { "text": "number" }, "privacy": "public", "default": "3", "description": "The maximum number of field values to display.\nIf there are `n` more values than the specified maximum, the last displayed value will be \"`n` more...\".", "attribute": "max-values-to-display", "reflects": true }, { "kind": "field", "name": "delimiter", "type": { "text": "string | null" }, "privacy": "public", "default": "null", "description": "The delimiter used to separate values when the field isn't indexed as a multi value field.", "attribute": "delimiter", "reflects": true }, { "kind": "field", "name": "values", "type": { "text": "string[]" }, "privacy": "private", "default": "[]" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "initializeValues", "privacy": "private", "return": { "type": { "text": "string[]" } } }, { "kind": "field", "name": "facetSelectedValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "sortedValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldDisplayLabel", "privacy": "private", "readonly": true }, { "kind": "field", "name": "numberOfValuesToDisplay", "privacy": "private", "readonly": true }, { "kind": "method", "name": "renderValue", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "string" } } ] }, { "kind": "method", "name": "renderSeparator", "privacy": "private" }, { "kind": "method", "name": "renderMoreLabel", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "renderListItems", "privacy": "private", "parameters": [ { "name": "values", "type": { "text": "string[]" } } ] } ], "attributes": [ { "name": "field", "type": { "text": "string" }, "description": "The field that the component should use.\nThe component will try to find this field in the `Product.additionalFields` object unless it finds it in the `Product` object first.\nMake sure this field is present in the `fieldsToInclude` property of the `atomic-commerce-interface` component.", "fieldName": "field" }, { "name": "max-values-to-display", "type": { "text": "number" }, "default": "3", "description": "The maximum number of field values to display.\nIf there are `n` more values than the specified maximum, the last displayed value will be \"`n` more...\".", "fieldName": "maxValuesToDisplay" }, { "name": "delimiter", "type": { "text": "string | null" }, "default": "null", "description": "The delimiter used to separate values when the field isn't indexed as a multi value field.", "fieldName": "delimiter" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-multi-value-text", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductMultiValueText", "declaration": { "name": "AtomicProductMultiValueText", "module": "src/components/commerce/atomic-product-multi-value-text/atomic-product-multi-value-text.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-multi-value-text", "declaration": { "name": "AtomicProductMultiValueText", "module": "src/components/commerce/atomic-product-multi-value-text/atomic-product-multi-value-text.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-numeric-field-value/atomic-product-numeric-field-value.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-numeric-field-value` component renders the value of a number product field.\n\nThe number can be formatted by adding a `atomic-format-number`, `atomic-format-currency` or `atomic-format-unit` component into this component.", "name": "AtomicProductNumericFieldValue", "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "field", "type": { "text": "string" }, "description": "The field that the component should use.\nThe component will try to find this field in the `Product.additionalFields` object unless it finds it in the `Product` object first.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "formatter", "type": { "text": "NumberFormatter" }, "privacy": "private", "default": "defaultNumberFormatter" }, { "kind": "method", "name": "initialize" }, { "kind": "field", "name": "setFormat", "privacy": "private" }, { "kind": "field", "name": "value", "privacy": "private", "readonly": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "field", "type": { "text": "string" }, "description": "The field that the component should use.\nThe component will try to find this field in the `Product.additionalFields` object unless it finds it in the `Product` object first.", "fieldName": "field" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-numeric-field-value", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductNumericFieldValue", "declaration": { "name": "AtomicProductNumericFieldValue", "module": "src/components/commerce/atomic-product-numeric-field-value/atomic-product-numeric-field-value.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-numeric-field-value", "declaration": { "name": "AtomicProductNumericFieldValue", "module": "src/components/commerce/atomic-product-numeric-field-value/atomic-product-numeric-field-value.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-price/atomic-product-price.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-price` component renders the price of a product.", "name": "AtomicProductPrice", "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "context", "type": { "text": "Context" }, "privacy": "private" }, { "kind": "field", "name": "contextState", "type": { "text": "ContextState" }, "privacy": "private" }, { "kind": "method", "name": "initialize" }, { "kind": "field", "name": "product", "type": { "text": "Product | null" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "formatValue", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "getFormattedValue", "privacy": "private", "parameters": [ { "name": "field", "type": { "text": "string" } } ] }, { "kind": "field", "name": "hasPromotionalPrice", "privacy": "private", "readonly": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-price", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductPrice", "declaration": { "name": "AtomicProductPrice", "module": "src/components/commerce/atomic-product-price/atomic-product-price.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-price", "declaration": { "name": "AtomicProductPrice", "module": "src/components/commerce/atomic-product-price/atomic-product-price.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-rating/atomic-product-rating.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-rating` element renders a star rating.", "name": "AtomicProductRating", "cssProperties": [ { "description": "Color of the icon when active.", "name": "--atomic-rating-icon-active-color" }, { "description": "Color of the icon when inactive.", "name": "--atomic-rating-icon-inactive-color" }, { "description": "Outline color of the icon.", "name": "--atomic-rating-icon-outline" } ], "cssParts": [ { "description": "The wrapper that contains the row of inactive stars and the row of active stars.", "name": "value-rating" }, { "description": "The individual star icons used in the rating display.", "name": "value-rating-icon" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "product", "type": { "text": "Product" }, "privacy": "private" }, { "kind": "field", "name": "field", "type": { "text": "string" }, "privacy": "public", "default": "'ec_rating'", "description": "The numerical field whose values you want to display as a rating.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "ratingDetailsField", "type": { "text": "string" }, "privacy": "public", "description": "The field whose value you want to display next to the rating. This field can be used to display the number of reviews or the numerical value of the rating, for example.", "attribute": "rating-details-field", "reflects": true }, { "kind": "field", "name": "maxValueInIndex", "type": { "text": "number" }, "privacy": "public", "default": "5", "description": "The maximum value of the field. This value is also used as the number of icons to be displayed.", "attribute": "max-value-in-index", "reflects": true }, { "kind": "field", "name": "icon", "privacy": "public", "default": "Star", "description": "The SVG icon to use to display the rating.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.\n\nWhen using a custom icon, at least part of your icon should have the color set to `fill=\"currentColor\"`.\nThis part of the SVG will take on the colors set in the following [variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties):\n\n- `--atomic-rating-icon-active-color`\n- `--atomic-rating-icon-inactive-color`", "attribute": "icon", "reflects": true }, { "kind": "field", "name": "numberOfStars", "type": { "text": "number | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "ratingDetails", "type": { "text": "string | number | null" }, "privacy": "private", "default": "null" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "updateNumberOfStars", "privacy": "private" }, { "kind": "method", "name": "updateRatingDetailsValue", "privacy": "private" }, { "kind": "method", "name": "updateStates", "privacy": "private" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "field", "type": { "text": "string" }, "default": "'ec_rating'", "description": "The numerical field whose values you want to display as a rating.", "fieldName": "field" }, { "name": "rating-details-field", "type": { "text": "string" }, "description": "The field whose value you want to display next to the rating. This field can be used to display the number of reviews or the numerical value of the rating, for example.", "fieldName": "ratingDetailsField" }, { "name": "max-value-in-index", "type": { "text": "number" }, "default": "5", "description": "The maximum value of the field. This value is also used as the number of icons to be displayed.", "fieldName": "maxValueInIndex" }, { "name": "icon", "default": "Star", "description": "The SVG icon to use to display the rating.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.\n\nWhen using a custom icon, at least part of your icon should have the color set to `fill=\"currentColor\"`.\nThis part of the SVG will take on the colors set in the following [variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties):\n\n- `--atomic-rating-icon-active-color`\n- `--atomic-rating-icon-inactive-color`", "fieldName": "icon" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-rating", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductRating", "declaration": { "name": "AtomicProductRating", "module": "src/components/commerce/atomic-product-rating/atomic-product-rating.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-rating", "declaration": { "name": "AtomicProductRating", "module": "src/components/commerce/atomic-product-rating/atomic-product-rating.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-actions/atomic-product-section-actions.ts", "declarations": [ { "kind": "class", "description": "This section is intended to display components that allow the user to perform an action on a product without having to view its details.\nIn commerce interface, the user can usually add the product to their cart or wish list.\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.", "name": "AtomicProductSectionActions", "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-product-section-actions", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionActions", "declaration": { "name": "AtomicProductSectionActions", "module": "src/components/commerce/atomic-product-section-actions/atomic-product-section-actions.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-actions", "declaration": { "name": "AtomicProductSectionActions", "module": "src/components/commerce/atomic-product-section-actions/atomic-product-section-actions.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-badges/atomic-product-section-badges.ts", "declarations": [ { "kind": "class", "description": "This section is meant to render badges that highlight special features of the product.\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.", "name": "AtomicProductSectionBadges", "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-product-section-badges", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionBadges", "declaration": { "name": "AtomicProductSectionBadges", "module": "src/components/commerce/atomic-product-section-badges/atomic-product-section-badges.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-badges", "declaration": { "name": "AtomicProductSectionBadges", "module": "src/components/commerce/atomic-product-section-badges/atomic-product-section-badges.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-bottom-metadata/atomic-product-section-bottom-metadata.ts", "declarations": [ { "kind": "class", "description": "This section is meant to render additional descriptive information about the product.\n\nBehavior:\n* Has a maximum height of two lines.\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.", "name": "AtomicProductSectionBottomMetadata", "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-product-section-bottom-metadata", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionBottomMetadata", "declaration": { "name": "AtomicProductSectionBottomMetadata", "module": "src/components/commerce/atomic-product-section-bottom-metadata/atomic-product-section-bottom-metadata.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-bottom-metadata", "declaration": { "name": "AtomicProductSectionBottomMetadata", "module": "src/components/commerce/atomic-product-section-bottom-metadata/atomic-product-section-bottom-metadata.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-children/atomic-product-section-children.ts", "declarations": [ { "kind": "class", "description": "This section is meant to render child products, available when using the component.\n\nBehavior:\n* Shows children at the bottom of the product, indented and wrapped in a border.", "name": "AtomicProductSectionChildren", "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-product-section-children", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionChildren", "declaration": { "name": "AtomicProductSectionChildren", "module": "src/components/commerce/atomic-product-section-children/atomic-product-section-children.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-children", "declaration": { "name": "AtomicProductSectionChildren", "module": "src/components/commerce/atomic-product-section-children/atomic-product-section-children.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-description/atomic-product-section-description.ts", "declarations": [ { "kind": "class", "description": "This section is intended to render an informative summary of the product's description.\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.", "name": "AtomicProductSectionDescription", "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-product-section-description", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionDescription", "declaration": { "name": "AtomicProductSectionDescription", "module": "src/components/commerce/atomic-product-section-description/atomic-product-section-description.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-description", "declaration": { "name": "AtomicProductSectionDescription", "module": "src/components/commerce/atomic-product-section-description/atomic-product-section-description.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-emphasized/atomic-product-section-emphasized.ts", "declarations": [ { "kind": "class", "description": "This section is intended to display the field that's important for its search criteria.\nFor example, in Commerce, a product's price 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 name section.", "name": "AtomicProductSectionEmphasized", "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-product-section-emphasized", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionEmphasized", "declaration": { "name": "AtomicProductSectionEmphasized", "module": "src/components/commerce/atomic-product-section-emphasized/atomic-product-section-emphasized.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-emphasized", "declaration": { "name": "AtomicProductSectionEmphasized", "module": "src/components/commerce/atomic-product-section-emphasized/atomic-product-section-emphasized.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-metadata/atomic-product-section-metadata.ts", "declarations": [ { "kind": "class", "description": "This section is intended to display some fields that are directly related to the name of the product.\nIn commerce, this could be the product 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.", "name": "AtomicProductSectionMetadata", "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-product-section-metadata", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionMetadata", "declaration": { "name": "AtomicProductSectionMetadata", "module": "src/components/commerce/atomic-product-section-metadata/atomic-product-section-metadata.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-metadata", "declaration": { "name": "AtomicProductSectionMetadata", "module": "src/components/commerce/atomic-product-section-metadata/atomic-product-section-metadata.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-name/atomic-product-section-name.ts", "declarations": [ { "kind": "class", "description": "This section is intended to display the product's name, and its main use is to make the product list scannable.\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.", "name": "AtomicProductSectionName", "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-product-section-name", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionName", "declaration": { "name": "AtomicProductSectionName", "module": "src/components/commerce/atomic-product-section-name/atomic-product-section-name.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-name", "declaration": { "name": "AtomicProductSectionName", "module": "src/components/commerce/atomic-product-section-name/atomic-product-section-name.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-template/atomic-product-template.ts", "declarations": [ { "kind": "class", "description": "A product template determines the format of the products, depending on the conditions that are defined for each template.", "name": "AtomicProductTemplate", "slots": [ { "description": "The default slot where to insert the template element.", "name": "default" }, { "description": "A `template` element that contains a single `atomic-product-link` component.", "name": "link" } ], "members": [ { "kind": "field", "name": "productTemplateController", "type": { "text": "ProductTemplateController" }, "privacy": "private", "default": "new ProductTemplateController(this, validParent, allowEmpty)" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "conditions", "type": { "text": "ProductTemplateCondition[]" }, "default": "[]", "description": "A function that must return true on products for the product template to apply.\nSet programmatically before initialization, not via attribute.\n\nFor example, the following targets a template and sets a condition to make it apply only to products whose `ec_name` contains `singapore`:\n`document.querySelector('#target-template').conditions = [(product) => /singapore/i.test(product.ec_name)];`" }, { "kind": "field", "name": "mustMatch", "type": { "text": "Record" }, "description": "The field and values that define which products the condition must be applied to.\nFor example, a template with the following attribute only applies to products whose `ec_brand` is `Barca` or `Acme`:\n`must-match-ec_brand=\"Barca,Acme\"`", "default": "{}" }, { "kind": "field", "name": "mustNotMatch", "type": { "text": "Record" }, "description": "The field and values that define which products the condition must not be applied to.\nFor example, a template with the following attribute only applies to products whose `ec_brand` is not `Barca`:\n`must-not-match-ec_brand=\"Barca\"`", "default": "{}" }, { "kind": "method", "name": "getTemplate", "privacy": "public", "return": { "type": { "text": "Promise | null>" } }, "description": "Gets the product template to apply based on the evaluated conditions." } ], "attributes": [ { "name": "must-match", "fieldName": "mustMatch" }, { "name": "must-not-match", "fieldName": "mustNotMatch" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-template", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductTemplate", "declaration": { "name": "AtomicProductTemplate", "module": "src/components/commerce/atomic-product-template/atomic-product-template.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-template", "declaration": { "name": "AtomicProductTemplate", "module": "src/components/commerce/atomic-product-template/atomic-product-template.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-section-visual/atomic-product-section-visual.ts", "declarations": [ { "kind": "class", "description": "This section is intended to provide visual information about the product.\nIn commerce, an image is a great shorthand for a product category.\n\nBehavior:\n* Has a fixed size that depends on the specified image size, the layout, the density, and the screen size.\n** You should ensure that elements inside of it take the available space.\n* Always has a 1:1 aspect ratio.", "name": "AtomicProductSectionVisual", "members": [ { "kind": "field", "name": "imageSize", "type": { "text": "Omit" }, "privacy": "public", "description": "How large or small the visual section of product using this template should be.", "attribute": "image-size", "reflects": true }, { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "image-size", "type": { "text": "Omit" }, "description": "How large or small the visual section of product using this template should be.", "fieldName": "imageSize" } ], "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-section-visual", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductSectionVisual", "declaration": { "name": "AtomicProductSectionVisual", "module": "src/components/commerce/atomic-product-section-visual/atomic-product-section-visual.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-section-visual", "declaration": { "name": "AtomicProductSectionVisual", "module": "src/components/commerce/atomic-product-section-visual/atomic-product-section-visual.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/atomic-product-text/atomic-product-text.ts", "declarations": [ { "kind": "class", "description": "The `atomic-product-text` component renders the value of a string field for a given product.", "name": "AtomicProductText", "members": [ { "kind": "field", "name": "field", "type": { "text": "string" }, "privacy": "public", "description": "The string field whose value the component should render.\nThe component will look for the specified field in the product's properties first, and then in the product's `additionalFields` property.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "shouldHighlight", "type": { "text": "boolean" }, "privacy": "public", "default": "true", "description": "Whether to highlight the string field value.", "deprecated": "- replaced by `no-highlight` (this defaults to `true`, while the replacement is the inverse and defaults to `false`).\nOnly works if the `field` property is set to `excerpt` or `ec_name`.", "attribute": "should-highlight", "reflects": true }, { "kind": "field", "name": "disableHighlight", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Disable highlighting of the string field value.\nOnly works if the `field` property is set to `excerpt` or `ec_name`.", "attribute": "no-highlight", "reflects": true }, { "kind": "field", "name": "default", "type": { "text": "string" }, "privacy": "public", "description": "The locale key to use for displaying default text when the specified field has no value for the product.", "attribute": "default", "reflects": true }, { "kind": "field", "name": "product", "type": { "text": "Product" }, "privacy": "private" }, { "kind": "field", "name": "productController", "privacy": "private" }, { "kind": "field", "name": "bindings", "type": { "text": "CommerceBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "method", "name": "initialize" }, { "kind": "field", "name": "shouldRenderHighlights", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "isFieldSupportedForHighlighting", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "highlightKeywords", "type": { "text": "HighlightUtils.HighlightKeyword[] | null" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "renderFallback", "privacy": "private" }, { "kind": "method", "name": "renderProductText", "privacy": "private", "parameters": [ { "name": "textValue", "type": { "text": "string" } } ] }, { "kind": "method", "name": "renderProductTextValue", "privacy": "private" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "field", "type": { "text": "string" }, "description": "The string field whose value the component should render.\nThe component will look for the specified field in the product's properties first, and then in the product's `additionalFields` property.", "fieldName": "field" }, { "name": "should-highlight", "type": { "text": "boolean" }, "default": "true", "description": "Whether to highlight the string field value.", "deprecated": "- replaced by `no-highlight` (this defaults to `true`, while the replacement is the inverse and defaults to `false`).\nOnly works if the `field` property is set to `excerpt` or `ec_name`.", "fieldName": "shouldHighlight" }, { "name": "no-highlight", "type": { "text": "boolean" }, "default": "false", "description": "Disable highlighting of the string field value.\nOnly works if the `field` property is set to `excerpt` or `ec_name`.", "fieldName": "disableHighlight" }, { "name": "default", "type": { "text": "string" }, "description": "The locale key to use for displaying default text when the specified field has no value for the product.", "fieldName": "default" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-product-text", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicProductText", "declaration": { "name": "AtomicProductText", "module": "src/components/commerce/atomic-product-text/atomic-product-text.ts" } }, { "kind": "custom-element-definition", "name": "atomic-product-text", "declaration": { "name": "AtomicProductText", "module": "src/components/commerce/atomic-product-text/atomic-product-text.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/commerce/product-list/product-template-provider.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/product-template-component-utils/error.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/product-template-component-utils/product-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/commerce/sort/option.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-agent-stream-of-thought/atomic-agent-stream-of-thought.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-agent-stream-of-thought/atomic-agent-stream-of-thought.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-aria-live/atomic-aria-live.ts", "declarations": [ { "kind": "class", "description": "The `atomic-aria-live` component notifies screen readers of changes in the search and commerce interfaces.", "name": "AtomicAriaLive", "members": [ { "kind": "field", "name": "regions", "type": { "text": "Readonly" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "messagesQueue", "privacy": "private" }, { "kind": "field", "name": "queuedMessageIds", "privacy": "private", "default": "new Map>()" }, { "kind": "field", "name": "ariaLiveId", "type": { "text": "string" }, "privacy": "private" }, { "kind": "field", "name": "onFindAriaLive", "privacy": "private" }, { "kind": "method", "name": "updateMessage", "privacy": "public", "parameters": [ { "name": "region", "type": { "text": "string" }, "description": "The name of the ARIA live region to update." }, { "name": "message", "type": { "text": "string" }, "description": "The message to announce in the region." }, { "name": "assertive", "type": { "text": "boolean" }, "description": "Whether the region should use 'assertive' or 'polite' mode." }, { "name": "preserveQueuedMessages", "default": "false" } ], "description": "Updates the message and assertiveness for a specific ARIA live region.\nIf a message is provided, the update is debounced to avoid rapid changes.\nIf the message is empty, any pending update is canceled and the region is cleared immediately." }, { "kind": "method", "name": "registerRegion", "privacy": "public", "parameters": [ { "name": "region", "type": { "text": "string" }, "description": "The name of the ARIA live region to register." }, { "name": "assertive", "type": { "text": "boolean" }, "description": "Whether the region should use 'assertive' or 'polite' mode." } ], "description": "Registers a new ARIA live region if it does not already exist." }, { "kind": "method", "name": "clearQueuedMessages", "privacy": "private", "parameters": [ { "name": "region", "type": { "text": "string" } } ] }, { "kind": "method", "name": "getMessageQueueId", "privacy": "private", "parameters": [ { "name": "region", "type": { "text": "string" } }, { "name": "message", "type": { "text": "string" } } ] }, { "kind": "method", "name": "queueMessage", "privacy": "private", "parameters": [ { "name": "region", "type": { "text": "string" } }, { "name": "message", "type": { "text": "string" } }, { "name": "updateRegion", "type": { "text": "() => void" } } ] }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "events": [ { "description": "Dispatches an event to find the `atomic-aria-live` element.", "name": "atomic/accessibility/findAriaLive" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-aria-live", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicAriaLive", "declaration": { "name": "AtomicAriaLive", "module": "src/components/common/atomic-aria-live/atomic-aria-live.ts" } }, { "kind": "custom-element-definition", "name": "atomic-aria-live", "declaration": { "name": "AtomicAriaLive", "module": "src/components/common/atomic-aria-live/atomic-aria-live.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/atomic-ask-follow-up-input/atomic-ask-follow-up-input.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-ask-follow-up-input/atomic-ask-follow-up-input.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-citation/atomic-citation.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-citation/atomic-citation.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-citation/citation-anchoring-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-component-error/atomic-component-error.ts", "declarations": [ { "kind": "class", "description": "The `atomic-component-error` component is used by other components to render and log errors.", "name": "AtomicComponentError", "members": [ { "kind": "field", "name": "element", "type": { "text": "HTMLElement" }, "attribute": "element" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "attribute": "error", "privacy": "private" } ], "attributes": [ { "name": "element", "type": { "text": "HTMLElement" }, "fieldName": "element" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-component-error", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicComponentError", "declaration": { "name": "AtomicComponentError", "module": "src/components/common/atomic-component-error/atomic-component-error.ts" } }, { "kind": "custom-element-definition", "name": "atomic-component-error", "declaration": { "name": "AtomicComponentError", "module": "src/components/common/atomic-component-error/atomic-component-error.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/atomic-facet-date-input/atomic-facet-date-input.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-facet-number-input/atomic-facet-number-input.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-facet-placeholder/atomic-facet-placeholder.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-focus-trap/atomic-focus-trap.ts", "declarations": [ { "kind": "class", "description": "The `atomic-focus-trap` component manages focus within a modal or dialog,\nensuring keyboard navigation stays within the trap when active. When active,\nit hides sibling elements from assistive technologies and restricts tab focus\nto its descendants.", "name": "AtomicFocusTrap", "members": [ { "kind": "field", "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Whether the focus trap is active.", "attribute": "active" }, { "kind": "field", "name": "source", "type": { "text": "HTMLElement" }, "description": "The source element to focus when the focus trap becomes inactive.", "attribute": "source" }, { "kind": "field", "name": "container", "type": { "text": "HTMLElement" }, "description": "The container to hide (instead of the focus trap element itself) from the tabindex and accessibility DOM\nwhen the focus trap becomes inactive and `shouldHideSelf` is true.", "attribute": "container" }, { "kind": "field", "name": "shouldHideSelf", "type": { "text": "boolean" }, "default": "true", "description": "Whether the element should be hidden from screen readers & not interactive with the tab, when not active.", "attribute": "should-hide-self" }, { "kind": "field", "name": "scope", "type": { "text": "Element" }, "description": "The common ancestor of the focus trap and of all the elements that should be inaccessible when inside the focus trap.", "attribute": "scope" }, { "kind": "field", "name": "hiddenElements", "type": { "text": "Element[]" }, "privacy": "private", "readonly": true, "default": "[]" }, { "kind": "method", "name": "hide", "privacy": "private", "parameters": [ { "name": "element", "type": { "text": "Element" } } ] }, { "kind": "method", "name": "showAll", "privacy": "private" }, { "kind": "method", "name": "hideSiblingsRecursively", "privacy": "private", "parameters": [ { "name": "element", "type": { "text": "Element | ShadowRoot" } } ] }, { "kind": "method", "name": "showSelf", "privacy": "private" }, { "kind": "method", "name": "hideSelf", "privacy": "private" }, { "kind": "method", "name": "onDeactivated", "parameters": [ { "name": "isInitialLoad", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "onActivated", "parameters": [ { "name": "isInitialLoad", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "handleActiveChange", "parameters": [ { "name": "_prev", "optional": true, "type": { "text": "boolean" } }, { "name": "next", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "field", "name": "onFocusChanged", "privacy": "private" }, { "kind": "field", "name": "parentToHide", "type": { "text": "Element" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Whether the focus trap is active.", "fieldName": "active" }, { "name": "source", "type": { "text": "HTMLElement" }, "description": "The source element to focus when the focus trap becomes inactive.", "fieldName": "source" }, { "name": "container", "type": { "text": "HTMLElement" }, "description": "The container to hide (instead of the focus trap element itself) from the tabindex and accessibility DOM\nwhen the focus trap becomes inactive and `shouldHideSelf` is true.", "fieldName": "container" }, { "name": "should-hide-self", "type": { "text": "boolean" }, "default": "true", "description": "Whether the element should be hidden from screen readers & not interactive with the tab, when not active.", "fieldName": "shouldHideSelf" }, { "name": "scope", "type": { "text": "Element" }, "description": "The common ancestor of the focus trap and of all the elements that should be inaccessible when inside the focus trap.", "fieldName": "scope" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-focus-trap", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicFocusTrap", "declaration": { "name": "AtomicFocusTrap", "module": "src/components/common/atomic-focus-trap/atomic-focus-trap.ts" } }, { "kind": "custom-element-definition", "name": "atomic-focus-trap", "declaration": { "name": "AtomicFocusTrap", "module": "src/components/common/atomic-focus-trap/atomic-focus-trap.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/atomic-generated-answer-content/answer-context.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-generated-answer-content/atomic-generated-answer-content.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-generated-answer-feedback-modal/atomic-generated-answer-feedback-modal.ts", "declarations": [ { "kind": "class", "description": "Internal component, only to use through `atomic-generated-answer` or `atomic-insight-generated-answer`", "name": "AtomicGeneratedAnswerFeedbackModal", "cssParts": [ { "description": "The transparent backdrop hiding the content behind the modal.", "name": "backdrop" }, { "description": "The modal's outermost container with the outline and background.", "name": "container" }, { "description": "The modal header container.", "name": "modal-header" }, { "description": "The wrapper around the close button.", "name": "close-button-wrapper" }, { "description": "The close button.", "name": "close-button" }, { "description": "The feedback form.", "name": "form" }, { "description": "The modal footer container.", "name": "modal-footer" }, { "description": "The cancel/skip button.", "name": "cancel-button" }, { "description": "The submit button.", "name": "submit-button" } ], "members": [ { "kind": "field", "name": "options", "type": { "text": "{\n localeKey: string;\n correspondingAnswer: keyof GeneratedAnswerFeedback;\n }[]" }, "privacy": "private", "static": true, "default": "[ { localeKey: 'feedback-correct-topic', correspondingAnswer: 'correctTopic', }, { localeKey: 'feedback-hallucination-free', correspondingAnswer: 'hallucinationFree', }, { localeKey: 'feedback-documented', correspondingAnswer: 'documented', }, { localeKey: 'feedback-readable', correspondingAnswer: 'readable', }, ]" }, { "kind": "field", "name": "isOpen", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the modal is open.", "attribute": "is-open", "reflects": true }, { "kind": "field", "name": "generatedAnswer", "type": { "text": "GeneratedAnswer" }, "description": "A `GeneratedAnswer` controller instance. It is used when the user interacts with the modal." }, { "kind": "field", "name": "helpful", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the answer was helpful or not.", "attribute": "helpful", "reflects": true }, { "kind": "field", "name": "bindings", "type": { "text": "AnyBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "currentAnswer", "type": { "text": "Partial" }, "privacy": "private" }, { "kind": "field", "name": "feedbackSubmitted", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "answerEvaluationRequired", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "formId", "privacy": "private", "readonly": true }, { "kind": "field", "name": "detailsInputRef", "type": { "text": "Ref" }, "privacy": "private" }, { "kind": "field", "name": "linkInputRef", "type": { "text": "Ref" }, "privacy": "private" }, { "kind": "field", "name": "updateBreakpoints", "privacy": "private" }, { "kind": "method", "name": "initialize" }, { "kind": "method", "name": "watchToggleOpen", "parameters": [ { "name": "_oldValue", "type": { "text": "boolean | undefined" } }, { "name": "newValue", "type": { "text": "boolean | undefined" } } ] }, { "kind": "method", "name": "getInitialAnswerState", "privacy": "private", "return": { "type": { "text": "Partial" } } }, { "kind": "method", "name": "resetState", "privacy": "private" }, { "kind": "method", "name": "clearInputRefs", "privacy": "private" }, { "kind": "method", "name": "close", "privacy": "private" }, { "kind": "method", "name": "setCurrentAnswer", "privacy": "private", "parameters": [ { "name": "key", "type": { "text": "keyof GeneratedAnswerFeedback" } }, { "name": "value", "type": { "text": "GeneratedAnswerFeedbackOption | string" } } ] }, { "kind": "method", "name": "sendFeedback", "privacy": "public" }, { "kind": "field", "name": "isAnyAnswerEvaluationUndefined", "privacy": "private" }, { "kind": "method", "name": "handleSubmit", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "renderHeader", "privacy": "private" }, { "kind": "method", "name": "renderFeedbackOption", "privacy": "private", "parameters": [ { "name": "option", "type": { "text": "GeneratedAnswerFeedbackOption" } }, { "name": "correspondingAnswer", "type": { "text": "keyof GeneratedAnswerFeedback" } } ] }, { "kind": "method", "name": "renderAnswerEvaluation", "privacy": "private", "parameters": [ { "name": "label", "type": { "text": "string" } }, { "name": "correspondingAnswer", "type": { "text": "keyof GeneratedAnswerFeedback" } } ] }, { "kind": "method", "name": "renderRequiredFieldsAlert", "privacy": "private" }, { "kind": "method", "name": "renderFeedbackOptions", "privacy": "private" }, { "kind": "method", "name": "renderLinkToCorrectAnswerField", "privacy": "private" }, { "kind": "method", "name": "renderAddNotesField", "privacy": "private" }, { "kind": "method", "name": "renderFeedbackForm", "privacy": "private" }, { "kind": "method", "name": "renderSuccessMessage", "privacy": "private" }, { "kind": "method", "name": "renderBody", "privacy": "private" }, { "kind": "method", "name": "renderFeedbackFormFooter", "privacy": "private" }, { "kind": "method", "name": "renderSuccessFormFooter", "privacy": "private" }, { "kind": "method", "name": "renderFooter", "privacy": "private" } ], "events": [ { "name": "feedbackSent", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "is-open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the modal is open.", "fieldName": "isOpen" }, { "name": "helpful", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the answer was helpful or not.", "fieldName": "helpful" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-generated-answer-feedback-modal", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicGeneratedAnswerFeedbackModal", "declaration": { "name": "AtomicGeneratedAnswerFeedbackModal", "module": "src/components/common/atomic-generated-answer-feedback-modal/atomic-generated-answer-feedback-modal.ts" } }, { "kind": "custom-element-definition", "name": "atomic-generated-answer-feedback-modal", "declaration": { "name": "AtomicGeneratedAnswerFeedbackModal", "module": "src/components/common/atomic-generated-answer-feedback-modal/atomic-generated-answer-feedback-modal.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/atomic-generated-answer-inline-link/atomic-generated-answer-inline-link.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-generated-answer-inline-link/atomic-generated-answer-inline-link.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-generated-answer-thread/atomic-generated-answer-thread.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-generated-answer-thread-item/atomic-generated-answer-thread-item.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-icon/atomic-icon.ts", "declarations": [ { "kind": "class", "description": "The `atomic-icon` component displays an SVG icon with a 1:1 aspect ratio.\n\nThis component can display an icon from those available in the Atomic package, from a specific location, or as an inline SVG element.", "name": "AtomicIcon", "members": [ { "kind": "field", "name": "icon", "type": { "text": "string" }, "description": "The SVG icon to display.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.", "attribute": "icon", "reflects": true }, { "kind": "field", "name": "bindings", "type": { "text": "AnyBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "svg", "type": { "text": "string | null" }, "privacy": "private", "default": "null" }, { "kind": "method", "name": "fetchIcon", "privacy": "private", "parameters": [ { "name": "url", "type": { "text": "string" } } ] }, { "kind": "method", "name": "validateSVG", "privacy": "private", "parameters": [ { "name": "svg", "type": { "text": "string" } } ] }, { "kind": "method", "name": "getIcon", "privacy": "private" }, { "kind": "method", "name": "updateIcon", "privacy": "public" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "initBindings", "privacy": "private", "inheritedFrom": { "name": "InitializeBindingsMixin", "module": "src/mixins/bindings-mixin.ts" } } ], "attributes": [ { "name": "icon", "type": { "text": "string" }, "description": "The SVG icon to display.\n\n- Use a value that starts with `http://`, `https://`, `./`, or `../`, to fetch and display an icon from a given location.\n- Use a value that starts with `assets://`, to display an icon from the Atomic package.\n- Use a stringified SVG to display it directly.", "fieldName": "icon" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" }, { "name": "InitializeBindingsMixin", "package": "@/src/mixins/bindings-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-icon", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicIcon", "declaration": { "name": "AtomicIcon", "module": "src/components/common/atomic-icon/atomic-icon.ts" } }, { "kind": "custom-element-definition", "name": "atomic-icon", "declaration": { "name": "AtomicIcon", "module": "src/components/common/atomic-icon/atomic-icon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/atomic-icon/fetch-icon.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-layout-section/atomic-layout-section-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-layout-section/atomic-layout-section.ts", "declarations": [ { "kind": "class", "description": "The `atomic-layout-section` lets you identify various sections for the related `atomic-search-layout` or `atomic-commerce-layout` component.", "name": "AtomicLayoutSection", "slots": [ { "description": "The default slot where you can add child components to the section.", "name": "default" } ], "members": [ { "kind": "field", "name": "section", "type": { "text": "Section" }, "description": "The name of the layout section.", "attribute": "section", "reflects": true }, { "kind": "field", "name": "minWidth", "type": { "text": "string" }, "description": "For column sections, the minimum horizontal space it should take.\nFor example, '300px'", "attribute": "min-width", "reflects": true }, { "kind": "field", "name": "maxWidth", "type": { "text": "string" }, "description": "For column sections, the maximum horizontal space it should take.\nFor example, '300px'", "attribute": "max-width", "reflects": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "section", "type": { "text": "Section" }, "description": "The name of the layout section.", "fieldName": "section" }, { "name": "min-width", "type": { "text": "string" }, "description": "For column sections, the minimum horizontal space it should take.\nFor example, '300px'", "fieldName": "minWidth" }, { "name": "max-width", "type": { "text": "string" }, "description": "For column sections, the maximum horizontal space it should take.\nFor example, '300px'", "fieldName": "maxWidth" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-layout-section", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicLayoutSection", "declaration": { "name": "AtomicLayoutSection", "module": "src/components/common/atomic-layout-section/atomic-layout-section.ts" } }, { "kind": "custom-element-definition", "name": "atomic-layout-section", "declaration": { "name": "AtomicLayoutSection", "module": "src/components/common/atomic-layout-section/atomic-layout-section.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/atomic-layout-section/layout.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-modal/atomic-modal.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-modal/export-parts.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-numeric-range/atomic-numeric-range.ts", "declarations": [ { "kind": "class", "description": "The `atomic-numeric-range` component defines the range of an `atomic-numeric-facet`, and therefore must be defined within an `atomic-numeric-facet` component.", "name": "AtomicNumericRange", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The non-localized label for the facet. When defined, it will appear instead of the formatted value.\nUsed in the `atomic-breadbox` component through the bindings store.", "attribute": "label", "reflects": true }, { "kind": "field", "name": "start", "type": { "text": "number" }, "privacy": "public", "description": "The starting value for the numeric range.", "attribute": "start", "reflects": true }, { "kind": "field", "name": "end", "type": { "text": "number" }, "privacy": "public", "description": "The ending value for the numeric range.", "attribute": "end", "reflects": true }, { "kind": "field", "name": "endInclusive", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Specifies whether the end value should be included in the range.", "attribute": "endInclusive", "reflects": true }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "The non-localized label for the facet. When defined, it will appear instead of the formatted value.\nUsed in the `atomic-breadbox` component through the bindings store.", "fieldName": "label" }, { "name": "start", "type": { "text": "number" }, "description": "The starting value for the numeric range.", "fieldName": "start" }, { "name": "end", "type": { "text": "number" }, "description": "The ending value for the numeric range.", "fieldName": "end" }, { "name": "endInclusive", "type": { "text": "boolean" }, "default": "false", "description": "Specifies whether the end value should be included in the range.", "fieldName": "endInclusive" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-numeric-range", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicNumericRange", "declaration": { "name": "AtomicNumericRange", "module": "src/components/common/atomic-numeric-range/atomic-numeric-range.ts" } }, { "kind": "custom-element-definition", "name": "atomic-numeric-range", "declaration": { "name": "AtomicNumericRange", "module": "src/components/common/atomic-numeric-range/atomic-numeric-range.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/atomic-rating/atomic-rating.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-rating/rating-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-rating/rating.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-result-placeholder/atomic-result-placeholder.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-result-placeholder/item-placeholders.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-smart-snippet-answer/atomic-smart-snippet-answer.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-smart-snippet-answer/atomic-smart-snippet-answer.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-smart-snippet-collapse-wrapper/atomic-smart-snippet-collapse-wrapper.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-smart-snippet-expandable-answer/atomic-smart-snippet-expandable-answer.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-smart-snippet-expandable-answer/atomic-smart-snippet-expandable-answer.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-smart-snippet-source/atomic-smart-snippet-source.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-tab-bar/atomic-tab-bar.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-tab-button/atomic-tab-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-tab-popover/atomic-tab-popover.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/atomic-timeframe/atomic-timeframe.ts", "declarations": [ { "kind": "class", "description": "The `atomic-timeframe` component defines a timeframe for an `atomic-timeframe-facet`.\nThis component must be a child of an `atomic-timeframe-facet` component.\n\nA timeframe represents a span of time relative to the current moment, either in the past or future.", "name": "AtomicTimeframe", "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ period: new StringValue({ constrainTo: ['past', 'next'], required: false, }), unit: new StringValue({ constrainTo: ['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year'], required: true, emptyAllowed: false, }), amount: new NumberValue({min: 1, required: false}), })" }, { "kind": "field", "name": "period", "type": { "text": "'past' | 'next'" }, "privacy": "public", "default": "'past'", "description": "The direction of time relative to the current moment.", "attribute": "period", "reflects": true }, { "kind": "field", "name": "unit", "type": { "text": "RelativeDateUnit" }, "privacy": "public", "description": "The unit of time for the timeframe (e.g., \"day\", \"week\", \"month\").", "attribute": "unit", "reflects": true }, { "kind": "field", "name": "amount", "type": { "text": "number" }, "privacy": "public", "default": "1", "description": "The number of time units for the timeframe.", "attribute": "amount", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "A custom, non-localized label for the timeframe.\nWhen specified, this label appears instead of the auto-generated timeframe description.", "attribute": "label", "reflects": true }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "attributes": [ { "name": "period", "type": { "text": "'past' | 'next'" }, "default": "'past'", "description": "The direction of time relative to the current moment.", "fieldName": "period" }, { "name": "unit", "type": { "text": "RelativeDateUnit" }, "description": "The unit of time for the timeframe (e.g., \"day\", \"week\", \"month\").", "fieldName": "unit" }, { "name": "amount", "type": { "text": "number" }, "default": "1", "description": "The number of time units for the timeframe.", "fieldName": "amount" }, { "name": "label", "type": { "text": "string" }, "description": "A custom, non-localized label for the timeframe.\nWhen specified, this label appears instead of the auto-generated timeframe description.", "fieldName": "label" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-timeframe", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicTimeframe", "declaration": { "name": "AtomicTimeframe", "module": "src/components/common/atomic-timeframe/atomic-timeframe.ts" } }, { "kind": "custom-element-definition", "name": "atomic-timeframe", "declaration": { "name": "AtomicTimeframe", "module": "src/components/common/atomic-timeframe/atomic-timeframe.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/breadbox/breadcrumb-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/breadbox/breadcrumb-clear-all.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/breadbox/breadcrumb-container.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/breadbox/breadcrumb-content.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/breadbox/breadcrumb-show-less.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/breadbox/breadcrumb-show-more.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/breadbox/breadcrumb-types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/breadbox/breadcrumb-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/context/bindings-context.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/expandable-text/expandable-text.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/facets/depends-on.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/facets/facet-common-store.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/facets/facet-common.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/facets/facet-common.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/facets/facet-visibility-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/facets/numeric-facet-common.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/facets/timeframe-facet-common.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/formats/format-common.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/copy-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/feedback-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/generated-answer-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/generated-answer-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/generated-content-container.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/render-answer-content.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/render-card-header.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/render-citations.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/render-conversation-debug-header.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/render-custom-no-answer-message.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/render-disclaimer.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/render-feedback-and-copy-buttons.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/render-generating-answer-label.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/retry-prompt.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/show-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/generated-answer/source-citations.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/image-carousel/image-carousel-indicators.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/image-carousel/image-carousel.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/interface/analytics-config.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/interface/bindings.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/interface/i18n.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/interface/interface-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/interface/store.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-link/attributes-slot.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-link/bind-analytics-to-link.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-link/item-link.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-list/display-wrapper.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-list/fetch-item-context.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-list/grid-layout.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-list/item-list-common.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-list/item-list.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-list/result-template-provider.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-list/table-layout.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-list/unfolded-item.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-text/field-warning.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-text/item-text-fallback.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-text/item-text-highlighted.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/item-text/render-highlights.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/items-per-page/choices.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/items-per-page/error.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/items-per-page/label.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/items-per-page/validate.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/layout/custom-render-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/layout/item-layout-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/layout/item-layout-sections.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/layout/item-layout-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/layout/layout-styles-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/layout/mobile-breakpoint-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/load-more/button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/load-more/container.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/load-more/progress-bar.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/load-more/summary.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/no-items/cancel.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/no-items/container.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/no-items/guard.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/no-items/magnifying-glass.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/no-items/no-items.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/no-items/tips.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/no-items/utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/pager/pager-buttons.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/pager/pager-navigation.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/pager/pager-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/product-template/product-template-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-correction/auto-correction.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-correction/correction.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-correction/trigger-correction.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/container.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/description.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/details.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/icon.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/known-error-types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/link.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/show-more.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/title.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-error/utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-summary/container.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-summary/guard.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/query-summary/utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/refine-modal/body.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/refine-modal/button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/refine-modal/cloned-facet-elements.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/refine-modal/filters.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/refine-modal/guard.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/refine-modal/modal.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/refine-modal/sort.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/result-children/children-wrapper.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/result-children/collection-guard.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/result-children/guard.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/result-children/show-hide-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/result-templates/recs-result-template-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/result-templates/result-template-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/search-box/redirection-payload.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/search-box/search-box-wrapper.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/search-box/search-text-area.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/search-box/submit-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/search-box/text-area-clear-button.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/smart-snippets/smart-snippet-feedback-banner.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/sort/label.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/sort/option.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/sort/select.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/sort/sort-guard.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/suggestions/instant-item.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/suggestions/query-suggestions.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/suggestions/recent-queries.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/suggestions/suggestion-manager.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/suggestions/suggestions-events.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/suggestions/suggestions-types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/suggestions/suggestions-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/tabs/tab-common.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/tabs/tab-wrapper.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/template-controller/base-template-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/template-controller/template-utils.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/template-provider/template-provider.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/validate-props-controller/validate-props-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-edit-toggle/atomic-insight-edit-toggle.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-edit-toggle` component provides an edit button for insight interfaces.", "name": "AtomicInsightEditToggle", "cssParts": [ { "description": "The container element wrapping the edit toggle icon button.", "name": "insight-edit-toggle-container" }, { "description": "The edit button element.", "name": "insight-edit-toggle-button" }, { "description": "The edit icon element displayed inside the button.", "name": "insight-edit-toggle-icon" } ], "members": [ { "kind": "field", "name": "clickCallback", "type": { "text": "() => void" }, "privacy": "public", "description": "The callback function to be executed when the button is clicked.", "attribute": "clickCallback" }, { "kind": "field", "name": "tooltip", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The tooltip text to display on hover.", "attribute": "tooltip" } ], "attributes": [ { "name": "clickCallback", "type": { "text": "() => void" }, "description": "The callback function to be executed when the button is clicked.", "fieldName": "clickCallback" }, { "name": "tooltip", "type": { "text": "string" }, "default": "''", "description": "The tooltip text to display on hover.", "fieldName": "tooltip" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-edit-toggle", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightEditToggle", "declaration": { "name": "AtomicInsightEditToggle", "module": "src/components/insight/atomic-insight-edit-toggle/atomic-insight-edit-toggle.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-edit-toggle", "declaration": { "name": "AtomicInsightEditToggle", "module": "src/components/insight/atomic-insight-edit-toggle/atomic-insight-edit-toggle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-facet/atomic-insight-facet.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-facet` component displays a facet of the results for the current query in an Insight interface.\nA facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (for example, number of occurrences).", "name": "AtomicInsightFacet", "cssParts": [ { "description": "The wrapper for the entire facet.", "name": "facet" }, { "description": "The placeholder shown before the first search is executed.", "name": "placeholder" }, { "description": "The button that displays the label and allows to expand/collapse the facet.", "name": "label-button" }, { "description": "The label button icon.", "name": "label-button-icon" }, { "description": "The button that resets the actively selected facet values.", "name": "clear-button" }, { "description": "The clear button icon.", "name": "clear-button-icon" }, { "description": "The facet values container.", "name": "values" }, { "description": "The facet value label, common for all displays.", "name": "value-label" }, { "description": "The facet value count, common for all displays.", "name": "value-count" }, { "description": "The facet value checkbox, available when display is 'checkbox'.", "name": "value-checkbox" }, { "description": "The checked facet value checkbox, available when display is 'checkbox'.", "name": "value-checkbox-checked" }, { "description": "The facet value checkbox clickable label, available when display is 'checkbox'.", "name": "value-checkbox-label" }, { "description": "The facet value checkbox icon, available when display is 'checkbox'.", "name": "value-checkbox-icon" }, { "description": "The facet value when display is 'link'.", "name": "value-link" }, { "description": "The selected facet value when display is 'link'.", "name": "value-link-selected" }, { "description": "The facet value when display is 'box'.", "name": "value-box" }, { "description": "The selected facet value when display is 'box'.", "name": "value-box-selected" }, { "description": "The button to exclude a facet value, available when display is 'checkbox'.", "name": "value-exclude-button" } ], "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ field: new StringValue({required: true, emptyAllowed: false}), numberOfValues: new NumberValue({min: 1}), injectionDepth: new NumberValue({min: 0}), })" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "'no-label'", "description": "The non-localized label for the facet.", "attribute": "label", "reflects": true }, { "kind": "field", "name": "field", "type": { "text": "string" }, "description": "The field whose values you want to display in the facet.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "numberOfValues", "type": { "text": "number" }, "default": "8", "description": "The number of values to request for this facet.\nAlso determines the number of additional values to request each time more values are shown.", "attribute": "number-of-values", "reflects": true }, { "kind": "field", "name": "sortCriteria", "type": { "text": "InsightFacetSortCriterion" }, "default": "'automatic'", "description": "The sort criterion to apply to the returned facet values.\nPossible values are 'score', 'alphanumeric', 'alphanumericDescending', 'occurrences', 'alphanumericNatural', 'alphanumericNaturalDescending' and 'automatic'.", "attribute": "sort-criteria", "reflects": true }, { "kind": "field", "name": "displayValuesAs", "type": { "text": "'checkbox' | 'link' | 'box'" }, "default": "'checkbox'", "description": "Whether to display the facet values as checkboxes (multiple selection), links (single selection) or boxes (multiple selection).\nPossible values are 'checkbox', 'link', and 'box'.", "attribute": "display-values-as", "reflects": true }, { "kind": "field", "name": "isCollapsed", "type": { "text": "boolean" }, "default": "false", "description": "Specifies if the facet is collapsed.", "attribute": "is-collapsed", "reflects": true }, { "kind": "field", "name": "headingLevel", "type": { "text": "number" }, "default": "0", "description": "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.", "attribute": "heading-level", "reflects": true }, { "kind": "field", "name": "filterFacetCount", "type": { "text": "boolean" }, "default": "true", "description": "Whether to exclude the parents of folded results when estimating the result count for each facet value.\n\nNote: Resulting count is only an estimation, in some cases this value could be incorrect.", "attribute": "filter-facet-count", "reflects": true }, { "kind": "field", "name": "injectionDepth", "type": { "text": "number" }, "default": "1000", "description": "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`", "attribute": "injection-depth" }, { "kind": "field", "name": "enableExclusion", "type": { "text": "boolean" }, "default": "false", "description": "Whether to allow excluding values from the facet.", "attribute": "enable-exclusion", "reflects": true }, { "kind": "field", "name": "facetId", "type": { "text": "string" }, "description": "Specifies a unique identifier for the facet.", "attribute": "facet-id", "reflects": true }, { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "facetState", "type": { "text": "InsightFacetState" }, "privacy": "private" }, { "kind": "field", "name": "searchStatusState", "type": { "text": "InsightSearchStatusState" }, "privacy": "private" }, { "kind": "field", "name": "facet", "type": { "text": "InsightFacet" }, "privacy": "private" }, { "kind": "field", "name": "searchStatus", "type": { "text": "InsightSearchStatus" }, "privacy": "private" }, { "kind": "field", "name": "dependsOn", "type": { "text": "object" }, "privacy": "public", "default": "{}" }, { "kind": "field", "name": "showLessFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "showMoreFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "headerFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "facetConditionsManager", "type": { "text": "InsightFacetConditionsManager | undefined" }, "privacy": "private" }, { "kind": "field", "name": "facetSearchAriaLiveController", "type": { "text": "AriaLiveRegionController" }, "privacy": "private" }, { "kind": "field", "name": "valuesBeforeShowMore", "privacy": "private", "default": "new Set()" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "focusTargets", "type": { "text": "{\n showLess: FocusTargetController;\n showMore: FocusTargetController;\n header: FocusTargetController;\n }" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "shouldRenderFacet", "privacy": "private" }, { "kind": "method", "name": "renderFacetHeader", "privacy": "private" }, { "kind": "method", "name": "renderBody", "privacy": "private" }, { "kind": "method", "name": "renderValuesContainer", "privacy": "private", "parameters": [ { "name": "children", "type": { "text": "unknown" } } ] }, { "kind": "method", "name": "renderValues", "privacy": "private" }, { "kind": "method", "name": "renderShowMoreLess", "privacy": "private" }, { "kind": "field", "name": "activeValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "facetValueProps", "type": { "text": "Pick<\n FacetValueProps,\n 'displayValuesAs' | 'facetSearchQuery' | 'enableExclusion' | 'field' | 'i18n'\n >" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "initAriaLive", "privacy": "private" }, { "kind": "method", "name": "initConditionManager", "privacy": "private" }, { "kind": "method", "name": "initPopover", "privacy": "private" }, { "kind": "field", "name": "isHidden", "privacy": "private", "readonly": true }, { "kind": "field", "name": "facetInfo", "type": { "text": "FacetInfo" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "registerFacet", "privacy": "private" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "'no-label'", "description": "The non-localized label for the facet.", "fieldName": "label" }, { "name": "field", "type": { "text": "string" }, "description": "The field whose values you want to display in the facet.", "fieldName": "field" }, { "name": "number-of-values", "type": { "text": "number" }, "default": "8", "description": "The number of values to request for this facet.\nAlso determines the number of additional values to request each time more values are shown.", "fieldName": "numberOfValues" }, { "name": "sort-criteria", "type": { "text": "InsightFacetSortCriterion" }, "default": "'automatic'", "description": "The sort criterion to apply to the returned facet values.\nPossible values are 'score', 'alphanumeric', 'alphanumericDescending', 'occurrences', 'alphanumericNatural', 'alphanumericNaturalDescending' and 'automatic'.", "fieldName": "sortCriteria" }, { "name": "display-values-as", "type": { "text": "'checkbox' | 'link' | 'box'" }, "default": "'checkbox'", "description": "Whether to display the facet values as checkboxes (multiple selection), links (single selection) or boxes (multiple selection).\nPossible values are 'checkbox', 'link', and 'box'.", "fieldName": "displayValuesAs" }, { "name": "is-collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Specifies if the facet is collapsed.", "fieldName": "isCollapsed" }, { "name": "heading-level", "type": { "text": "number" }, "default": "0", "description": "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.", "fieldName": "headingLevel" }, { "name": "filter-facet-count", "type": { "text": "boolean" }, "default": "true", "description": "Whether to exclude the parents of folded results when estimating the result count for each facet value.\n\nNote: Resulting count is only an estimation, in some cases this value could be incorrect.", "fieldName": "filterFacetCount" }, { "name": "injection-depth", "type": { "text": "number" }, "default": "1000", "description": "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`", "fieldName": "injectionDepth" }, { "name": "enable-exclusion", "type": { "text": "boolean" }, "default": "false", "description": "Whether to allow excluding values from the facet.", "fieldName": "enableExclusion" }, { "name": "facet-id", "type": { "text": "string" }, "description": "Specifies a unique identifier for the facet.", "fieldName": "facetId" } ], "cssStates": [ { "description": "Applied when the facet is hidden.", "name": "hidden" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-facet", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightFacet", "declaration": { "name": "AtomicInsightFacet", "module": "src/components/insight/atomic-insight-facet/atomic-insight-facet.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-facet", "declaration": { "name": "AtomicInsightFacet", "module": "src/components/insight/atomic-insight-facet/atomic-insight-facet.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-folded-result-list/atomic-insight-folded-result-list.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-folded-result-list` component is responsible for displaying folded query results in an insight panel,\nby applying one or more result templates.", "name": "AtomicInsightFoldedResultList", "cssParts": [ { "description": "The element containing every result of a result list", "name": "result-list" }, { "description": "The element displaying an outline or a divider around a result", "name": "outline" } ], "slots": [ { "description": "The default slot where the result templates are inserted.", "name": "default" } ], "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ density: new StringValue({ constrainTo: ['normal', 'comfortable', 'compact'], }), imageSize: new StringValue({ constrainTo: ['small', 'large', 'icon', 'none'], }), numberOfFoldedResults: new NumberValue({min: 0}), })" }, { "kind": "field", "name": "foldedResultList", "type": { "text": "InsightFoldedResultList" }, "privacy": "private" }, { "kind": "field", "name": "resultsPerPage", "type": { "text": "InsightResultsPerPage" }, "privacy": "private" }, { "kind": "field", "name": "itemRenderingFunction", "type": { "text": "ItemRenderingFunction" }, "privacy": "private" }, { "kind": "field", "name": "loadingFlag", "privacy": "private" }, { "kind": "field", "name": "nextNewResultTarget", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "resultListCommon", "type": { "text": "ItemListCommon" }, "privacy": "private" }, { "kind": "field", "name": "resultTemplateProvider", "type": { "text": "ResultTemplateProvider" }, "privacy": "private" }, { "kind": "field", "name": "display", "type": { "text": "ItemDisplayLayout" }, "privacy": "private", "readonly": true, "default": "'list'" }, { "kind": "field", "name": "density", "type": { "text": "ItemDisplayDensity" }, "privacy": "public", "default": "'normal'", "description": "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.", "attribute": "density", "reflects": true }, { "kind": "field", "name": "imageSize", "type": { "text": "ItemDisplayImageSize" }, "privacy": "public", "default": "'icon'", "description": "The expected size of the image displayed in the results.", "attribute": "image-size", "reflects": true }, { "kind": "field", "name": "collectionField", "type": { "text": "string" }, "privacy": "public", "description": "The name of the field on which to do the folding. The folded result list component will use the values of this field to resolve the collections of result items.", "attribute": "collection-field", "reflects": true }, { "kind": "field", "name": "parentField", "type": { "text": "string" }, "privacy": "public", "description": "The name of the field that determines whether a certain result is a top result containing other child results within a collection.", "attribute": "parent-field", "reflects": true }, { "kind": "field", "name": "childField", "type": { "text": "string" }, "privacy": "public", "description": "The name of the field that uniquely identifies a result within a collection.", "attribute": "child-field", "reflects": true }, { "kind": "field", "name": "numberOfFoldedResults", "type": { "text": "number" }, "privacy": "public", "default": "2", "description": "The initial number of child results to request for each folded collection, before expansion.", "attribute": "number-of-folded-results", "reflects": true }, { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "isAppLoaded", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "isEveryResultReady", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "resultTemplateRegistered", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "templateHasError", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "foldedResultListState", "type": { "text": "InsightFoldedResultListState" }, "privacy": "private" }, { "kind": "field", "name": "resultsPerPageState", "type": { "text": "InsightResultsPerPageState" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "setRenderFunction", "privacy": "public", "parameters": [ { "name": "resultRenderingFunction", "type": { "text": "ItemRenderingFunction" } } ], "description": "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 such as React, Angular, or Vue.\n\nDo not use this method if you integrate Atomic in a plain HTML deployment." }, { "kind": "method", "name": "updateResultReadyState", "privacy": "private" }, { "kind": "field", "name": "handleResolveFoldedResultList", "privacy": "private" }, { "kind": "field", "name": "handleLoadCollection", "privacy": "private" }, { "kind": "method", "name": "initFolding", "privacy": "private", "return": { "type": { "text": "InsightFoldedResultList" } } }, { "kind": "method", "name": "initResultTemplateProvider", "privacy": "private" }, { "kind": "method", "name": "initResultListCommon", "privacy": "private" }, { "kind": "method", "name": "computeListDisplayClasses", "privacy": "private" }, { "kind": "method", "name": "renderList", "privacy": "private" }, { "kind": "field", "name": "focusTarget", "privacy": "private", "readonly": true }, { "kind": "method", "name": "getContent", "privacy": "private", "parameters": [ { "name": "collection", "type": { "text": "InsightFoldedCollection" } } ] }, { "kind": "method", "name": "getInteractiveResult", "privacy": "private", "parameters": [ { "name": "collection", "type": { "text": "InsightFoldedCollection" } } ] }, { "kind": "method", "name": "getResultId", "privacy": "private", "parameters": [ { "name": "collection", "type": { "text": "InsightFoldedCollection" } } ] }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "density", "type": { "text": "ItemDisplayDensity" }, "default": "'normal'", "description": "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.", "fieldName": "density" }, { "name": "image-size", "type": { "text": "ItemDisplayImageSize" }, "default": "'icon'", "description": "The expected size of the image displayed in the results.", "fieldName": "imageSize" }, { "name": "collection-field", "type": { "text": "string" }, "description": "The name of the field on which to do the folding. The folded result list component will use the values of this field to resolve the collections of result items.", "fieldName": "collectionField" }, { "name": "parent-field", "type": { "text": "string" }, "description": "The name of the field that determines whether a certain result is a top result containing other child results within a collection.", "fieldName": "parentField" }, { "name": "child-field", "type": { "text": "string" }, "description": "The name of the field that uniquely identifies a result within a collection.", "fieldName": "childField" }, { "name": "number-of-folded-results", "type": { "text": "number" }, "default": "2", "description": "The initial number of child results to request for each folded collection, before expansion.", "fieldName": "numberOfFoldedResults" } ], "mixins": [ { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-folded-result-list", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightFoldedResultList", "declaration": { "name": "AtomicInsightFoldedResultList", "module": "src/components/insight/atomic-insight-folded-result-list/atomic-insight-folded-result-list.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-folded-result-list", "declaration": { "name": "AtomicInsightFoldedResultList", "module": "src/components/insight/atomic-insight-folded-result-list/atomic-insight-folded-result-list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-full-search-button/atomic-insight-full-search-button.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-full-search-button` component is an internal button that links to the full search interface.", "name": "AtomicInsightFullSearchButton", "cssProperties": [ { "description": "The background color of the button.", "name": "--full-search-background-color" }, { "description": "The background color of the button on hover.", "name": "--full-search-secondary-background-color" } ], "cssParts": [ { "description": "The container wrapper for the button.", "name": "full-search-container" }, { "description": "The button element.", "name": "full-search-button" }, { "description": "The icon within the button.", "name": "full-search-icon" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "tooltip", "type": { "text": "string" }, "default": "''", "description": "The tooltip text for the full search button.", "attribute": "tooltip" }, { "kind": "method", "name": "initialize", "privacy": "public" } ], "attributes": [ { "name": "tooltip", "type": { "text": "string" }, "default": "''", "description": "The tooltip text for the full search button.", "fieldName": "tooltip" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-full-search-button", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightFullSearchButton", "declaration": { "name": "AtomicInsightFullSearchButton", "module": "src/components/insight/atomic-insight-full-search-button/atomic-insight-full-search-button.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-full-search-button", "declaration": { "name": "AtomicInsightFullSearchButton", "module": "src/components/insight/atomic-insight-full-search-button/atomic-insight-full-search-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-generate-answer-button/atomic-insight-generate-answer-button.ts", "declarations": [ { "kind": "class", "description": "The atomic-insight-generate-answer-button component is an internal component made for builders preview.", "name": "AtomicInsightGenerateAnswerButton", "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "querySummary", "type": { "text": "QuerySummary" }, "privacy": "private" }, { "kind": "field", "name": "querySummaryState", "type": { "text": "QuerySummaryState" }, "privacy": "private" }, { "kind": "field", "name": "tooltip", "type": { "text": "string" }, "default": "'Generate Answer'", "description": "The tooltip text for the generate answer button.", "attribute": "tooltip" }, { "kind": "method", "name": "initialize", "privacy": "public" } ], "attributes": [ { "name": "tooltip", "type": { "text": "string" }, "default": "'Generate Answer'", "description": "The tooltip text for the generate answer button.", "fieldName": "tooltip" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-generate-answer-button", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightGenerateAnswerButton", "declaration": { "name": "AtomicInsightGenerateAnswerButton", "module": "src/components/insight/atomic-insight-generate-answer-button/atomic-insight-generate-answer-button.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-generate-answer-button", "declaration": { "name": "AtomicInsightGenerateAnswerButton", "module": "src/components/insight/atomic-insight-generate-answer-button/atomic-insight-generate-answer-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-generated-answer/atomic-insight-generated-answer.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-generated-answer` component uses Coveo Machine Learning (Coveo ML) models to automatically generate an answer to a query executed by the user.", "name": "AtomicInsightGeneratedAnswer", "cssParts": [ { "description": "The container displaying the generated answer.", "name": "container" }, { "description": "The header of the generated answer container.", "name": "header-label" }, { "description": "The \"like\" and \"dislike\" buttons.", "name": "feedback-button" }, { "description": "The switch to toggle the visibility of the generated answer.", "name": "toggle" }, { "description": "The \"Copy answer\" button.", "name": "copy-button" }, { "description": "The container for the \"retry\" section.", "name": "retry-container" }, { "description": "The text of the generated answer.", "name": "generated-text" }, { "description": "The header of the citations list.", "name": "citations-label" }, { "description": "The generated answer multi-line code blocks.", "name": "answer-code-block" }, { "description": "The generated answer emphasized text elements.", "name": "answer-emphasis" }, { "description": "The generated answer inline code elements.", "name": "answer-inline-code" }, { "description": "The generated answer level 1 heading elements.", "name": "answer-heading-1" }, { "description": "The generated answer level 2 heading elements.", "name": "answer-heading-2" }, { "description": "The generated answer level 3 heading elements.", "name": "answer-heading-3" }, { "description": "The generated answer level 4 heading elements.", "name": "answer-heading-4" }, { "description": "The generated answer level 5 heading elements.", "name": "answer-heading-5" }, { "description": "The generated answer level 6 heading elements.", "name": "answer-heading-6" }, { "description": "The generated answer list item elements for both ordered and unordered lists.", "name": "answer-list-item" }, { "description": "The generated answer ordered list elements.", "name": "answer-ordered-list" }, { "description": "The generated answer paragraph elements.", "name": "answer-paragraph" }, { "description": "The generated answer quote block elements.", "name": "answer-quote-block" }, { "description": "The generated answer unordered list elements.", "name": "answer-unordered-list" }, { "description": "The generated answer strong text elements.", "name": "answer-strong" }, { "description": "The generated answer table elements.", "name": "answer-table" }, { "description": "The generated answer table container elements.", "name": "answer-table-container" }, { "description": "The generated answer table content cell elements.", "name": "answer-table-content" }, { "description": "The generated answer table header cell elements.", "name": "answer-table-header" }, { "description": "The link that allows the user to navigate to the item.", "name": "citation" }, { "description": "The pop-up that shows an item preview when the user hovers over the citation.", "name": "citation-popover" } ], "slots": [ { "description": "Lets you pass a custom sorry message when no answer is generated.", "name": "no-answer-message" } ], "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ maxCollapsedHeight: new NumberValue({ min: 9, max: 32, required: false, }), })" }, { "kind": "field", "name": "fieldsToIncludeInCitationsConverter", "privacy": "private", "static": true, "readonly": true }, { "kind": "field", "name": "DEFAULT_COLLAPSED_HEIGHT", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "16" }, { "kind": "field", "name": "MAX_COLLAPSED_HEIGHT", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "32" }, { "kind": "field", "name": "MIN_COLLAPSED_HEIGHT", "type": { "text": "number" }, "privacy": "private", "readonly": true, "default": "9" }, { "kind": "field", "name": "REQUIRED_FIELDS_TO_INCLUDE_IN_CITATIONS", "type": { "text": "array" }, "privacy": "private", "readonly": true, "default": "['filetype']" }, { "kind": "field", "name": "resizeObserver", "type": { "text": "ResizeObserver | undefined" }, "privacy": "private" }, { "kind": "field", "name": "fullAnswerHeight", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "controller", "type": { "text": "GeneratedAnswerController" }, "privacy": "private" }, { "kind": "field", "name": "withToggle", "type": { "text": "boolean" }, "default": "false", "description": "Whether to render a toggle button that lets the user hide or show the answer.", "attribute": "with-toggle" }, { "kind": "field", "name": "collapsible", "type": { "text": "boolean" }, "default": "false", "description": "Whether to allow the answer to be collapsed when the text is taller than the specified `--atomic-crga-collapsed-height` value (16rem by default).", "attribute": "collapsible" }, { "kind": "field", "name": "maxCollapsedHeight", "description": "The maximum height (in rem units) of the answer when collapsed.", "attribute": "max-collapsed-height" }, { "kind": "field", "name": "fieldsToIncludeInCitations", "type": { "text": "string" }, "description": "A list of fields to include with the citations used to generate the answer.\n\nSet this property as a stringified JSON array, for example:\n```html\n \n```", "attribute": "fields-to-include-in-citations" }, { "kind": "field", "name": "disableCitationAnchoring", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable citation anchoring.", "attribute": "disable-citation-anchoring" }, { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "generatedAnswerState", "type": { "text": "InsightGeneratedAnswerState" }, "privacy": "private" }, { "kind": "field", "name": "generatedAnswer", "type": { "text": "InsightGeneratedAnswer" }, "privacy": "private" }, { "kind": "field", "name": "searchStatusState", "type": { "text": "InsightSearchStatusState" }, "privacy": "private" }, { "kind": "field", "name": "searchStatus", "type": { "text": "InsightSearchStatus" }, "privacy": "private" }, { "kind": "field", "name": "copied", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "copyError", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "ariaMessage", "privacy": "private", "default": "new AriaLiveRegionController(this, 'generated-answer', false, true)" }, { "kind": "field", "name": "ariaErrorMessage", "privacy": "private", "default": "new AriaLiveRegionController(this, 'generated-answer-error', true)" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "onGeneratedAnswerStateUpdate", "privacy": "public" }, { "kind": "field", "name": "hasNoAnswerGenerated", "privacy": "private", "readonly": true }, { "kind": "field", "name": "isAnswerVisible", "privacy": "private", "readonly": true }, { "kind": "field", "name": "toggleTooltip", "privacy": "private", "readonly": true }, { "kind": "field", "name": "copyToClipboardTooltip", "privacy": "private", "readonly": true }, { "kind": "field", "name": "hasCustomNoAnswerMessage", "privacy": "private", "readonly": true }, { "kind": "method", "name": "copyToClipboard", "privacy": "private", "parameters": [ { "name": "answer", "type": { "text": "string" } } ] }, { "kind": "method", "name": "clickOnShowButton", "privacy": "private" }, { "kind": "method", "name": "getCitationFields", "privacy": "private" }, { "kind": "method", "name": "validateMaxCollapsedHeight", "privacy": "private", "return": { "type": { "text": "number" } } }, { "kind": "method", "name": "toggleClass", "privacy": "private", "parameters": [ { "name": "element", "type": { "text": "Element" } }, { "name": "className", "type": { "text": "string" } }, { "name": "condition", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "adaptAnswerHeight", "privacy": "private" }, { "kind": "method", "name": "getAnswerContainer", "privacy": "private" }, { "kind": "method", "name": "getAnswerFooter", "privacy": "private" }, { "kind": "method", "name": "setCSSVariable", "privacy": "private", "parameters": [ { "name": "variableName", "type": { "text": "string" } }, { "name": "value", "type": { "text": "string" } } ] }, { "kind": "method", "name": "updateAnswerHeight", "privacy": "private" }, { "kind": "method", "name": "clickDislike", "privacy": "private" }, { "kind": "method", "name": "clickLike", "privacy": "private" }, { "kind": "method", "name": "renderCitationsList", "privacy": "private" }, { "kind": "method", "name": "renderFeedbackAndCopyButtonsWrapper", "privacy": "private" }, { "kind": "method", "name": "renderContent", "privacy": "private" }, { "kind": "method", "name": "renderCardHeaderWrapper", "privacy": "private" } ], "attributes": [ { "name": "with-toggle", "type": { "text": "boolean" }, "default": "false", "description": "Whether to render a toggle button that lets the user hide or show the answer.", "fieldName": "withToggle" }, { "name": "collapsible", "type": { "text": "boolean" }, "default": "false", "description": "Whether to allow the answer to be collapsed when the text is taller than the specified `--atomic-crga-collapsed-height` value (16rem by default).", "fieldName": "collapsible" }, { "name": "max-collapsed-height", "description": "The maximum height (in rem units) of the answer when collapsed.", "fieldName": "maxCollapsedHeight" }, { "name": "fields-to-include-in-citations", "type": { "text": "string" }, "description": "A list of fields to include with the citations used to generate the answer.\n\nSet this property as a stringified JSON array, for example:\n```html\n \n```", "fieldName": "fieldsToIncludeInCitations" }, { "name": "disable-citation-anchoring", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable citation anchoring.", "fieldName": "disableCitationAnchoring" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-generated-answer", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightGeneratedAnswer", "declaration": { "name": "AtomicInsightGeneratedAnswer", "module": "src/components/insight/atomic-insight-generated-answer/atomic-insight-generated-answer.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-generated-answer", "declaration": { "name": "AtomicInsightGeneratedAnswer", "module": "src/components/insight/atomic-insight-generated-answer/atomic-insight-generated-answer.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-generated-answer/atomic-insight-generated-answer.tw.css.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-history-toggle/atomic-insight-history-toggle.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-interface/analytics-config.ts", "declarations": [ { "kind": "function", "name": "analyticsClientMiddleware", "parameters": [ { "name": "event", "type": { "text": "string" } }, { "name": "payload", "type": { "text": "AnalyticsPayload" } } ] } ], "exports": [] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-interface/atomic-insight-interface.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-interface` component is the parent to all other atomic insight components in an insight page.\nIt handles the headless insight engine and localization configurations.", "name": "AtomicInsightInterface", "slots": [ { "description": "The default slot where you can add child components to the interface.", "name": "default" }, { "description": "A slot for components that should be positioned absolutely in the top-right corner.", "name": "full-search" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "interfaceController", "privacy": "private", "default": "new InterfaceController( this, 'CoveoAtomic', HEADLESS_VERSION )" }, { "kind": "field", "name": "store", "type": { "text": "InsightStore" }, "privacy": "public" }, { "kind": "field", "name": "engine", "type": { "text": "InsightEngine" }, "privacy": "public", "description": "The service insight interface headless engine.", "attribute": "engine" }, { "kind": "field", "name": "analytics", "type": { "text": "boolean" }, "privacy": "public", "default": "true", "description": "Whether analytics should be enabled.", "attribute": "analytics", "reflects": true }, { "kind": "field", "name": "i18n", "type": { "text": "i18n" }, "privacy": "public", "description": "The service insight interface i18next instance.", "attribute": "i18n" }, { "kind": "field", "name": "logLevel", "type": { "text": "InsightLogLevel" }, "privacy": "public", "description": "The severity level of the messages to log in the console.", "attribute": "log-level", "reflects": true }, { "kind": "field", "name": "language", "type": { "text": "string" }, "privacy": "public", "default": "'en'", "description": "The service insight interface language.", "attribute": "language", "reflects": true }, { "kind": "field", "name": "languageAssetsPath", "type": { "text": "string" }, "privacy": "public", "default": "'./lang'", "description": "The language assets path. By default, this will be a relative URL pointing to `./lang`.\n\nExample: \"/mypublicpath/languages\"", "attribute": "language-assets-path", "reflects": true }, { "kind": "field", "name": "iconAssetsPath", "type": { "text": "string" }, "privacy": "public", "default": "'./assets'", "description": "The icon assets path. By default, this will be a relative URL pointing to `./assets`.\n\nExample: \"/mypublicpath/icons\"", "attribute": "icon-assets-path", "reflects": true }, { "kind": "field", "name": "fieldsToInclude", "type": { "text": "string[]" }, "privacy": "public", "default": "[]", "description": "A list of non-default fields to include in the query results.\n\nSpecify the property as an array using a JSON string representation:\n```html\n\n```", "attribute": "fields-to-include" }, { "kind": "field", "name": "resultsPerPage", "type": { "text": "number" }, "default": "5", "description": "The number of results per page. By default, this is set to `5`.", "attribute": "results-per-page", "reflects": true, "privacy": "private" }, { "kind": "field", "name": "i18Initialized", "type": { "text": "Promise" }, "privacy": "private", "default": "promise" }, { "kind": "method", "name": "initialize", "privacy": "public", "parameters": [ { "name": "options", "type": { "text": "InsightInitializationOptions" } } ], "description": "Initializes the connection with the headless insight engine using options for `accessToken` (required), `organizationId` (required), `environment` (defaults to `prod`), and `renewAccessToken`." }, { "kind": "method", "name": "initializeWithInsightEngine", "privacy": "public", "parameters": [ { "name": "engine", "type": { "text": "InsightEngine" } } ], "description": "Initializes the connection with an already preconfigured headless insight engine." }, { "kind": "method", "name": "executeFirstSearch", "privacy": "public", "description": "Executes the first search and logs the interface load event to analytics, after initializing connection to the headless search engine." }, { "kind": "method", "name": "toggleAnalytics", "privacy": "public" }, { "kind": "method", "name": "updateIconAssetsPath", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateLanguage", "privacy": "public" }, { "kind": "method", "name": "getBindings", "privacy": "private", "return": { "type": { "text": "InsightBindings" } } }, { "kind": "field", "name": "handleInitialization", "privacy": "private" }, { "kind": "method", "name": "initEngine", "privacy": "private", "parameters": [ { "name": "options", "type": { "text": "InsightInitializationOptions" } } ] }, { "kind": "method", "name": "initResultsPerPage", "privacy": "private" }, { "kind": "method", "name": "internalInitialization", "privacy": "private", "parameters": [ { "name": "initEngine", "type": { "text": "() => void" } } ] }, { "kind": "method", "name": "registerFieldsToInclude", "privacy": "public" }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "engine", "type": { "text": "InsightEngine" }, "description": "The service insight interface headless engine.", "fieldName": "engine" }, { "name": "analytics", "type": { "text": "boolean" }, "default": "true", "description": "Whether analytics should be enabled.", "fieldName": "analytics" }, { "name": "i18n", "type": { "text": "i18n" }, "description": "The service insight interface i18next instance.", "fieldName": "i18n" }, { "name": "log-level", "type": { "text": "InsightLogLevel" }, "description": "The severity level of the messages to log in the console.", "fieldName": "logLevel" }, { "name": "language", "type": { "text": "string" }, "default": "'en'", "description": "The service insight interface language.", "fieldName": "language" }, { "name": "language-assets-path", "type": { "text": "string" }, "default": "'./lang'", "description": "The language assets path. By default, this will be a relative URL pointing to `./lang`.\n\nExample: \"/mypublicpath/languages\"", "fieldName": "languageAssetsPath" }, { "name": "icon-assets-path", "type": { "text": "string" }, "default": "'./assets'", "description": "The icon assets path. By default, this will be a relative URL pointing to `./assets`.\n\nExample: \"/mypublicpath/icons\"", "fieldName": "iconAssetsPath" }, { "name": "fields-to-include", "type": { "text": "string[]" }, "default": "[]", "description": "A list of non-default fields to include in the query results.\n\nSpecify the property as an array using a JSON string representation:\n```html\n\n```", "fieldName": "fieldsToInclude" } ], "mixins": [ { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-interface", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightInterface", "declaration": { "name": "AtomicInsightInterface", "module": "src/components/insight/atomic-insight-interface/atomic-insight-interface.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-interface", "declaration": { "name": "AtomicInsightInterface", "module": "src/components/insight/atomic-insight-interface/atomic-insight-interface.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-interface/store.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-layout/atomic-insight-layout.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-layout` helps organize elements in the insight page.", "name": "AtomicInsightLayout", "members": [ { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "widget", "type": { "text": "boolean" }, "default": "false", "description": "Whether the interface should be shown in widget format.", "attribute": "widget", "reflects": true }, { "kind": "field", "name": "mobileBreakpoint", "type": { "text": "string" }, "default": "DEFAULT_MOBILE_BREAKPOINT", "description": "The viewport width at which the layout goes from desktop to mobile.\nFor example: 800px, 65rem.", "attribute": "mobile-breakpoint", "reflects": true }, { "kind": "field", "name": "layoutStylesController", "privacy": "private", "default": "new LayoutStylesController( this, buildInsightLayout, 'atomic-insight-layout-' )" }, { "kind": "method", "name": "onMobileBreakpointChange", "privacy": "public" }, { "kind": "method", "name": "onWidgetChange", "privacy": "public" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "widget", "type": { "text": "boolean" }, "default": "false", "description": "Whether the interface should be shown in widget format.", "fieldName": "widget" }, { "name": "mobile-breakpoint", "type": { "text": "string" }, "default": "DEFAULT_MOBILE_BREAKPOINT", "description": "The viewport width at which the layout goes from desktop to mobile.\nFor example: 800px, 65rem.", "fieldName": "mobileBreakpoint" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" }, { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-layout", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightLayout", "declaration": { "name": "AtomicInsightLayout", "module": "src/components/insight/atomic-insight-layout/atomic-insight-layout.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-layout", "declaration": { "name": "AtomicInsightLayout", "module": "src/components/insight/atomic-insight-layout/atomic-insight-layout.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-layout/insight-layout.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-no-results/atomic-insight-no-results.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-no-results` component displays search tips when there are no results. Any additional content slotted inside of its element will be displayed as well.", "name": "AtomicInsightNoResults", "cssParts": [ { "description": "The text indicating that no results were found for the search.", "name": "no-results" }, { "description": "The search tips to help the user correct the query.", "name": "search-tips" }, { "description": "The highlighted query.", "name": "highlight" }, { "description": "The magnifying glass icon.", "name": "icon" } ], "slots": [ { "description": "Any additional content slotted inside of its element will be displayed as well.", "name": "default" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "searchStatus", "type": { "text": "SearchStatus" }, "privacy": "private" }, { "kind": "field", "name": "querySummary", "type": { "text": "QuerySummary" }, "privacy": "private" }, { "kind": "field", "name": "searchStatusState", "type": { "text": "SearchStatusState" }, "privacy": "private" }, { "kind": "field", "name": "querySummaryState", "type": { "text": "QuerySummaryState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "ariaMessage", "privacy": "protected", "default": "new AriaLiveRegionController(this, 'no-results')" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "renderNoItems", "privacy": "private" }, { "kind": "method", "name": "renderSearchTips", "privacy": "private" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-no-results", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightNoResults", "declaration": { "name": "AtomicInsightNoResults", "module": "src/components/insight/atomic-insight-no-results/atomic-insight-no-results.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-no-results", "declaration": { "name": "AtomicInsightNoResults", "module": "src/components/insight/atomic-insight-no-results/atomic-insight-no-results.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-numeric-facet/atomic-insight-numeric-facet.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-numeric-facet` component displays a facet of the results for the current query as numeric ranges.\nA facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria.", "name": "AtomicInsightNumericFacet", "cssParts": [ { "description": "The wrapper for the entire facet.", "name": "facet" }, { "description": "The placeholder shown before the first search is executed.", "name": "placeholder" }, { "description": "The button that displays the label and allows to expand/collapse the facet.", "name": "label-button" }, { "description": "The label button icon.", "name": "label-button-icon" }, { "description": "The button that resets the actively selected facet values.", "name": "clear-button" }, { "description": "The clear button icon.", "name": "clear-button-icon" }, { "description": "The facet values container.", "name": "values" }, { "description": "The facet value label, common for all displays.", "name": "value-label" }, { "description": "The facet value count, common for all displays.", "name": "value-count" }, { "description": "The facet value checkbox, available when display is 'checkbox'.", "name": "value-checkbox" }, { "description": "The checked facet value checkbox, available when display is 'checkbox'.", "name": "value-checkbox-checked" }, { "description": "The facet value checkbox clickable label, available when display is 'checkbox'.", "name": "value-checkbox-label" }, { "description": "The facet value checkbox icon, available when display is 'checkbox'.", "name": "value-checkbox-icon" }, { "description": "The facet value when display is 'link'.", "name": "value-link" }, { "description": "The selected facet value when display is 'link'.", "name": "value-link-selected" }, { "description": "The form that comprises the labels, inputs, and 'apply' button for the custom numeric range.", "name": "input-form" }, { "description": "The label for the starting value of the custom numeric range.", "name": "label-start" }, { "description": "The label for the ending value of the custom numeric range.", "name": "label-end" }, { "description": "The input for the starting value of the custom numeric range.", "name": "input-start" }, { "description": "The input for the ending value of the custom numeric range.", "name": "input-end" }, { "description": "The apply button for the custom range.", "name": "input-apply-button" } ], "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ displayValuesAs: new StringValue({constrainTo: ['checkbox', 'link']}), withInput: new StringValue({constrainTo: ['integer', 'decimal']}), })" }, { "kind": "field", "name": "facetId", "type": { "text": "string" }, "description": "Specifies a unique identifier for the facet.", "attribute": "facet-id", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "'no-label'", "description": "The non-localized label for the facet.\nUsed in the `atomic-breadbox` component through the bindings store.", "attribute": "label", "reflects": true }, { "kind": "field", "name": "field", "type": { "text": "string" }, "description": "The field whose values you want to display in the facet.", "attribute": "field", "reflects": true }, { "kind": "field", "name": "numberOfValues", "type": { "text": "number" }, "default": "8", "description": "The number of values to request for this facet, when there are no manual ranges.\nIf the number of values is 0, no ranges will be displayed.", "attribute": "number-of-values", "reflects": true }, { "kind": "field", "name": "withInput", "type": { "text": "NumberInputType" }, "description": "Whether this facet should contain an input allowing users to set custom ranges.\nDepending on the field, the input can allow either decimal or integer values.", "attribute": "with-input", "reflects": true }, { "kind": "field", "name": "sortCriteria", "type": { "text": "RangeFacetSortCriterion" }, "default": "'ascending'", "description": "The sort criterion to apply to the returned facet values.\nPossible values are 'ascending' and 'descending'.", "attribute": "sort-criteria", "reflects": true }, { "kind": "field", "name": "rangeAlgorithm", "type": { "text": "RangeFacetRangeAlgorithm" }, "default": "'equiprobable'", "description": "The algorithm that's used for generating the ranges of this facet when they aren't manually defined.\nThe default value of `\"equiprobable\"` generates facet ranges which vary in size but have a more balanced number of results within each range.\nThe value of `\"even\"` generates equally sized facet ranges across all of the results.", "attribute": "range-algorithm", "reflects": true }, { "kind": "field", "name": "displayValuesAs", "type": { "text": "'checkbox' | 'link'" }, "default": "'checkbox'", "description": "Whether to display the facet values as checkboxes (multiple selection) or links (single selection).\nPossible values are 'checkbox' and 'link'.", "attribute": "display-values-as", "reflects": true }, { "kind": "field", "name": "isCollapsed", "type": { "text": "boolean" }, "default": "false", "description": "Specifies whether the facet is collapsed.", "attribute": "is-collapsed", "reflects": true }, { "kind": "field", "name": "headingLevel", "type": { "text": "number" }, "default": "0", "description": "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.", "attribute": "heading-level", "reflects": true }, { "kind": "field", "name": "filterFacetCount", "type": { "text": "boolean" }, "default": "true", "description": "Whether to exclude the parents of folded results when estimating the result count for each facet value.\n\nNote: Resulting count is only an estimation, in some cases this value could be incorrect.", "attribute": "filter-facet-count", "reflects": true }, { "kind": "field", "name": "injectionDepth", "type": { "text": "number" }, "default": "1000", "description": "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`", "attribute": "injection-depth", "reflects": true }, { "kind": "field", "name": "dependsOn", "type": { "text": "Record" }, "description": "The required facets and values for this facet to be displayed.\nExamples:\n```html\n\n\n\n\n\n\n\n```" }, { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "facetState", "type": { "text": "NumericFacetState | undefined" }, "privacy": "private" }, { "kind": "field", "name": "filterState", "type": { "text": "NumericFilterState | undefined" }, "privacy": "public" }, { "kind": "field", "name": "searchStatusState", "type": { "text": "SearchStatusState" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "facetForInputState", "type": { "text": "NumericFacetState | undefined" }, "privacy": "public" }, { "kind": "field", "name": "facetForRange", "type": { "text": "NumericFacet | undefined" }, "privacy": "public" }, { "kind": "field", "name": "facetForInput", "type": { "text": "NumericFacet | undefined" }, "privacy": "public" }, { "kind": "field", "name": "filter", "type": { "text": "NumericFilter | undefined" }, "privacy": "public" }, { "kind": "field", "name": "searchStatus", "type": { "text": "SearchStatus" }, "privacy": "private" }, { "kind": "field", "name": "manualRanges", "type": { "text": "(NumericRangeRequest & {label?: string})[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "formatter", "type": { "text": "NumberFormatter" }, "privacy": "private", "default": "defaultNumberFormatter" }, { "kind": "field", "name": "dependenciesManager", "type": { "text": "FacetConditionsManager | undefined" }, "privacy": "private" }, { "kind": "field", "name": "filterDependenciesManager", "type": { "text": "FacetConditionsManager | undefined" }, "privacy": "private" }, { "kind": "field", "name": "headerFocus", "type": { "text": "FocusTargetController | undefined" }, "privacy": "private" }, { "kind": "field", "name": "removeNumberFormatListener", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "removeNumberInputApplyListener", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "unsubscribeFacetForRange", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "unsubscribeFacetForInput", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "unsubscribeFilter", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "field", "name": "facetInfo", "type": { "text": "FacetInfo" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "focusTarget", "type": { "text": "FocusTargetController" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "numberOfSelectedValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderValues", "privacy": "private", "readonly": true }, { "kind": "field", "name": "hasInputRange", "privacy": "private", "readonly": true }, { "kind": "field", "name": "valuesToRender", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderInput", "privacy": "private", "readonly": true }, { "kind": "field", "name": "shouldRenderFacet", "privacy": "private", "readonly": true }, { "kind": "field", "name": "enabled", "privacy": "private", "readonly": true }, { "kind": "field", "name": "isHidden", "privacy": "private", "readonly": true }, { "kind": "field", "name": "hasValues", "privacy": "private", "readonly": true }, { "kind": "method", "name": "initializeSearchStatus", "privacy": "private" }, { "kind": "method", "name": "initializeFacetForInput", "privacy": "private" }, { "kind": "method", "name": "initializeFacetForRange", "privacy": "private" }, { "kind": "method", "name": "initializeFilter", "privacy": "private" }, { "kind": "method", "name": "initializeDependenciesManager", "privacy": "private", "parameters": [ { "name": "facetId", "type": { "text": "string" } } ] }, { "kind": "method", "name": "registerFacetToStore", "privacy": "private" }, { "kind": "method", "name": "registerNumberFormatListener", "privacy": "private" }, { "kind": "method", "name": "registerNumberInputApplyListener", "privacy": "private" }, { "kind": "method", "name": "computeFacetId", "privacy": "private" }, { "kind": "method", "name": "handleClearFilters", "privacy": "private" }, { "kind": "method", "name": "handleToggleCollapse", "privacy": "private" }, { "kind": "method", "name": "handleValueClick", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "NumericFacetState['values'][number]" } } ] }, { "kind": "method", "name": "renderValues", "privacy": "private" }, { "kind": "method", "name": "renderInput", "privacy": "private" } ], "attributes": [ { "name": "facet-id", "type": { "text": "string" }, "description": "Specifies a unique identifier for the facet.", "fieldName": "facetId" }, { "name": "label", "type": { "text": "string" }, "default": "'no-label'", "description": "The non-localized label for the facet.\nUsed in the `atomic-breadbox` component through the bindings store.", "fieldName": "label" }, { "name": "field", "type": { "text": "string" }, "description": "The field whose values you want to display in the facet.", "fieldName": "field" }, { "name": "number-of-values", "type": { "text": "number" }, "default": "8", "description": "The number of values to request for this facet, when there are no manual ranges.\nIf the number of values is 0, no ranges will be displayed.", "fieldName": "numberOfValues" }, { "name": "with-input", "type": { "text": "NumberInputType" }, "description": "Whether this facet should contain an input allowing users to set custom ranges.\nDepending on the field, the input can allow either decimal or integer values.", "fieldName": "withInput" }, { "name": "sort-criteria", "type": { "text": "RangeFacetSortCriterion" }, "default": "'ascending'", "description": "The sort criterion to apply to the returned facet values.\nPossible values are 'ascending' and 'descending'.", "fieldName": "sortCriteria" }, { "name": "range-algorithm", "type": { "text": "RangeFacetRangeAlgorithm" }, "default": "'equiprobable'", "description": "The algorithm that's used for generating the ranges of this facet when they aren't manually defined.\nThe default value of `\"equiprobable\"` generates facet ranges which vary in size but have a more balanced number of results within each range.\nThe value of `\"even\"` generates equally sized facet ranges across all of the results.", "fieldName": "rangeAlgorithm" }, { "name": "display-values-as", "type": { "text": "'checkbox' | 'link'" }, "default": "'checkbox'", "description": "Whether to display the facet values as checkboxes (multiple selection) or links (single selection).\nPossible values are 'checkbox' and 'link'.", "fieldName": "displayValuesAs" }, { "name": "is-collapsed", "type": { "text": "boolean" }, "default": "false", "description": "Specifies whether the facet is collapsed.", "fieldName": "isCollapsed" }, { "name": "heading-level", "type": { "text": "number" }, "default": "0", "description": "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.", "fieldName": "headingLevel" }, { "name": "filter-facet-count", "type": { "text": "boolean" }, "default": "true", "description": "Whether to exclude the parents of folded results when estimating the result count for each facet value.\n\nNote: Resulting count is only an estimation, in some cases this value could be incorrect.", "fieldName": "filterFacetCount" }, { "name": "injection-depth", "type": { "text": "number" }, "default": "1000", "description": "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`", "fieldName": "injectionDepth" }, { "name": "depends-on", "fieldName": "dependsOn" } ], "cssStates": [ { "description": "Applied when the facet is hidden.", "name": "hidden" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-numeric-facet", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightNumericFacet", "declaration": { "name": "AtomicInsightNumericFacet", "module": "src/components/insight/atomic-insight-numeric-facet/atomic-insight-numeric-facet.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-numeric-facet", "declaration": { "name": "AtomicInsightNumericFacet", "module": "src/components/insight/atomic-insight-numeric-facet/atomic-insight-numeric-facet.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-pager/atomic-insight-pager.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-pager` provides buttons that allow the end user to navigate through the different result pages.", "name": "AtomicInsightPager", "cssParts": [ { "description": "The list of the next/previous buttons and page-buttons.", "name": "buttons" }, { "description": "The list of page buttons.", "name": "page-buttons" }, { "description": "The individual page buttons.", "name": "page-button" }, { "description": "The active page button.", "name": "active-page-button" }, { "description": "The previous page button.", "name": "previous-button" }, { "description": "The next page button.", "name": "next-button" }, { "description": "The icon displayed on the \"previous page\" button.", "name": "previous-button-icon" }, { "description": "The icon displayed on the \"next page\" button.", "name": "next-button-icon" } ], "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ numberOfPages: new NumberValue({min: 0}), })" }, { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "pager", "type": { "text": "InsightPager" }, "privacy": "private" }, { "kind": "field", "name": "searchStatus", "type": { "text": "InsightSearchStatus" }, "privacy": "private" }, { "kind": "field", "name": "pagerState", "type": { "text": "InsightPagerState" }, "privacy": "private" }, { "kind": "field", "name": "searchStatusState", "type": { "text": "InsightSearchStatusState" }, "privacy": "private" }, { "kind": "field", "name": "numberOfPages", "type": { "text": "number" }, "default": "5", "description": "The maximum number of page buttons to display in the pager.", "attribute": "number-of-pages", "reflects": true }, { "kind": "field", "name": "ariaMessage", "privacy": "protected", "default": "new AriaLiveRegionController(this, 'atomic-insight-pager')" }, { "kind": "field", "name": "previousButton", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "field", "name": "nextButton", "type": { "text": "FocusTargetController" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "initFocusTargets", "privacy": "private" }, { "kind": "method", "name": "focusOnFirstResultAndScrollToTop", "privacy": "private" }, { "kind": "method", "name": "announcePageLoaded", "privacy": "private" } ], "events": [ { "description": "Emitted when the user clicks any of the buttons rendered by the component.", "name": "atomic/scrollToTop" } ], "attributes": [ { "name": "number-of-pages", "type": { "text": "number" }, "default": "5", "description": "The maximum number of page buttons to display in the pager.", "fieldName": "numberOfPages" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-insight-pager", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightPager", "declaration": { "name": "AtomicInsightPager", "module": "src/components/insight/atomic-insight-pager/atomic-insight-pager.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-pager", "declaration": { "name": "AtomicInsightPager", "module": "src/components/insight/atomic-insight-pager/atomic-insight-pager.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-query-error/atomic-insight-query-error.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-query-error` component handles fatal errors when performing a query on the index or Search API. When the error is known, it displays a link to relevant documentation link for debugging purposes. When the error is unknown, it displays a small text area with the JSON content of the error.", "name": "AtomicInsightQueryError", "cssParts": [ { "description": "The svg related to the error.", "name": "icon" }, { "description": "The title of the error.", "name": "title" }, { "description": "A description of the error.", "name": "description" }, { "description": "A link to the relevant documentation.", "name": "doc-link" }, { "description": "A button to request additional error information.", "name": "more-info-btn" }, { "description": "Additional error information.", "name": "error-info" } ], "members": [ { "kind": "field", "name": "queryErrorState", "type": { "text": "QueryErrorState" }, "privacy": "private" }, { "kind": "field", "name": "ariaMessage", "privacy": "protected", "default": "new AriaLiveRegionController(this, 'query-error')" }, { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "queryError", "type": { "text": "QueryError" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "showMoreInfo", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "method", "name": "initialize", "privacy": "public" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-query-error", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightQueryError", "declaration": { "name": "AtomicInsightQueryError", "module": "src/components/insight/atomic-insight-query-error/atomic-insight-query-error.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-query-error", "declaration": { "name": "AtomicInsightQueryError", "module": "src/components/insight/atomic-insight-query-error/atomic-insight-query-error.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-refine-modal/atomic-insight-refine-modal.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-refine-modal` component displays a modal with filters for refining search results.\n\nThis component should not be used directly. It is internally used by the `atomic-insight-refine-toggle` component to display the refine modal.", "name": "AtomicInsightRefineModal", "cssParts": [ { "description": "The title of the modal.", "name": "title" }, { "description": "The button in the header that closes the modal.", "name": "close-button" }, { "description": "The icon of the close button.", "name": "close-icon" }, { "description": "The wrapper around the content inside the body of the modal.", "name": "content" }, { "description": "The title for each section.", "name": "section-title" }, { "description": "The title for the filters section.", "name": "section-filters-title" }, { "description": "The section containing facets and the \"filters\" title.", "name": "filter-section" }, { "description": "The button that resets all actively selected facet values.", "name": "filter-clear-all" }, { "description": "The wrapper around the content inside the footer of the modal, containing the button to view results.", "name": "footer-content" }, { "description": "The button in the footer that closes the modal.", "name": "footer-button" }, { "description": "The text inside the button in the footer that closes the modal.", "name": "footer-button-text" }, { "description": "The count inside the button in the footer that closes the modal.", "name": "footer-button-count" }, { "description": "The wrapper with a shadow or background color around the footer.", "name": "footer-wrapper" }, { "description": "The footer of the modal.", "name": "footer" }, { "description": "The horizontal ruler underneath the header.", "name": "header-ruler" }, { "description": "The wrapper around the body.", "name": "body-wrapper" }, { "description": "The body of the modal, between the header and the footer.", "name": "body" }, { "description": "The wrapper around the header.", "name": "header-wrapper" }, { "description": "The header of the modal, containing the title.", "name": "header" }, { "description": "The modal's outermost container.", "name": "container" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "querySummaryState", "type": { "text": "InsightQuerySummaryState" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbManagerState", "type": { "text": "InsightBreadcrumbManagerState" }, "privacy": "private" }, { "kind": "field", "name": "interfaceDimensions", "type": { "text": "DOMRect | undefined" }, "privacy": "public" }, { "kind": "field", "name": "openButton", "type": { "text": "HTMLElement" }, "description": "The element that opens the modal when clicked.", "attribute": "open-button" }, { "kind": "field", "name": "isOpen", "type": { "text": "boolean" }, "default": "false", "description": "Whether the modal is open.", "attribute": "is-open", "reflects": true }, { "kind": "field", "name": "querySummary", "type": { "text": "InsightQuerySummary" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbManager", "type": { "text": "InsightBreadcrumbManager" }, "privacy": "private" }, { "kind": "field", "name": "backdropStyleSheet", "privacy": "private", "default": "new CSSStyleSheet()" }, { "kind": "field", "name": "animationFrameId", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "watchEnabled" }, { "kind": "method", "name": "onAnimationFrame", "privacy": "private" }, { "kind": "method", "name": "dimensionChanged", "privacy": "private" }, { "kind": "method", "name": "updateDimensions", "privacy": "public" }, { "kind": "method", "name": "updateBackdropStyles", "privacy": "private" }, { "kind": "method", "name": "renderHeader", "privacy": "private" }, { "kind": "method", "name": "renderBody", "privacy": "private" } ], "attributes": [ { "name": "open-button", "type": { "text": "HTMLElement" }, "description": "The element that opens the modal when clicked.", "fieldName": "openButton" }, { "name": "is-open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the modal is open.", "fieldName": "isOpen" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-refine-modal", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightRefineModal", "declaration": { "name": "AtomicInsightRefineModal", "module": "src/components/insight/atomic-insight-refine-modal/atomic-insight-refine-modal.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-refine-modal", "declaration": { "name": "AtomicInsightRefineModal", "module": "src/components/insight/atomic-insight-refine-modal/atomic-insight-refine-modal.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-query-summary/atomic-insight-query-summary.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-query-summary` component displays information about the current range of results.\nThis component is used within the Insight Panel interface.", "name": "AtomicInsightQuerySummary", "cssParts": [ { "description": "The container for the whole summary.", "name": "container" }, { "description": "The summary highlights.", "name": "highlight" }, { "description": "The summary highlighted query.", "name": "query" }, { "description": "The query summary placeholder used while the search interface is initializing.", "name": "placeholder" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "querySummaryState", "type": { "text": "QuerySummaryState" }, "privacy": "private" }, { "kind": "field", "name": "querySummary", "type": { "text": "QuerySummary" }, "privacy": "private" }, { "kind": "field", "name": "ariaMessage", "privacy": "protected", "default": "new AriaLiveRegionController(this, 'query-summary')" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "initBindings", "privacy": "private", "inheritedFrom": { "name": "InitializeBindingsMixin", "module": "src/mixins/bindings-mixin.ts" } } ], "mixins": [ { "name": "InitializeBindingsMixin", "package": "@/src/mixins/bindings-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-query-summary", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightQuerySummary", "declaration": { "name": "AtomicInsightQuerySummary", "module": "src/components/insight/atomic-insight-query-summary/atomic-insight-query-summary.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-query-summary", "declaration": { "name": "AtomicInsightQuerySummary", "module": "src/components/insight/atomic-insight-query-summary/atomic-insight-query-summary.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-refine-toggle/atomic-insight-refine-toggle.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-refine-toggle` component displays a button that opens a modal containing the facets and the sort components.\n\nWhen this component is added to the `atomic-insight-interface`, an `atomic-insight-refine-modal` component is automatically created.", "name": "AtomicInsightRefineToggle", "cssParts": [ { "description": "The container for the refine toggle button.", "name": "insight-refine-toggle-container" }, { "description": "The refine toggle button.", "name": "insight-refine-toggle-button" }, { "description": "The filter icon.", "name": "insight-refine-toggle-icon" }, { "description": "The badge showing the number of active filters.", "name": "insight-refine-toggle-badge" }, { "description": "The placeholder shown while the first request is being executed.", "name": "placeholder" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "searchStatus", "type": { "text": "SearchStatus" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbManager", "type": { "text": "BreadcrumbManager" }, "privacy": "private" }, { "kind": "field", "name": "searchStatusState", "type": { "text": "SearchStatusState" }, "privacy": "private" }, { "kind": "field", "name": "breadcrumbManagerState", "type": { "text": "BreadcrumbManagerState" }, "privacy": "private" }, { "kind": "field", "name": "modalRef", "type": { "text": "AtomicInsightRefineModal | undefined" }, "privacy": "private" }, { "kind": "field", "name": "buttonRef", "type": { "text": "HTMLButtonElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "numberOfBreadcrumbs", "type": { "text": "number" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "loadModal", "privacy": "private" }, { "kind": "method", "name": "enableModal", "privacy": "private" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-refine-toggle", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightRefineToggle", "declaration": { "name": "AtomicInsightRefineToggle", "module": "src/components/insight/atomic-insight-refine-toggle/atomic-insight-refine-toggle.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-refine-toggle", "declaration": { "name": "AtomicInsightRefineToggle", "module": "src/components/insight/atomic-insight-refine-toggle/atomic-insight-refine-toggle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-result/atomic-insight-result.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-result` component is used internally by the `atomic-insight-result-list` component.", "name": "AtomicInsightResult", "members": [ { "kind": "field", "name": "propsSchema", "privacy": "private", "static": true, "readonly": true, "default": "new Schema({ density: new StringValue({ constrainTo: ['normal', 'comfortable', 'compact'], }), imageSize: new StringValue({ constrainTo: ['small', 'large', 'icon', 'none'], }), })" }, { "kind": "field", "name": "resultRootRef", "type": { "text": "Ref" }, "privacy": "private" }, { "kind": "field", "name": "itemLayoutController", "type": { "text": "ItemLayoutController" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "stopPropagation", "type": { "text": "boolean" }, "description": "Whether `atomic-result-link` components nested in the `atomic-insight-result` should stop click event propagation.", "attribute": "stop-propagation", "reflects": true }, { "kind": "field", "name": "result", "type": { "text": "InsightResult | InsightFoldedResult" }, "description": "The result item.", "attribute": "result" }, { "kind": "field", "name": "content", "type": { "text": "ParentNode" }, "description": "The result content to display.", "attribute": "content" }, { "kind": "field", "name": "density", "type": { "text": "ItemDisplayDensity" }, "default": "'normal'", "description": "How large or small results should be.", "attribute": "density", "reflects": true }, { "kind": "field", "name": "imageSize", "type": { "text": "ItemDisplayImageSize" }, "default": "'icon'", "description": "The size of the image section in result list items.\nThis is overwritten by the image size defined in the result content, if it exists.", "attribute": "image-size", "reflects": true }, { "kind": "field", "name": "classes", "type": { "text": "string" }, "default": "''", "description": "The classes to add to the result element.", "attribute": "classes" }, { "kind": "field", "name": "resolveResult", "privacy": "public" }, { "kind": "field", "name": "resolveInteractiveResult", "privacy": "public" }, { "kind": "field", "name": "resolveStopPropagation", "privacy": "public" }, { "kind": "field", "name": "resolveResultDisplayConfig", "privacy": "public" }, { "kind": "method", "name": "getContentHTML", "privacy": "private" }, { "kind": "method", "name": "getUpdateComplete", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "ChildrenUpdateCompleteMixin", "module": "src/mixins/children-update-complete-mixin.ts" } } ], "attributes": [ { "name": "stop-propagation", "type": { "text": "boolean" }, "description": "Whether `atomic-result-link` components nested in the `atomic-insight-result` should stop click event propagation.", "fieldName": "stopPropagation" }, { "name": "result", "type": { "text": "InsightResult | InsightFoldedResult" }, "description": "The result item.", "fieldName": "result" }, { "name": "content", "type": { "text": "ParentNode" }, "description": "The result content to display.", "fieldName": "content" }, { "name": "density", "type": { "text": "ItemDisplayDensity" }, "default": "'normal'", "description": "How large or small results should be.", "fieldName": "density" }, { "name": "image-size", "type": { "text": "ItemDisplayImageSize" }, "default": "'icon'", "description": "The size of the image section in result list items.\nThis is overwritten by the image size defined in the result content, if it exists.", "fieldName": "imageSize" }, { "name": "classes", "type": { "text": "string" }, "default": "''", "description": "The classes to add to the result element.", "fieldName": "classes" } ], "mixins": [ { "name": "ChildrenUpdateCompleteMixin", "package": "@/src/mixins/children-update-complete-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-result", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightResult", "declaration": { "name": "AtomicInsightResult", "module": "src/components/insight/atomic-insight-result/atomic-insight-result.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-result", "declaration": { "name": "AtomicInsightResult", "module": "src/components/insight/atomic-insight-result/atomic-insight-result.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-result-action/atomic-insight-result-action.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-result-action` component renders an interactive action button for insight results.", "name": "AtomicInsightResultAction", "cssParts": [ { "description": "The result action container", "name": "result-action-container" }, { "description": "The result action button", "name": "result-action-button" }, { "description": "The result action icon", "name": "result-action-icon" } ], "members": [ { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The result action icon to display.", "attribute": "icon" }, { "kind": "field", "name": "tooltip", "type": { "text": "string" }, "default": "''", "description": "The text tooltip to show on the result action icon.", "attribute": "tooltip" }, { "kind": "field", "name": "tooltipOnClick", "type": { "text": "string" }, "default": "''", "description": "The text tooltip to show on the result action icon for some time after clicking the button.", "attribute": "tooltip-on-click" }, { "kind": "field", "name": "action", "type": { "text": "Actions | string" }, "default": "''", "description": "The type of action to perform when the result action is clicked.\nThis will be sent along the event fired when the button is clicked.", "attribute": "action" }, { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "currentTooltip", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "itemContextController", "type": { "text": "ItemContextController" }, "privacy": "private", "default": "new ItemContextController(this, { parentName: 'atomic-insight-result', folded: false, })" }, { "kind": "field", "name": "actions", "type": { "text": "InsightAnalyticsActionCreators" }, "privacy": "private" }, { "kind": "field", "name": "tooltipResetTimeout", "type": { "text": "ReturnType | undefined" }, "privacy": "private" }, { "kind": "field", "name": "result", "type": { "text": "Result | null" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "onClick", "privacy": "private" }, { "kind": "method", "name": "getIcon", "privacy": "private" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "events": [ { "name": "atomicInsightResultActionClicked", "type": { "text": "CustomEvent" }, "description": "Fired when the action button is clicked. The event detail contains the action type and the result object." } ], "attributes": [ { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The result action icon to display.", "fieldName": "icon" }, { "name": "tooltip", "type": { "text": "string" }, "default": "''", "description": "The text tooltip to show on the result action icon.", "fieldName": "tooltip" }, { "name": "tooltip-on-click", "type": { "text": "string" }, "default": "''", "description": "The text tooltip to show on the result action icon for some time after clicking the button.", "fieldName": "tooltipOnClick" }, { "name": "action", "type": { "text": "Actions | string" }, "default": "''", "description": "The type of action to perform when the result action is clicked.\nThis will be sent along the event fired when the button is clicked.", "fieldName": "action" } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-insight-result-action", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightResultAction", "declaration": { "name": "AtomicInsightResultAction", "module": "src/components/insight/atomic-insight-result-action/atomic-insight-result-action.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-result-action", "declaration": { "name": "AtomicInsightResultAction", "module": "src/components/insight/atomic-insight-result-action/atomic-insight-result-action.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-result-action-bar/atomic-insight-result-action-bar.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-result-action-bar` component displays an action bar for an Insight result and hosts action buttons such as share, open, or more options related to the result.", "name": "AtomicInsightResultActionBar", "slots": [ { "description": "Action buttons to display in the action bar.", "name": "(default)" } ], "mixins": [ { "name": "ItemSectionMixin", "package": "@/src/mixins/item-section-mixin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-insight-result-action-bar", "customElement": true, "members": [ { "kind": "field", "name": "styles", "static": true, "default": "styles", "inheritedFrom": { "name": "ItemSectionMixin", "module": "src/mixins/item-section-mixin.ts" } }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ] } ], "exports": [ { "kind": "js", "name": "AtomicInsightResultActionBar", "declaration": { "name": "AtomicInsightResultActionBar", "module": "src/components/insight/atomic-insight-result-action-bar/atomic-insight-result-action-bar.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-result-action-bar", "declaration": { "name": "AtomicInsightResultActionBar", "module": "src/components/insight/atomic-insight-result-action-bar/atomic-insight-result-action-bar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-result-attach-to-case-action/atomic-insight-result-attach-to-case-action.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-result-attach-to-case-action` component can be nested\ninside a `atomic-insight-result-actions` to render an interactive button\nthat will emit an `atomic/insight/attachToCase/attach` or\n`atomic/insight/attachToCase/detach` JavaScript event, based on its current\nstate, when clicked.", "name": "AtomicInsightResultAttachToCaseAction", "cssParts": [ { "description": "The result action container", "name": "result-action-container" }, { "description": "The result action button", "name": "result-action-button" }, { "description": "The result action icon", "name": "result-action-icon" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "attachedResults", "type": { "text": "AttachedResults" }, "privacy": "private" }, { "kind": "field", "name": "attachedResultsState", "type": { "text": "Record" }, "privacy": "private" }, { "kind": "field", "name": "itemContextController", "type": { "text": "ItemContextController" }, "privacy": "private", "default": "new ItemContextController(this, { parentName: 'atomic-insight-result', folded: false, })" }, { "kind": "field", "name": "result", "type": { "text": "Result | null" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "method", "name": "onClick", "privacy": "private" }, { "kind": "method", "name": "getIcon", "privacy": "private" }, { "kind": "method", "name": "getTooltip", "privacy": "private" }, { "kind": "method", "name": "injectStyles", "parameters": [ { "name": "dynamicStyles", "optional": true, "type": { "text": "CSSResultGroup" }, "description": "Optional dynamic styles to inject along with static styles" } ], "description": "Injects styles into the document or shadow root.\n\nWhen called without arguments, injects the component's static styles.\nWhen called with dynamic styles, injects both static and dynamic styles.", "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } }, { "kind": "method", "name": "getStyleSheet", "privacy": "private", "return": { "type": { "text": "CSSStyleSheet | null" } }, "parameters": [ { "name": "style", "type": { "text": "CSSResultOrNative | CSSResultArray | null | undefined" } } ], "inheritedFrom": { "name": "LightDomMixin", "module": "src/mixins/light-dom.ts" } } ], "events": [ { "name": "atomic/insight/attachToCase/detach", "type": { "text": "CustomEvent" } }, { "name": "atomic/insight/attachToCase/attach", "type": { "text": "CustomEvent" } } ], "mixins": [ { "name": "LightDomMixin", "package": "@/src/mixins/light-dom" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "atomic-insight-result-attach-to-case-action", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightResultAttachToCaseAction", "declaration": { "name": "AtomicInsightResultAttachToCaseAction", "module": "src/components/insight/atomic-insight-result-attach-to-case-action/atomic-insight-result-attach-to-case-action.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-result-attach-to-case-action", "declaration": { "name": "AtomicInsightResultAttachToCaseAction", "module": "src/components/insight/atomic-insight-result-attach-to-case-action/atomic-insight-result-attach-to-case-action.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-result-attach-to-case-indicator/atomic-insight-result-attach-to-case-indicator.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-result-attach-to-case-indicator` component can be included inside a result template to indicate whether a result is attached to the current case.", "name": "AtomicInsightResultAttachToCaseIndicator", "cssParts": [ { "description": "The icon that indicates whether the result is attached to the case.", "name": "icon" } ], "members": [ { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "attachToCase", "type": { "text": "AttachToCase" }, "privacy": "private" }, { "kind": "field", "name": "attachToCaseState", "type": { "text": "Record" }, "privacy": "private" }, { "kind": "field", "name": "itemContextController", "type": { "text": "ItemContextController" }, "privacy": "private", "default": "new ItemContextController(this, { parentName: 'atomic-insight-result', })" }, { "kind": "method", "name": "initialize", "privacy": "public" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-result-attach-to-case-indicator", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightResultAttachToCaseIndicator", "declaration": { "name": "AtomicInsightResultAttachToCaseIndicator", "module": "src/components/insight/atomic-insight-result-attach-to-case-indicator/atomic-insight-result-attach-to-case-indicator.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-result-attach-to-case-indicator", "declaration": { "name": "AtomicInsightResultAttachToCaseIndicator", "module": "src/components/insight/atomic-insight-result-attach-to-case-indicator/atomic-insight-result-attach-to-case-indicator.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-result-children/atomic-insight-result-children.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-result-children` component is responsible for displaying child results by applying one or more child result templates.\nIt includes two slots, `before-children` and `after-children`, which allow for rendering content before and after the list of children,\nonly when children exist.", "name": "AtomicInsightResultChildren", "cssParts": [ { "description": "The wrapper for the message when there are child results.", "name": "children-root" }, { "description": "The wrapper for the message when there are no results.", "name": "no-result-root" }, { "description": "The button that allows to collapse or show all child results.", "name": "show-hide-button" } ], "slots": [ { "description": "The default slot where `atomic-insight-result-children-template` components should be placed.", "name": "default" }, { "description": "Slot that allows rendering content before the list of children, only when children exist.", "name": "before-children" }, { "description": "Slot that allows rendering content after the list of children, only when children exist.", "name": "after-children" } ], "members": [ { "kind": "field", "name": "inheritTemplates", "type": { "text": "boolean" }, "default": "false", "description": "Whether to inherit templates defined in a parent atomic-insight-result-children. Only works for the second level of child nesting.", "attribute": "inherit-templates" }, { "kind": "field", "name": "imageSize", "type": { "text": "ItemDisplayImageSize" }, "description": "The expected size of the image displayed in the children results.", "attribute": "image-size", "reflects": true }, { "kind": "field", "name": "noResultText", "type": { "text": "string" }, "default": "'no-documents-related'", "description": "The non-localized copy for an empty result state. An empty string will result in the component being hidden.", "attribute": "no-result-text" }, { "kind": "field", "name": "bindings", "type": { "text": "InsightBindings" }, "privacy": "private" }, { "kind": "field", "name": "error", "type": { "text": "Error" }, "privacy": "private" }, { "kind": "field", "name": "resultTemplateRegistered", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "templateHasError", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "showInitialChildren", "type": { "text": "boolean" }, "privacy": "private", "default": "true" }, { "kind": "field", "name": "loadedFullCollection", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "foldedResultListState", "type": { "text": "InsightFoldedResultListState" }, "privacy": "private" }, { "kind": "field", "name": "foldedItemListContextController", "type": { "text": "FoldedItemListContextController" }, "privacy": "private", "default": "new FoldedItemListContextController(this)" }, { "kind": "field", "name": "childTemplatesContextController", "type": { "text": "ChildTemplatesContextController" }, "privacy": "private", "default": "new ChildTemplatesContextController(this)" }, { "kind": "field", "name": "displayConfigContextController", "type": { "text": "ItemDisplayConfigContextController" }, "privacy": "private", "default": "new ItemDisplayConfigContextController(this)" }, { "kind": "field", "name": "itemContextController", "type": { "text": "ItemContextController" }, "privacy": "private", "default": "new ItemContextController(this, { folded: true, parentName: 'atomic-insight-result', })" }, { "kind": "field", "name": "itemTemplateProvider", "type": { "text": "ResultTemplateProvider | undefined" }, "privacy": "private" }, { "kind": "field", "name": "initialChildren", "type": { "text": "InsightFoldedResult[]" }, "privacy": "private" }, { "kind": "field", "name": "foldedResultListUnsubscriber", "type": { "text": "() => void | undefined" }, "privacy": "private" }, { "kind": "method", "name": "initialize", "privacy": "public" }, { "kind": "field", "name": "resolveChildTemplates", "privacy": "private" }, { "kind": "field", "name": "foldedResultList", "type": { "text": "InsightFoldedResultList | null" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "result", "type": { "text": "InsightFoldedResult | null" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "displayConfig", "type": { "text": "DisplayConfig | null" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "effectiveItemTemplateProvider", "type": { "text": "ResultTemplateProvider | null" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "collection", "privacy": "private", "readonly": true }, { "kind": "method", "name": "loadFullCollection", "privacy": "private" }, { "kind": "field", "name": "toggleShowInitialChildren", "privacy": "private" }, { "kind": "method", "name": "renderChild", "privacy": "private", "parameters": [ { "name": "child", "type": { "text": "InsightFoldedResult" } }, { "name": "isLast", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "renderChildren", "privacy": "private", "parameters": [ { "name": "children", "type": { "text": "InsightFoldedResult[]" } } ] }, { "kind": "method", "name": "renderCollection", "privacy": "private" }, { "kind": "method", "name": "renderFoldedResult", "privacy": "private" } ], "attributes": [ { "name": "inherit-templates", "type": { "text": "boolean" }, "default": "false", "description": "Whether to inherit templates defined in a parent atomic-insight-result-children. Only works for the second level of child nesting.", "fieldName": "inheritTemplates" }, { "name": "image-size", "type": { "text": "ItemDisplayImageSize" }, "description": "The expected size of the image displayed in the children results.", "fieldName": "imageSize" }, { "name": "no-result-text", "type": { "text": "string" }, "default": "'no-documents-related'", "description": "The non-localized copy for an empty result state. An empty string will result in the component being hidden.", "fieldName": "noResultText" } ], "superclass": { "name": "LitElement", "package": "lit" }, "events": [], "tagName": "atomic-insight-result-children", "customElement": true } ], "exports": [ { "kind": "js", "name": "AtomicInsightResultChildren", "declaration": { "name": "AtomicInsightResultChildren", "module": "src/components/insight/atomic-insight-result-children/atomic-insight-result-children.ts" } }, { "kind": "custom-element-definition", "name": "atomic-insight-result-children", "declaration": { "name": "AtomicInsightResultChildren", "module": "src/components/insight/atomic-insight-result-children/atomic-insight-result-children.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/insight/atomic-insight-result-children-template/atomic-insight-result-children-template.ts", "declarations": [ { "kind": "class", "description": "The `atomic-insight-result-children-template` component determines the display format of child results within an `atomic-insight-result-children` component.", "name": "AtomicInsightResultChildrenTemplate", "slots": [ { "description": "The `