@constructor-io/constructorio-ui-autocomplete 1.23.15 → 1.23.17

package/lib/cjs/components/Autocomplete/AutocompleteResults/AutocompleteResults.js

@@ -5,6 +5,7 @@ const react_1 = tslib_1.__importStar(require("react"));
 const utils_1 = require("../../../utils");
 const CioAutocompleteProvider_1 = require("../CioAutocompleteProvider");
 const SectionItemsList_1 = tslib_1.__importDefault(require("../SectionItemsList/SectionItemsList"));
+const CloseIcon_1 = tslib_1.__importDefault(require("./CloseIcon"));
 const DefaultRenderResults = ({ sections }) => sections === null || sections === void 0 ? void 0 : sections.map((section) => {
     const { type } = section;
     let key = section.displayName;
@@ -26,12 +27,14 @@ const DefaultRenderResults = ({ sections }) => sections === null || sections ===
 });
 function AutocompleteResults(props) {
     const { children = DefaultRenderResults } = props;
-    const { sections, isOpen, getMenuProps, getItemProps } = (0, react_1.useContext)(CioAutocompleteProvider_1.CioAutocompleteContext);
+    const { sections, isOpen, getMenuProps, getItemProps, closeMenu } = (0, react_1.useContext)(CioAutocompleteProvider_1.CioAutocompleteContext);
     const hasResults = sections && sections.some((section) => { var _a; return (_a = section === null || section === void 0 ? void 0 : section.data) === null || _a === void 0 ? void 0 : _a.length; });
     const menuProps = Object.assign({}, getMenuProps());
     let content;
     if (isOpen && hasResults) {
-        content = typeof children === 'function' ? children({ sections, getItemProps }) : children;
+        content = (react_1.default.createElement(react_1.default.Fragment, null,
+            react_1.default.createElement(CloseIcon_1.default, { onClick: () => closeMenu() }),
+            typeof children === 'function' ? children({ sections, getItemProps }) : children));
     }
     else {
         content = null;

package/lib/cjs/components/Autocomplete/AutocompleteResults/CloseIcon.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const react_1 = tslib_1.__importDefault(require("react"));
+function CloseIcon(props) {
+    return (react_1.default.createElement("svg", Object.assign({}, props, { className: 'cio-close', version: '1.1', id: 'Layer_1', xmlns: 'http://www.w3.org/2000/svg', x: '0px', y: '0px', width: '122.878px', height: '122.88px', viewBox: '0 0 122.878 122.88', enableBackground: 'new 0 0 122.878 122.88', xmlSpace: 'preserve' }),
+        react_1.default.createElement("g", null,
+            react_1.default.createElement("path", { d: 'M1.426,8.313c-1.901-1.901-1.901-4.984,0-6.886c1.901-1.902,4.984-1.902,6.886,0l53.127,53.127l53.127-53.127 c1.901-1.902,4.984-1.902,6.887,0c1.901,1.901,1.901,4.985,0,6.886L68.324,61.439l53.128,53.128c1.901,1.901,1.901,4.984,0,6.886 c-1.902,1.902-4.985,1.902-6.887,0L61.438,68.326L8.312,121.453c-1.901,1.902-4.984,1.902-6.886,0 c-1.901-1.901-1.901-4.984,0-6.886l53.127-53.128L1.426,8.313L1.426,8.313z' }))));
+}
+exports.default = CloseIcon;

package/lib/cjs/components/Autocomplete/SectionItemsList/SectionItemsList.js

@@ -8,7 +8,7 @@ const CioAutocompleteProvider_1 = require("../CioAutocompleteProvider");
 // eslint-disable-next-line func-names
 const DefaultRenderSectionItemsList = function ({ section }) {
     var _a, _b;
-    const { getSectionProps, query, getFormProps, advancedParameters } = (0, react_1.useContext)(CioAutocompleteProvider_1.CioAutocompleteContext);
+    const { getSectionProps, query, getFormProps, advancedParameters, getItemProps } = (0, react_1.useContext)(CioAutocompleteProvider_1.CioAutocompleteContext);
     const { displayShowAllResultsButton, translations } = advancedParameters || {};
     const { onSubmit } = getFormProps();
     const { type, displayName } = section;
@@ -36,7 +36,7 @@ const DefaultRenderSectionItemsList = function ({ section }) {
         react_1.default.createElement("h5", { className: 'cio-section-name cio-sectionName', "aria-hidden": true }, (0, utils_1.camelToStartCase)(sectionTitle)),
         react_1.default.createElement("ul", { className: 'cio-section-items', role: 'none' }, (_b = section === null || section === void 0 ? void 0 : section.data) === null || _b === void 0 ? void 0 : _b.map((item) => {
             if (typeof (section === null || section === void 0 ? void 0 : section.renderItem) === 'function') {
-                return section.renderItem({ item, query });
+                return section.renderItem({ item, query, getItemProps });
             }
             return (react_1.default.createElement(SectionItem_1.default, { item: item, key: item === null || item === void 0 ? void 0 : item.id, displaySearchTermHighlights: section.displaySearchTermHighlights }));
         })),

package/lib/cjs/constants.js

@@ -215,7 +215,7 @@ To see this in action:
 3. Then use the Controls to adjust the values of \`numTermsWithGroupSuggestions\` to \`3\` and \`numGroupsSuggestedPerTerm\` to \`1\`
 4. Next, type "pan" in the example autocomplete input field.
   - Notice how the user is presented with three different search terms that have a maximum of one "in {group}" suggestion each`;
-exports.filteredSuggestionsDescription = `Pass a \`filters\` object under \`advancedParameters\` to apply filters to the suggestions. Any parameter supported by <a href="https://docs.constructor.io/rest_api/autocomplete_queries/" target="__blank">our autocomplete endpoint</a> can be passed under \`advancedParameters\`.
+exports.filteredSuggestionsDescription = `Pass a \`filters\` object under \`advancedParameters\` to apply filters to the suggestions. Any parameter supported by <a href="https://docs.constructor.com/reference/autocomplete-autocomplete-results" target="__blank">our autocomplete endpoint</a> can be passed under \`advancedParameters\`.
 
 To see this in action:
 1. Type "short" in the example below.
@@ -240,5 +240,6 @@ exports.translationsDescription = `Pass a \`translations\` object to display tra
 \`\`\`
 `;
 exports.customRenderItemDescription = `Customize the rendering of individual items within a Section by providing a \`renderItem\` function. This function allows you to define how each item should be rendered.
+- Make sure to call \`getItemProps(item)\` and spread like this \`<div {...getItemProps(item)}/>\` on the container of each custom rendered item or else tracking will not work.
 `;
 exports.displayShowAllResultsButtonDescription = `Pass a boolean to \`displayShowAllResultsButton\` to display a button at the bottom of the Products section to show all results. This button will submit the form and trigger the \`onSubmit\` callback.`;

package/lib/cjs/utils.js

@@ -102,8 +102,8 @@ ${templateCode}
 exports.getStoryParams = getStoryParams;
 exports.functionStrings = {
     onSubmit: `(submitEvent) => console.dir(submitEvent)`,
-    renderItem: `({ item, query }) => (
-                      <div>
+    renderItem: `({ item, query, getItemProps }) => (
+                      <div {...getItemProps(item)}>
                           <a href={item.data?.url}>
                             <h3>{item.value}</h3>
                             <img src={item.data?.image_url} alt={item.value} />

package/lib/cjs/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '1.23.15';
+exports.default = '1.23.17';

package/lib/mjs/components/Autocomplete/AutocompleteResults/AutocompleteResults.js

@@ -2,6 +2,7 @@ import React, { useContext } from 'react';
 import { toKebabCase } from '../../../utils';
 import { CioAutocompleteContext } from '../CioAutocompleteProvider';
 import SectionItemsList from '../SectionItemsList/SectionItemsList';
+import CloseIcon from './CloseIcon';
 const DefaultRenderResults = ({ sections }) => sections?.map((section) => {
     const { type } = section;
     let key = section.displayName;
@@ -23,14 +24,16 @@ const DefaultRenderResults = ({ sections }) => sections?.map((section) => {
 });
 export default function AutocompleteResults(props) {
     const { children = DefaultRenderResults } = props;
-    const { sections, isOpen, getMenuProps, getItemProps } = useContext(CioAutocompleteContext);
+    const { sections, isOpen, getMenuProps, getItemProps, closeMenu } = useContext(CioAutocompleteContext);
     const hasResults = sections && sections.some((section) => section?.data?.length);
     const menuProps = {
         ...getMenuProps(),
     };
     let content;
     if (isOpen && hasResults) {
-        content = typeof children === 'function' ? children({ sections, getItemProps }) : children;
+        content = (React.createElement(React.Fragment, null,
+            React.createElement(CloseIcon, { onClick: () => closeMenu() }),
+            typeof children === 'function' ? children({ sections, getItemProps }) : children));
     }
     else {
         content = null;

package/lib/mjs/components/Autocomplete/AutocompleteResults/CloseIcon.js

@@ -0,0 +1,6 @@
+import React from 'react';
+export default function CloseIcon(props) {
+    return (React.createElement("svg", { ...props, className: 'cio-close', version: '1.1', id: 'Layer_1', xmlns: 'http://www.w3.org/2000/svg', x: '0px', y: '0px', width: '122.878px', height: '122.88px', viewBox: '0 0 122.878 122.88', enableBackground: 'new 0 0 122.878 122.88', xmlSpace: 'preserve' },
+        React.createElement("g", null,
+            React.createElement("path", { d: 'M1.426,8.313c-1.901-1.901-1.901-4.984,0-6.886c1.901-1.902,4.984-1.902,6.886,0l53.127,53.127l53.127-53.127 c1.901-1.902,4.984-1.902,6.887,0c1.901,1.901,1.901,4.985,0,6.886L68.324,61.439l53.128,53.128c1.901,1.901,1.901,4.984,0,6.886 c-1.902,1.902-4.985,1.902-6.887,0L61.438,68.326L8.312,121.453c-1.901,1.902-4.984,1.902-6.886,0 c-1.901-1.901-1.901-4.984,0-6.886l53.127-53.128L1.426,8.313L1.426,8.313z' }))));
+}

package/lib/mjs/components/Autocomplete/SectionItemsList/SectionItemsList.js

@@ -4,7 +4,7 @@ import { camelToStartCase, translate } from '../../../utils';
 import { CioAutocompleteContext } from '../CioAutocompleteProvider';
 // eslint-disable-next-line func-names
 const DefaultRenderSectionItemsList = function ({ section }) {
-    const { getSectionProps, query, getFormProps, advancedParameters } = useContext(CioAutocompleteContext);
+    const { getSectionProps, query, getFormProps, advancedParameters, getItemProps } = useContext(CioAutocompleteContext);
     const { displayShowAllResultsButton, translations } = advancedParameters || {};
     const { onSubmit } = getFormProps();
     const { type, displayName } = section;
@@ -32,7 +32,7 @@ const DefaultRenderSectionItemsList = function ({ section }) {
         React.createElement("h5", { className: 'cio-section-name cio-sectionName', "aria-hidden": true }, camelToStartCase(sectionTitle)),
         React.createElement("ul", { className: 'cio-section-items', role: 'none' }, section?.data?.map((item) => {
             if (typeof section?.renderItem === 'function') {
-                return section.renderItem({ item, query });
+                return section.renderItem({ item, query, getItemProps });
             }
             return (React.createElement(SectionItem, { item: item, key: item?.id, displaySearchTermHighlights: section.displaySearchTermHighlights }));
         })),

package/lib/mjs/constants.js

@@ -211,7 +211,7 @@ To see this in action:
 3. Then use the Controls to adjust the values of \`numTermsWithGroupSuggestions\` to \`3\` and \`numGroupsSuggestedPerTerm\` to \`1\`
 4. Next, type "pan" in the example autocomplete input field.
   - Notice how the user is presented with three different search terms that have a maximum of one "in {group}" suggestion each`;
-export const filteredSuggestionsDescription = `Pass a \`filters\` object under \`advancedParameters\` to apply filters to the suggestions. Any parameter supported by <a href="https://docs.constructor.io/rest_api/autocomplete_queries/" target="__blank">our autocomplete endpoint</a> can be passed under \`advancedParameters\`.
+export const filteredSuggestionsDescription = `Pass a \`filters\` object under \`advancedParameters\` to apply filters to the suggestions. Any parameter supported by <a href="https://docs.constructor.com/reference/autocomplete-autocomplete-results" target="__blank">our autocomplete endpoint</a> can be passed under \`advancedParameters\`.
 
 To see this in action:
 1. Type "short" in the example below.
@@ -236,5 +236,6 @@ export const translationsDescription = `Pass a \`translations\` object to displa
 \`\`\`
 `;
 export const customRenderItemDescription = `Customize the rendering of individual items within a Section by providing a \`renderItem\` function. This function allows you to define how each item should be rendered.
+- Make sure to call \`getItemProps(item)\` and spread like this \`<div {...getItemProps(item)}/>\` on the container of each custom rendered item or else tracking will not work.
 `;
 export const displayShowAllResultsButtonDescription = `Pass a boolean to \`displayShowAllResultsButton\` to display a button at the bottom of the Products section to show all results. This button will submit the form and trigger the \`onSubmit\` callback.`;

package/lib/mjs/utils.js

@@ -86,8 +86,8 @@ ${templateCode}
 };
 export const functionStrings = {
     onSubmit: `(submitEvent) => console.dir(submitEvent)`,
-    renderItem: `({ item, query }) => (
-                      <div>
+    renderItem: `({ item, query, getItemProps }) => (
+                      <div {...getItemProps(item)}>
                           <a href={item.data?.url}>
                             <h3>{item.value}</h3>
                             <img src={item.data?.image_url} alt={item.value} />

package/lib/mjs/version.js

@@ -1 +1 @@
-export default '1.23.15';
+export default '1.23.17';

package/lib/styles.css

@@ -182,4 +182,13 @@
 
 .cio-autocomplete .cio-section-footer .cio-show-all-results-button:hover {
   background-color: hsl(0, 0%, 90%);
+}
+
+.cio-autocomplete .cio-close {
+  position: absolute;
+  top: 20px;
+  right: 20px;
+  cursor: pointer;
+  width: 15px;
+  height: 15px;
 }

package/lib/types/components/Autocomplete/AutocompleteResults/CloseIcon.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export default function CloseIcon(props: any): JSX.Element;

package/lib/types/constants.d.ts

@@ -29,10 +29,10 @@ export declare const customStylesDescription = "\nBy default, importing react co
 export declare const advancedParametersDescription = "The stories below show how optional fields within this `advancedParameters` object that can be used to fine-tune the autosuggest data returned from constructor's servers.";
 export declare const advancedParametersDefaultDescription = "Passing an `advancedParameters` object is optional. Passing an empty object for the `advancedParameters` field behaves the same as not passing an `advancedParameters` object at all.";
 export declare const termsWithGroupSuggestionsDescription = "Pass integers for the `numTermsWithGroupSuggestions` and `numGroupsSuggestedPerTerm` fields to add suggested group filters to search term suggestions. Not all suggested search terms will have group filters, so these integers are upper limits, used to specify the maximum number of terms with group filters and the maximum number of suggested group filters per term.\n\nTo see this in action:\n1. Type \"pan\" in the example below.\n  - Notice how the user is presented with a search term of \"all week flex pant\" as well as \"all week flex pant in Chinos\" and \"all week flex pant baby in Athleisure Pants & Joggers\"\n2. Navigate to the \"Terms With Group Suggestions\" story (using the navigation menu to the left)\n3. Then use the Controls to adjust the values of `numTermsWithGroupSuggestions` to `3` and `numGroupsSuggestedPerTerm` to `1`\n4. Next, type \"pan\" in the example autocomplete input field.\n  - Notice how the user is presented with three different search terms that have a maximum of one \"in {group}\" suggestion each";
-export declare const filteredSuggestionsDescription = "Pass a `filters` object under `advancedParameters` to apply filters to the suggestions. Any parameter supported by <a href=\"https://docs.constructor.io/rest_api/autocomplete_queries/\" target=\"__blank\">our autocomplete endpoint</a> can be passed under `advancedParameters`.\n\nTo see this in action:\n1. Type \"short\" in the example below.\n  - Notice how the user is presented with only short pants as results.\n  - This is because the results are currently filtered to belong to the \"Shorts\" group.\n2. Navigate to the \"Filtered Suggestions\" story (using the navigation menu to the left)\n3. Then use the Controls to adjust the values of `\"group_id\"` to `\"1030\"`.\n4. Next, type \"short\" in the example autocomplete input field.\n  - Notice how the user is presented with only short sleeved items as results.\n  - This is because we are filtering to the \"Shirts\" group";
+export declare const filteredSuggestionsDescription = "Pass a `filters` object under `advancedParameters` to apply filters to the suggestions. Any parameter supported by <a href=\"https://docs.constructor.com/reference/autocomplete-autocomplete-results\" target=\"__blank\">our autocomplete endpoint</a> can be passed under `advancedParameters`.\n\nTo see this in action:\n1. Type \"short\" in the example below.\n  - Notice how the user is presented with only short pants as results.\n  - This is because the results are currently filtered to belong to the \"Shorts\" group.\n2. Navigate to the \"Filtered Suggestions\" story (using the navigation menu to the left)\n3. Then use the Controls to adjust the values of `\"group_id\"` to `\"1030\"`.\n4. Next, type \"short\" in the example autocomplete input field.\n  - Notice how the user is presented with only short sleeved items as results.\n  - This is because we are filtering to the \"Shirts\" group";
 export declare const termsWithImagesAndCountsDescription = "Pass boolean flags for `displaySearchSuggestionImages` and `displaySearchSuggestionResultCounts` fields to display images and counts for search suggestions. These fields need to be made displayable before they can be used. Please contact your Constructor Integration Engineer for details.";
 export declare const debounceDescription = "Pass an integer to `debounce` to override the recommended, default delay employed for debouncing autocomplete network requests between keystrokes as your users type into the text input field. The default value is 250, which results in a debounce delay of 250 milliseconds.";
 export declare const fetchZeroStateOnFocusDescription = "Pass a boolean to `fetchZeroStateOnFocus` to override the zero state fetching behavior from initial render to input focus.";
 export declare const translationsDescription = "Pass a `translations` object to display translatable words in your preferred language.\n\n- Current translatable keys:\n```\n  {\n    \"in\": \"...\",\n    \"show all results\": \"...\"\n  }\n```\n";
-export declare const customRenderItemDescription = "Customize the rendering of individual items within a Section by providing a `renderItem` function. This function allows you to define how each item should be rendered.\n";
+export declare const customRenderItemDescription = "Customize the rendering of individual items within a Section by providing a `renderItem` function. This function allows you to define how each item should be rendered.\n- Make sure to call `getItemProps(item)` and spread like this `<div {...getItemProps(item)}/>` on the container of each custom rendered item or else tracking will not work.\n";
 export declare const displayShowAllResultsButtonDescription = "Pass a boolean to `displayShowAllResultsButton` to display a button at the bottom of the Products section to show all results. This button will submit the form and trigger the `onSubmit` callback.";

package/lib/types/types.d.ts

@@ -94,6 +94,7 @@ export type SectionConfiguration = {
     renderItem?: (props: {
         item: Item;
         query: string;
+        getItemProps: (item: Item) => any;
     }) => ReactNode;
 };
 export interface AutocompleteSectionConfiguration extends SectionConfiguration {

package/lib/types/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.23.15";
+declare const _default: "1.23.17";
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-ui-autocomplete",
-  "version": "1.23.15",
+  "version": "1.23.17",
   "description": "Constructor.io Autocomplete UI library for web applications",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",