diff --git a/.changeset/hip-shoes-show.md b/.changeset/hip-shoes-show.md new file mode 100644 index 00000000..4edab412 --- /dev/null +++ b/.changeset/hip-shoes-show.md @@ -0,0 +1,5 @@ +--- +'react-simplikit': patch +--- + +docs: Add generic type support to useRefEffect interface diff --git a/packages/core/src/hooks/useRefEffect/ko/useRefEffect.md b/packages/core/src/hooks/useRefEffect/ko/useRefEffect.md index 036d7e0c..b058db4c 100644 --- a/packages/core/src/hooks/useRefEffect/ko/useRefEffect.md +++ b/packages/core/src/hooks/useRefEffect/ko/useRefEffect.md @@ -5,10 +5,10 @@ ## 인터페이스 ```ts -function useRefEffect( - callback: (element: Element) => CleanupCallback | void, +function useRefEffect( + callback: (element: RefElement) => CleanupCallback | void, deps: DependencyList -): (element: Element | null) => void; +): (element: RefElement | null) => void; ``` ### 파라미터 @@ -16,7 +16,7 @@ function useRefEffect( @@ -31,7 +31,7 @@ function useRefEffect( diff --git a/packages/core/src/hooks/useRefEffect/useRefEffect.md b/packages/core/src/hooks/useRefEffect/useRefEffect.md index 78abbff6..62c1725c 100644 --- a/packages/core/src/hooks/useRefEffect/useRefEffect.md +++ b/packages/core/src/hooks/useRefEffect/useRefEffect.md @@ -5,10 +5,10 @@ ## Interface ```ts -function useRefEffect( - callback: (element: Element) => CleanupCallback | void, +function useRefEffect( + callback: (element: RefElement) => CleanupCallback | void, deps: DependencyList -): (element: Element | null) => void; +): (element: RefElement | null) => void; ``` ### Parameters @@ -16,7 +16,7 @@ function useRefEffect( @@ -31,7 +31,7 @@ function useRefEffect( diff --git a/packages/core/src/hooks/useRefEffect/useRefEffect.ts b/packages/core/src/hooks/useRefEffect/useRefEffect.ts index 065331d9..2a67cded 100644 --- a/packages/core/src/hooks/useRefEffect/useRefEffect.ts +++ b/packages/core/src/hooks/useRefEffect/useRefEffect.ts @@ -9,10 +9,10 @@ export type CleanupCallback = () => void; * `useRefEffect` is a React hook that helps you set a reference to a specific DOM element and execute a callback whenever the element changes. * This hook calls a cleanup function whenever the element changes to prevent memory leaks. * - * @param {(element: Element) => CleanupCallback | void} callback - A callback function that is executed when the element is set. This function can return a cleanup function. + * @param {(element: RefElement) => CleanupCallback | void} callback - A callback function that is executed when the element is set. This function can return a cleanup function. * @param {DependencyList} deps - An array of dependencies that define when the callback should be re-executed. The `callback` is re-executed whenever the `deps` change. * - * @returns {(element: Element | null) => void} A function to set the element. Pass this function to the `ref` attribute, and the `callback` will be called whenever the element changes. + * @returns {(element: RefElement | null) => void} A function to set the element. Pass this function to the `ref` attribute, and the `callback` will be called whenever the element changes. * * @example * import { useRefEffect } from 'react-simplikit'; @@ -29,15 +29,15 @@ export type CleanupCallback = () => void; * return
Basic Example
; * } */ -export function useRefEffect( - callback: (element: Element) => CleanupCallback | void, +export function useRefEffect( + callback: (element: RefElement) => CleanupCallback | void, deps: DependencyList -): (element: Element | null) => void { +): (element: RefElement | null) => void { const preservedCallback = usePreservedCallback(callback); const cleanupCallbackRef = useRef(() => {}); const effect = useCallback( - (element: Element | null) => { + (element: RefElement | null) => { cleanupCallbackRef.current(); cleanupCallbackRef.current = () => {};