PART 2 - configurable query suggestions & recent queries

packages/atomic/src/components.d.ts

@@ -610,7 +610,7 @@ export namespace Components {
         "maxWithoutQuery"?: number;
     }
     interface AtomicSearchBoxRecentQueries {
-        "maxWithQuery"?: number;
+        "maxWithQuery": number;
         "maxWithoutQuery"?: number;
     }
     interface AtomicSearchInterface {

packages/atomic/src/components/atomic-search-box/atomic-search-box.tsx

@@ -94,7 +94,7 @@ export class AtomicSearchBox {
     this.pendingSuggestionEvents = [];
   }
 
-  @Listen('atomic/searchBoxSuggestion')
+  @Listen('atomic/searchBoxSuggestion/register')
   public setFormat(event: CustomEvent<SearchBoxSuggestionsEvent>) {
     event.preventDefault();
     event.stopPropagation();
@@ -111,6 +111,9 @@ export class AtomicSearchBox {
       id: this.id,
       searchBoxController: this.searchBox,
       numberOfQueries: this.numberOfQueries,
+      inputRef: this.inputRef,
+      triggerSuggestions: () => this.triggerSuggestions(),
+      getSuggestions: () => this.suggestions,
     };
   }
 
@@ -179,7 +182,7 @@ export class AtomicSearchBox {
       return;
     }
 
-    const query = this.nextOrFirstValue.getAttribute('data-value');
+    const query = this.nextOrFirstValue.getAttribute('data-query');
     !isNullOrUndefined(query) && this.updateQuery(query);
     this.updateActiveDescendant(this.nextOrFirstValue.id);
     this.scrollActiveDescendantIntoView();
@@ -190,7 +193,7 @@ export class AtomicSearchBox {
       return;
     }
 
-    const query = this.previousOrLastValue.getAttribute('data-value');
+    const query = this.previousOrLastValue.getAttribute('data-query');
     !isNullOrUndefined(query) && this.updateQuery(query);
     this.updateActiveDescendant(this.previousOrLastValue.id);
     this.scrollActiveDescendantIntoView();
@@ -200,11 +203,15 @@ export class AtomicSearchBox {
     await Promise.all(
       this.suggestions.map((suggestion) => suggestion.onInput())
     );
-    this.suggestionElements = this.suggestions
-      // TODO: sort by position
+    const suggestionElements = this.suggestions
+      .sort((a, b) => a.position - b.position)
       .map((suggestion) => suggestion.renderItems())
-      .flat()
-      .slice(0, this.numberOfQueries);
+      .flat();
+
+    const max =
+      this.numberOfQueries +
+      suggestionElements.filter((sug) => sug.query === undefined).length;
+    this.suggestionElements = suggestionElements.slice(0, max);
   }
 
   private onInput(value: string) {
@@ -221,6 +228,7 @@ export class AtomicSearchBox {
   private onBlur() {
     this.isExpanded = false;
     this.updateActiveDescendant();
+    this.clearSuggestionElements();
   }
 
   private onSubmit() {
@@ -298,6 +306,7 @@ export class AtomicSearchBox {
         class="w-8 h-8 mr-1.5 text-neutral-dark"
         onClick={() => {
           this.searchBox.clear();
+          this.clearSuggestionElements();
           this.inputRef.focus();
         }}
         ariaLabel={this.bindings.i18n.t('clear')}
@@ -323,6 +332,10 @@ export class AtomicSearchBox {
     );
   }
 
+  private clearSuggestionElements() {
+    this.suggestionElements = [];
+  }
+
   private renderSuggestion(
     suggestion: SearchBoxSuggestionElement,
     index: number
@@ -334,14 +347,14 @@ export class AtomicSearchBox {
         id={id}
         role="option"
         aria-selected={`${isSelected}`}
-        key={suggestion.value}
-        data-value={suggestion.value}
+        key={suggestion.key}
+        data-query={suggestion.query}
         part={isSelected ? 'active-suggestion suggestion' : 'suggestion'}
         class={`flex px-4 h-10 items-center text-neutral-dark hover:bg-neutral-light cursor-pointer first:rounded-t-md last:rounded-b-md ${
           isSelected ? 'bg-neutral-light' : ''
         }`}
         onMouseDown={(e) => e.preventDefault()}
-        onClick={() => suggestion.onClick()}
+        onClick={() => suggestion.onSelect()}
       >
         {suggestion.content}
       </li>
@@ -376,7 +389,10 @@ export class AtomicSearchBox {
         class="w-12 h-auto rounded-r-md rounded-l-none -my-px"
         part="submit-button"
         ariaLabel={this.bindings.i18n.t('search')}
-        onClick={() => this.searchBox.submit()}
+        onClick={() => {
+          this.searchBox.submit();
+          this.clearSuggestionElements();
+        }}
       >
         <atomic-icon icon={SearchIcon} class="w-4 h-4"></atomic-icon>
       </Button>

packages/atomic/src/components/search-box-suggestions/atomic-search-box-query-suggestions/atomic-search-box-query-suggestions.tsx

@@ -1,13 +1,23 @@
-import {loadQuerySuggestActions, SearchEngine} from '@coveo/headless';
+import SearchIcon from 'coveo-styleguide/resources/icons/svg/search.svg';
+import {
+  loadQuerySuggestActions,
+  SearchEngine,
+  Suggestion,
+} from '@coveo/headless';
 import {QuerySuggestionSection} from '@coveo/headless/dist/definitions/state/state-sections';
 import {Component, Element, Prop, State, h} from '@stencil/core';
-import {dispatchSearchBoxSuggestionsEvent} from '../suggestions-common';
+import {
+  dispatchSearchBoxSuggestionsEvent,
+  SearchBoxSuggestionElement,
+  SearchBoxSuggestionsBindings,
+} from '../suggestions-common';
 
 @Component({
   tag: 'atomic-search-box-query-suggestions',
   shadow: true,
 })
 export class AtomicSearchBoxQuerySuggestions {
+  private bindings!: SearchBoxSuggestionsBindings;
   @Element() private host!: HTMLElement;
 
   @State() public error!: Error;
@@ -17,42 +27,74 @@ export class AtomicSearchBoxQuerySuggestions {
 
   componentWillLoad() {
     try {
-      dispatchSearchBoxSuggestionsEvent(
-        ({engine, id, searchBoxController, numberOfQueries}) => {
-          const {registerQuerySuggest, fetchQuerySuggestions} =
-            loadQuerySuggestActions(engine);
-
-          (engine as SearchEngine<QuerySuggestionSection>).dispatch(
-            registerQuerySuggest({
-              id,
-              count: numberOfQueries,
-            })
-          );
-
-          return {
-            onInput: () =>
-              (engine as SearchEngine<QuerySuggestionSection>).dispatch(
-                fetchQuerySuggestions({
-                  id,
-                })
-              ),
-            renderItems: () =>
-              // TODO: limit values according to maxWithQuery/maxWithoutQuery
-              searchBoxController.state.suggestions.map((suggestion) => ({
-                content: <span innerHTML={suggestion.highlightedValue}></span>,
-                value: suggestion.rawValue,
-                onClick: () =>
-                  searchBoxController.selectSuggestion(suggestion.rawValue),
-              })),
-          };
-        },
-        this.host
-      );
+      this.initialize();
     } catch (error) {
       this.error = error as Error;
     }
   }
 
+  private initialize() {
+    dispatchSearchBoxSuggestionsEvent((bindings) => {
+      this.bindings = bindings;
+      const engine = bindings.engine as SearchEngine<QuerySuggestionSection>;
+      const {registerQuerySuggest, fetchQuerySuggestions} =
+        loadQuerySuggestActions(engine);
+
+      engine.dispatch(
+        registerQuerySuggest({
+          id: bindings.id,
+          count: bindings.numberOfQueries,
+        })
+      );
+
+      return {
+        position: Array.from(this.host.parentNode!.children).indexOf(this.host),
+        onInput: () =>
+          engine.dispatch(
+            fetchQuerySuggestions({
+              id: bindings.id,
+            })
+          ),
+        renderItems: () => this.renderItems(),
+      };
+    }, this.host);
+  }
+
+  private renderItems(): SearchBoxSuggestionElement[] {
+    const hasQuery = this.bindings.searchBoxController.state.value !== '';
+    const max = hasQuery ? this.maxWithQuery : this.maxWithoutQuery;
+    return this.bindings.searchBoxController.state.suggestions
+      .slice(0, max)
+      .map((suggestion) => this.renderItem(suggestion));
+  }
+
+  private renderItem(suggestion: Suggestion) {
+    const hasQuery = this.bindings.searchBoxController.state.value !== '';
+    return {
+      content: (
+        <div class="flex items-center">
+          {this.bindings.getSuggestions().length > 1 && (
+            <atomic-icon
+              icon={SearchIcon}
+              class="w-4 h-4 text-neutral mr-2"
+            ></atomic-icon>
+          )}
+          {hasQuery ? (
+            <span innerHTML={suggestion.highlightedValue}></span>
+          ) : (
+            <span>{suggestion.rawValue}</span>
+          )}
+        </div>
+      ),
+      key: suggestion.rawValue,
+      query: suggestion.rawValue,
+      onSelect: () => {
+        this.bindings.searchBoxController.selectSuggestion(suggestion.rawValue);
+        this.bindings.inputRef.blur();
+      },
+    };
+  }
+
   public render() {
     if (this.error) {
       return (