-
Notifications
You must be signed in to change notification settings - Fork 3
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
Fix generics inference of useFilter #285
Merged
+68
−64
Merged
Changes from 2 commits
Commits
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 contains 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 @@ | ||
export * from './useFilter' |
This file contains 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 { useDebounce } from '@aboutbits/react-toolbox' | ||
import { ChangeEventHandler, useEffect, useMemo, useRef, useState } from 'react' | ||
|
||
export type FilterOptions = { | ||
/** Whether to debounce and the debounce interval in milliseconds. | ||
* If `true`, the debounce interval defaults to 200 ms. | ||
* If a positive `number`, the given debounce interval is used. | ||
* If otherwise, the debounce interval defaults to 0 ms. | ||
*/ | ||
debounce?: true | number | ||
} | ||
|
||
export function useFilter<TElement extends HTMLElement & { value: unknown }>() { | ||
return function useCurryingFilter<TValue extends TElement['value']>( | ||
value: TValue, | ||
setValue: (v: TValue) => void, | ||
options?: FilterOptions, | ||
) { | ||
const debounceInterval = useMemo(() => { | ||
if (options?.debounce === true) { | ||
return 200 | ||
} | ||
if (options?.debounce !== undefined && options.debounce > 0) { | ||
return options.debounce | ||
} | ||
return 0 | ||
}, [options?.debounce]) | ||
const elementRef = useRef<TElement>(null) | ||
|
||
const settingNewValueRef = useRef(false) | ||
|
||
const [internalValue, setInternalValue] = useState(value) | ||
const debouncedInternalValue = useDebounce(internalValue, debounceInterval) | ||
const oldDebouncedInternalValueRef = useRef<TValue>() | ||
|
||
useEffect(() => { | ||
// Check that the debounced value is new, because `setValue` might not be reference stable and trigger this effect even though the debounced value did not change | ||
if (debouncedInternalValue !== oldDebouncedInternalValueRef.current) { | ||
oldDebouncedInternalValueRef.current = debouncedInternalValue | ||
setValue(debouncedInternalValue) | ||
settingNewValueRef.current = false | ||
} | ||
}, [debouncedInternalValue, setValue]) | ||
|
||
useEffect(() => { | ||
if (elementRef.current && !settingNewValueRef.current) { | ||
elementRef.current.value = value | ||
} | ||
}, [value]) | ||
|
||
const onChange: ChangeEventHandler<TElement> = (e) => { | ||
settingNewValueRef.current = true | ||
setInternalValue(e.target.value as TValue) | ||
} | ||
|
||
return { | ||
ref: elementRef, | ||
onChange, | ||
} | ||
} | ||
} |
This file contains 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 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 was deleted.
Oops, something went wrong.
This file contains 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
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.
TBH, I prefer the previous notation. Is this necessary for correct type inference? Is there no other way?
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.
I couldn't find another way for correct type inference. I am open to suggestions
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.
Currying allows us to specify
TElement
but still inferringTValue
correctly