From 7183b445e1877a80fcbe702bb43af1d26d7d0d0c Mon Sep 17 00:00:00 2001
From: Holger Stitz <holger.stitz@datavisyn.io>
Date: Thu, 15 Feb 2024 09:14:18 +0100
Subject: [PATCH] feat: improve string column search dialog

---
 src/styles/_dialogs.scss       |  43 +++++++++++
 src/ui/dialogs/SearchDialog.ts | 126 +++++++++++++++++++++++++++------
 2 files changed, 147 insertions(+), 22 deletions(-)

diff --git a/src/styles/_dialogs.scss b/src/styles/_dialogs.scss
index 0293f57bb..44f404bbf 100644
--- a/src/styles/_dialogs.scss
+++ b/src/styles/_dialogs.scss
@@ -265,3 +265,46 @@
     bottom: -$arrow_size;
   }
 }
+
+/* search dialog for string columns */
+.#{$lu_css_prefix}-string-search-dialog {
+  display: flex;
+  gap: 5px;
+
+  .#{$lu_css_prefix}-search-count {
+    color: $lu_toolbar_color_base;
+  }
+
+  button {
+    border: none;
+    background: none;
+    color: $lu_toolbar_color_base2;
+
+    &:disabled {
+      color: $lu_toolbar_color_base;
+    }
+
+    &:not(:disabled) {
+      cursor: pointer;
+
+      &:hover,
+      &:active,
+      &:focus {
+        color: $lu_toolbar_color_hover;
+      }
+    }
+
+    &::before {
+      @include lu_icons();
+    }
+
+    &.#{$lu_css_prefix}-previous-result::before {
+      content: $lu_icon_up_open;
+    }
+
+    &.#{$lu_css_prefix}-next-result::before {
+      content: $lu_icon_down_open;
+    }
+
+  }
+}
\ No newline at end of file
diff --git a/src/ui/dialogs/SearchDialog.ts b/src/ui/dialogs/SearchDialog.ts
index 88af6612a..0ad61e46a 100644
--- a/src/ui/dialogs/SearchDialog.ts
+++ b/src/ui/dialogs/SearchDialog.ts
@@ -1,7 +1,7 @@
 import type { Column } from '../../model';
 import type { IDataProvider } from '../../provider';
 import ADialog, { type IDialogContext } from './ADialog';
-import { cssClass } from '../../styles';
+import { aria, cssClass } from '../../styles';
 import { debounce } from '../../internal';
 
 /** @internal */
