-
-
Notifications
You must be signed in to change notification settings - Fork 728
Add fuzzy matching to the tasks filter #1960
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
matt-aitken
merged 4 commits into
triggerdotdev:main
from
myftija:fuzzy-searching-tasks-list
Apr 22, 2025
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
2d5cdad
Add a custom react hook to enable fuzzy searching in item lists
myftija e2ddbe0
Use fuzzy filtering in the tasks view list
myftija 2128398
Use fuzzy filtering in the test tasks list
myftija 5530f69
Remove the old tasks filtering react hook
myftija File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,61 @@ | ||
import { useMemo, useState } from "react"; | ||
import { matchSorter } from "match-sorter"; | ||
|
||
/** | ||
* A hook that provides fuzzy filtering functionality for a list of objects. | ||
* Uses match-sorter to perform the filtering across multiple object properties and | ||
* consistently order the results by score. | ||
* | ||
* @param params - The parameters object | ||
* @param params.items - Array of objects to filter | ||
* @param params.keys - Array of object keys to perform the fuzzy search on | ||
* @returns An object containing: | ||
* - filterText: The current filter text | ||
* - setFilterText: Function to update the filter text | ||
* - filteredItems: The filtered array of items based on the current filter text | ||
* | ||
* @example | ||
* ```tsx | ||
* const users = [{ name: "John", email: "[email protected]" }]; | ||
* const { filterText, setFilterText, filteredItems } = useFuzzyFilter({ | ||
* items: users, | ||
* keys: ["name", "email"] | ||
* }); | ||
* ``` | ||
*/ | ||
export function useFuzzyFilter<T extends Object>({ | ||
items, | ||
keys, | ||
}: { | ||
items: T[]; | ||
keys: Extract<keyof T, string>[]; | ||
}) { | ||
const [filterText, setFilterText] = useState(""); | ||
|
||
const filteredItems = useMemo<T[]>(() => { | ||
const filterTerms = filterText | ||
.trim() | ||
.split(" ") | ||
.map((term) => term.trim()) | ||
.filter((term) => term !== ""); | ||
|
||
if (filterTerms.length === 0) { | ||
return items; | ||
} | ||
|
||
// sort by the score of the first term | ||
return filterTerms.reduceRight( | ||
(results, term) => | ||
matchSorter(results, term, { | ||
keys, | ||
}), | ||
items | ||
); | ||
}, [items, filterText]); | ||
|
||
return { | ||
filterText, | ||
setFilterText, | ||
filteredItems, | ||
}; | ||
} |
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
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.
Uh oh!
There was an error while loading. Please reload this page.