Skip to content
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
merged 3 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/components/filter/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './useFilter'
61 changes: 61 additions & 0 deletions src/components/filter/useFilter.ts
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,
}
}
}
1 change: 1 addition & 0 deletions src/components/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ export * from './react-hook-form'
export * from './section'
export * from './tabs'
export * from './types'
export * from './filter'
export * from './util'
1 change: 0 additions & 1 deletion src/components/util/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ export * from './useHandleRequest'
export * from './useId'
export * from './useScrollToElementOnFristRender'
export * from './useBackNavigation'
export * from './useFilter'
58 changes: 0 additions & 58 deletions src/components/util/useFilter.ts

This file was deleted.

10 changes: 5 additions & 5 deletions src/examples/List.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ import {
SelectField,
Tone,
Option,
useFilter,
SearchField,
} from '../components'
import { SearchField } from '../components/form/SearchField'
import { useFilter } from '../components/util/useFilter'

const meta = {
component: SectionContentList,
Expand Down Expand Up @@ -116,7 +116,7 @@ export const ListWithFilter: Story = () => {
(filter.role === '' || item.role === filter.role) &&
(filter.department === '' || item.department === filter.department),
)
const searchFilterProps = useFilter<HTMLInputElement>(
const searchFilterProps = useFilter<HTMLInputElement>()(
Copy link
Contributor

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?

Copy link
Contributor Author

@devgioele devgioele Sep 19, 2023

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

Copy link
Contributor Author

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 inferring TValue correctly

filter.search,
(v) => {
setFilter((prevFilter) => ({ ...prevFilter, search: v }))
Expand All @@ -125,10 +125,10 @@ export const ListWithFilter: Story = () => {
debounce: true,
},
)
const roleFilterProps = useFilter<HTMLSelectElement>(filter.role, (v) => {
const roleFilterProps = useFilter<HTMLSelectElement>()(filter.role, (v) => {
setFilter((prevFilter) => ({ ...prevFilter, role: v }))
})
const departmentFilterProps = useFilter<HTMLSelectElement>(
const departmentFilterProps = useFilter<HTMLSelectElement>()(
filter.department,
(v) => {
setFilter((prevFilter) => ({ ...prevFilter, department: v }))
Expand Down