@@ -24,9 +24,17 @@ export default class SearchDialog extends ADialog {
   }
 
   protected build(node: HTMLElement) {
+    // NOTE: the next button is of type submit to enable jumping to the next search result with the enter key in the search input field
     node.insertAdjacentHTML(
       'beforeend',
-      `<input type="text" size="20" value="" required autofocus placeholder="search... (>= 3 chars)">
+      `<div class="${cssClass('string-search-dialog')}">
+        <input type="text" size="20" value="" required autofocus placeholder="Enter a search term...">
+        <div class="${cssClass('search-count')}" hidden>
+          <span class="${cssClass('search-current')}"></span>/<span class="${cssClass('search-total')}"></span>
+        </div>
+        <button type="button" class="${cssClass('previous-result')}" title="Previous search result" disabled>${aria('Previous search result')}</button>
+        <button type="submit" class="${cssClass('next-result')}" title="Next search result" disabled>${aria('Next search result')}</button>
+      </div>
       <label class="${cssClass('checkbox')}">
         <input type="checkbox">
         <span>Use regular expressions</span>
@@ -36,68 +44,142 @@ export default class SearchDialog extends ADialog {
 
     const input = node.querySelector<HTMLInputElement>('input[type="text"]')!;
     const checkbox = node.querySelector<HTMLInputElement>('input[type="checkbox"]')!;
+    const previous = node.querySelector<HTMLButtonElement>(`.${cssClass('previous-result')}`)!;
+    const next = node.querySelector<HTMLButtonElement>(`.${cssClass('next-result')}`)!;
+
     const update = () => {
       const search: any = input.value;
-      if (search.length < 3) {
-        input.setCustomValidity('at least 3 characters');
+      if (search.length === 0) {
+        input.setCustomValidity('Enter a search term');
         return;
       }
       input.setCustomValidity('');
     };
+
     input.addEventListener('input', update, {
       passive: true,
     });
+
     checkbox.addEventListener('change', update, {
       passive: true,
     });
+
+    previous.addEventListener('click', (evt) => {
+      evt.preventDefault();
+      evt.stopPropagation();
+      this.jumpToPreviousResult();
+    });
+
+    next.addEventListener('click', (evt) => {
+      evt.preventDefault();
+      evt.stopPropagation();
+      this.jumpToNextResult();
+    });
+
     this.enableLivePreviews([input, checkbox]);
 
     if (!this.showLivePreviews()) {
       return;
     }
+
     input.addEventListener(
       'input',
-      debounce(() => this.submit(), 100),
+      debounce(() => this.searchAndJump(), 100),
       {
         passive: true,
       }
     );
   }
 
-  protected submit() {
+  private jumpToPreviousResult() {
+    if (this.current) {
+      const searchCount = this.find<HTMLElement>(`.${cssClass('search-count')}`)!;
+      const current = searchCount.querySelector(`.${cssClass('search-current')}`)!;
+      
+      const previous = (this.current.index - 1 + this.current.indices.length) % this.current.indices.length;
+      this.current.index = previous;
+      current.textContent = String(previous + 1);
+      this.provider.jumpToNearest([this.current.indices[previous]]);
+    }
+  }
+
+  private jumpToNextResult() {
+    if (this.current) {
+      const searchCount = this.find<HTMLElement>(`.${cssClass('search-count')}`)!;
+      const current = searchCount.querySelector(`.${cssClass('search-current')}`)!;
+      
+      const next = (this.current.index + 1) % this.current.indices.length;
+      this.current.index = next;
+      current.textContent = String(next + 1);
+      this.provider.jumpToNearest([this.current.indices[next]]);
+    }
+  }
+
+  private searchAndJump() {
     const input = this.findInput('input[type="text"]')!;
     const checkbox = this.findInput('input[type="checkbox"]')!;
+    const previous = this.find<HTMLButtonElement>(`.${cssClass('previous-result')}`)!;
+    const next = this.find<HTMLButtonElement>(`.${cssClass('next-result')}`)!;
+    const searchCount = this.find<HTMLElement>(`.${cssClass('search-count')}`)!;
 
     let search: string = input.value;
     const isRegex = checkbox.checked;
-    if (this.current && this.current.search === search && this.current.isRegex === isRegex) {
-      const next = (this.current.index + 1) % this.current.indices.length;
-      this.current.index = next;
-      this.provider.jumpToNearest([this.current.indices[next]]);
+    
+    if (search.length === 0) {
+      this.current = null;
+      previous.disabled = true;
+      next.disabled = true;
+      searchCount.hidden = true;
       return false;
+    }
+
+    const indices = this.provider.searchAndJump(isRegex ? new RegExp(search) : search, this.column, true);
+    if (indices) {
+      this.current = {
+        search,
+        isRegex,
+        indices,
+        index: 0,
+      };
+
+      const current = searchCount.querySelector(`.${cssClass('search-current')}`)!;
+      const total = searchCount.querySelector(`.${cssClass('search-total')}`)!;
+      current.textContent = String(indices.length < 1 ? this.current.index : this.current.index + 1);
+      total.textContent = String(indices.length);
+      searchCount.hidden = false;
+
+      previous.disabled = indices.length < 1;
+      next.disabled = indices.length < 1;
+
+      return indices.length > 1;
+      
     } else {
-      const indices = this.provider.searchAndJump(isRegex ? new RegExp(search) : search, this.column, true);
-      if (indices) {
-        this.current = {
-          search,
-          isRegex,
-          indices,
-          index: 0,
-        };
-        return indices.length > 1;
-      } else {
-        this.current = null;
-      }
+      this.current = null;
+      searchCount.hidden = true;
+      previous.disabled = true;
+      next.disabled = true;
     }
 
     return true;
   }
 
+  protected submit() {
+    return true;
+  }
+
   protected reset() {
     const input = this.findInput('input[type="text"]')!;
     const checkbox = this.findInput('input[type="checkbox"]')!;
+    const previous = this.find<HTMLButtonElement>(`.${cssClass('previous-result')}`)!;
+    const next = this.find<HTMLButtonElement>(`.${cssClass('next-result')}`)!;
+    const searchCount = this.find<HTMLElement>(`.${cssClass('search-count')}`)!;
+
+    this.current = null;
     input.value = '';
     checkbox.checked = false;
+    previous.disabled = true;
+    next.disabled = true;
+    searchCount.hidden = true;
   }
 
   protected cancel() {