feat: implement cell match navigation via Enter key #500
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| /** | ||
| * Filter Match Navigation | ||
| * | ||
| * Lets the user press Enter in the global filter or a column filter to jump | ||
| * between cells whose displayed text contains the active filter term, | ||
| * cycling through them with a visible border + a "current / total" counter. | ||
| */ | ||
| import { state } from './state.js'; | ||
| import { getCellValue } from './data-utils.js'; | ||
| import { formatCellValueAsText } from './utils.js'; | ||
|
|
||
| function activeTerm(scope) { | ||
| return (scope === 'global' ? state.filterQuery : state.columnFilters[scope] || '').trim().toLowerCase(); | ||
|
There was a problem hiding this comment.
When a table has a column literally named Useful? React with 👍 / 👎. |
||
| } | ||
|
|
||
| function computeMatches(scope, term) { | ||
| const matches = []; | ||
| if (!term) return matches; | ||
|
|
||
| // Resolve the columns to scan and their data indices once, outside the row loop. | ||
| const columnsToScan = []; | ||
| state.tableColumns.forEach((col, idx) => { | ||
| if (scope === 'global' || col.name === scope) { | ||
| columnsToScan.push({ col, colIdx: idx }); | ||
| } | ||
| }); | ||
|
|
||
| for (let rowIdx = 0; rowIdx < state.gridData.length; rowIdx++) { | ||
| const row = state.gridData[rowIdx]; | ||
| for (const { col, colIdx } of columnsToScan) { | ||
| const value = getCellValue(row, colIdx); | ||
| // String() guards against formatters that may return a non-string | ||
| // (number/null/undefined), which would otherwise throw on .toLowerCase(). | ||
| const text = String(formatCellValueAsText(value, col.type, state.dateFormat, col.name)); | ||
| if (text.toLowerCase().includes(term)) { | ||
| matches.push({ rowIdx, colIdx }); | ||
| } | ||
|
Comment on lines
+31
to
+37
There was a problem hiding this comment. If const value = getCellValue(row, colIdx);
const rawText = formatCellValueAsText(value, col.type, state.dateFormat, col.name);
const text = typeof rawText === 'string' ? rawText : String(rawText || '');
if (text.toLowerCase().includes(term)) {
matches.push({ rowIdx, colIdx });
} |
||
| } | ||
| } | ||
| return matches; | ||
| } | ||
|
|
||
| function focusActiveMatch() { | ||
| document.querySelectorAll('.active-match-cell').forEach(el => el.classList.remove('active-match-cell')); | ||
|
|
||
| const { matches, currentIndex } = state.matchNav; | ||
| if (currentIndex < 0 || currentIndex >= matches.length) return; | ||
|
|
||
| const { rowIdx, colIdx } = matches[currentIndex]; | ||
| const cellEl = document.getElementById(`cell-${rowIdx}-${colIdx}`); | ||
| if (cellEl) { | ||
| cellEl.classList.add('active-match-cell'); | ||
| cellEl.scrollIntoView({ block: 'nearest', inline: 'nearest' }); | ||
| } | ||
| } | ||
|
|
||
| function updateMatchCounterUI() { | ||
| const { scope, matches, currentIndex } = state.matchNav; | ||
| const counterText = matches.length > 0 ? `${currentIndex + 1}/${matches.length}` : ''; | ||
|
|
||
| const globalCounter = document.getElementById('filterMatchCounter'); | ||
| if (globalCounter) { | ||
| globalCounter.textContent = scope === 'global' ? counterText : ''; | ||
| } | ||
|
|
||
| document.querySelectorAll('.column-filter-counter').forEach(el => { | ||
| el.textContent = el.dataset.column === scope ? counterText : ''; | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Move to the next (direction = 1) or previous (direction = -1) match for the | ||
| * given scope ('global' or a column name), wrapping around at either end. | ||
| * Matches are cached on `state.matchNav` and only recomputed when the scope or | ||
| * term changes (a fresh term is detected after `resetMatchNav()` cleared the | ||
| * cache), so pressing Enter/Shift+Enter repeatedly is O(matches), not a full | ||
| * rescan of every row. | ||
| */ | ||
| export function navigateMatches(scope, direction = 1) { | ||
| // Normalize to ±1 so a stray non-numeric arg (e.g. a DOM event) can never | ||
| // produce a NaN index in the modulo arithmetic below. | ||
| direction = direction < 0 ? -1 : 1; | ||
| const term = activeTerm(scope); | ||
| const cacheValid = state.matchNav.scope === scope | ||
| && state.matchNav.term === term | ||
| && state.matchNav.matches.length > 0; | ||
|
Comment on lines
+84
to
+86
There was a problem hiding this comment.
After matches are cached, this validity check only considers scope and term, but Useful? React with 👍 / 👎. |
||
|
|
||
| if (cacheValid) { | ||
| const len = state.matchNav.matches.length; | ||
| state.matchNav.currentIndex = (state.matchNav.currentIndex + direction + len) % len; | ||
| } else { | ||
| const matches = computeMatches(scope, term); | ||
| state.matchNav.scope = scope; | ||
| state.matchNav.term = term; | ||
| state.matchNav.matches = matches; | ||
| // Fresh search: forward starts at the first match, backward at the last. | ||
| state.matchNav.currentIndex = matches.length === 0 | ||
| ? -1 | ||
| : (direction === 1 ? 0 : matches.length - 1); | ||
| } | ||
|
|
||
| focusActiveMatch(); | ||
| updateMatchCounterUI(); | ||
| } | ||
|
|
||
| /** | ||
| * Clear match navigation state, e.g. when the filter term or grid data | ||
| * changes outside of an explicit Enter-to-navigate action (sorting, paging, | ||
| * applying a new term) so a stale border/counter isn't left pointing at the | ||
| * wrong cell and the cache is invalidated. | ||
| */ | ||
| export function resetMatchNav() { | ||
| state.matchNav.scope = null; | ||
| state.matchNav.term = null; | ||
| state.matchNav.matches = []; | ||
| state.matchNav.currentIndex = -1; | ||
| document.querySelectorAll('.active-match-cell').forEach(el => el.classList.remove('active-match-cell')); | ||
| updateMatchCounterUI(); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When
applyGlobalFilteris registered as a click event listener onbtnApplyFilter, the browser passes theMouseEventobject as the first argument (direction). This causesdirectionto be an object, leading toNaNwhen performing index calculations innavigateMatches. Additionally, we should defensively check iffilterInputexists and prevent concurrent re-fetches ifstate.isLoadingDatais true.