Skip to content

feat(useDebouncedCallback, useThrottledCallback): wrap any function and return cancel - #614

Open
hyesungoh wants to merge 1 commit into
v1-basefrom
feat/callback-hooks-wrap-functions
Open

hyesungoh wants to merge 1 commit into
v1-basefrom
feat/callback-hooks-wrap-functions

Conversation

@hyesungoh

Copy link
Copy Markdown
Member

Overview

Closes #537

useDebouncedCallback and useThrottledCallback could not replace the deprecated useDebounce and useThrottle, because they forwarded a single value and hid cancel, which the shared implementation already returns.

  • Both hooks now take { callback, debounceMs | throttleMs, leading, trailing } and return the wrapped function with cancel, typed from callback.
  • onChange is renamed to callback. The hooks no longer skip a call that repeats the last forwarded value, so the old name no longer fits, and the rename makes existing calls fail to compile instead of changing behavior silently.
  • The same-value skip moves into useImpressionRef, the only place in the repo that relied on it, so onImpressionStart still fires once when an element leaves and returns before the end is reported. Two regression tests cover this; the existing tests passed without the skip.
  • README examples, docs, translations, skill references and the existing changeset are updated to callback.
// before
const setQueryDebounced = useDebouncedCallback({ onChange: setQuery, debounceMs: 300 });

// after
const setQueryDebounced = useDebouncedCallback({ callback: setQuery, debounceMs: 300 });
setQueryDebounced.cancel();

// replaces useDebounce(search, 300)
const debouncedSearch = useDebouncedCallback({ callback: search, debounceMs: 300 });

flush and isPending are not part of this PR. The return value is a function with methods, so they can be added later in a minor release without breaking calls.

Checklist

  • Did you write the test code?
  • Have you run yarn run fix to format and lint the code and docs?
  • Have you run yarn run test:coverage to make sure there is no uncovered line?
  • Did you write the JSDoc?

@changeset-bot

changeset-bot Bot commented Nov 19, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: fab88bb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
react-simplikit Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

Size Change: -149 B (-0.12%)

Total Size: 127 kB

📦 View Changed
Filename Size Change
packages/react-simplikit/dist/hooks/useDebouncedCallback/useDebouncedCallback.cjs 1.13 kB -22 B (-1.91%)
packages/react-simplikit/dist/hooks/useDebouncedCallback/useDebouncedCallback.mjs 1.11 kB -12 B (-1.07%)
packages/react-simplikit/dist/hooks/useImpressionRef/useImpressionRef.cjs 1.27 kB +7 B (+0.55%)
packages/react-simplikit/dist/hooks/useImpressionRef/useImpressionRef.mjs 1.24 kB +5 B (+0.41%)
packages/react-simplikit/dist/hooks/useThrottledCallback/useThrottledCallback.cjs 964 B -69 B (-6.68%) ✅
packages/react-simplikit/dist/hooks/useThrottledCallback/useThrottledCallback.mjs 946 B -58 B (-5.78%) ✅
ℹ️ View Unchanged
Filename Size
packages/codemod/dist/cli.mjs 6.47 kB
packages/react-simplikit/dist/components/ImpressionArea/ImpressionArea.cjs 1.02 kB
packages/react-simplikit/dist/components/ImpressionArea/ImpressionArea.mjs 988 B
packages/react-simplikit/dist/components/Separated/Separated.cjs 686 B
packages/react-simplikit/dist/components/Separated/Separated.mjs 684 B
packages/react-simplikit/dist/components/SwitchCase/SwitchCase.cjs 778 B
packages/react-simplikit/dist/components/SwitchCase/SwitchCase.mjs 777 B
packages/react-simplikit/dist/hooks/_internal/useDebounce/debounce.cjs 470 B
packages/react-simplikit/dist/hooks/_internal/useDebounce/debounce.mjs 469 B
packages/react-simplikit/dist/hooks/_internal/useDebounce/useDebounce.cjs 653 B
packages/react-simplikit/dist/hooks/_internal/useDebounce/useDebounce.mjs 632 B
packages/react-simplikit/dist/hooks/_internal/useThrottle/throttle.cjs 437 B
packages/react-simplikit/dist/hooks/_internal/useThrottle/throttle.mjs 432 B
packages/react-simplikit/dist/hooks/_internal/useThrottle/useThrottle.cjs 614 B
packages/react-simplikit/dist/hooks/_internal/useThrottle/useThrottle.mjs 594 B
packages/react-simplikit/dist/hooks/useAsyncEffect/useAsyncEffect.cjs 625 B
packages/react-simplikit/dist/hooks/useAsyncEffect/useAsyncEffect.mjs 614 B
packages/react-simplikit/dist/hooks/useAvoidKeyboard/useAvoidKeyboard.cjs 988 B
packages/react-simplikit/dist/hooks/useAvoidKeyboard/useAvoidKeyboard.mjs 966 B
packages/react-simplikit/dist/hooks/useBodyScrollLock/useBodyScrollLock.cjs 975 B
packages/react-simplikit/dist/hooks/useBodyScrollLock/useBodyScrollLock.mjs 951 B
packages/react-simplikit/dist/hooks/useBooleanState/useBooleanState.cjs 594 B
packages/react-simplikit/dist/hooks/useBooleanState/useBooleanState.mjs 586 B
packages/react-simplikit/dist/hooks/useCallbackOnce/useCallbackOnce.cjs 901 B
packages/react-simplikit/dist/hooks/useCallbackOnce/useCallbackOnce.mjs 873 B
packages/react-simplikit/dist/hooks/useCallbackOnce/useCallbackOncePerRender.cjs 197 B
packages/react-simplikit/dist/hooks/useCallbackOnce/useCallbackOncePerRender.mjs 205 B
packages/react-simplikit/dist/hooks/useConditionalEffect/useConditionalEffect.cjs 980 B
packages/react-simplikit/dist/hooks/useConditionalEffect/useConditionalEffect.mjs 959 B
packages/react-simplikit/dist/hooks/useControlledState/useControlledState.cjs 1.04 kB
packages/react-simplikit/dist/hooks/useControlledState/useControlledState.mjs 1.03 kB
packages/react-simplikit/dist/hooks/useCounter/useCounter.cjs 1.08 kB
packages/react-simplikit/dist/hooks/useCounter/useCounter.mjs 1.06 kB
packages/react-simplikit/dist/hooks/useDebounce/useDebounce.cjs 1.14 kB
packages/react-simplikit/dist/hooks/useDebounce/useDebounce.mjs 1.14 kB
packages/react-simplikit/dist/hooks/useDebouncedState/useDebouncedState.cjs 1.2 kB
packages/react-simplikit/dist/hooks/useDebouncedState/useDebouncedState.mjs 1.17 kB
packages/react-simplikit/dist/hooks/useDebouncedValue/useDebouncedValue.cjs 1.22 kB
packages/react-simplikit/dist/hooks/useDebouncedValue/useDebouncedValue.mjs 1.2 kB
packages/react-simplikit/dist/hooks/useDoubleClick/useDoubleClick.cjs 1.11 kB
packages/react-simplikit/dist/hooks/useDoubleClick/useDoubleClick.mjs 1.1 kB
packages/react-simplikit/dist/hooks/useGeolocation/useGeolocation.cjs 2.05 kB
packages/react-simplikit/dist/hooks/useGeolocation/useGeolocation.mjs 2.04 kB
packages/react-simplikit/dist/hooks/useInputState/useInputState.cjs 728 B
packages/react-simplikit/dist/hooks/useInputState/useInputState.mjs 718 B
packages/react-simplikit/dist/hooks/useIntersectionObserver/useIntersectionObserver.cjs 1.11 kB
packages/react-simplikit/dist/hooks/useIntersectionObserver/useIntersectionObserver.mjs 1.08 kB
packages/react-simplikit/dist/hooks/useInterval/useInterval.cjs 791 B
packages/react-simplikit/dist/hooks/useInterval/useInterval.mjs 762 B
packages/react-simplikit/dist/hooks/useIsClient/useIsClient.cjs 585 B
packages/react-simplikit/dist/hooks/useIsClient/useIsClient.mjs 574 B
packages/react-simplikit/dist/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.cjs 646 B
packages/react-simplikit/dist/hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.mjs 642 B
packages/react-simplikit/dist/hooks/useKeyboardHeight/useKeyboardHeight.cjs 736 B
packages/react-simplikit/dist/hooks/useKeyboardHeight/useKeyboardHeight.mjs 717 B
packages/react-simplikit/dist/hooks/useList/useList.cjs 949 B
packages/react-simplikit/dist/hooks/useList/useList.mjs 931 B
packages/react-simplikit/dist/hooks/useLoading/useLoading.cjs 961 B
packages/react-simplikit/dist/hooks/useLoading/useLoading.mjs 953 B
packages/react-simplikit/dist/hooks/useLongPress/useLongPress.cjs 1.83 kB
packages/react-simplikit/dist/hooks/useLongPress/useLongPress.mjs 1.8 kB
packages/react-simplikit/dist/hooks/useMap/useMap.cjs 753 B
packages/react-simplikit/dist/hooks/useMap/useMap.mjs 734 B
packages/react-simplikit/dist/hooks/useNetworkStatus/useNetworkStatus.cjs 1.64 kB
packages/react-simplikit/dist/hooks/useNetworkStatus/useNetworkStatus.mjs 1.62 kB
packages/react-simplikit/dist/hooks/useOutsideClickEffect/useOutsideClickEffect.cjs 810 B
packages/react-simplikit/dist/hooks/useOutsideClickEffect/useOutsideClickEffect.mjs 783 B
packages/react-simplikit/dist/hooks/usePageVisibility/usePageVisibility.cjs 1.31 kB
packages/react-simplikit/dist/hooks/usePageVisibility/usePageVisibility.mjs 1.29 kB
packages/react-simplikit/dist/hooks/usePageVisibilityEffect/usePageVisibilityEffect.cjs 791 B
packages/react-simplikit/dist/hooks/usePageVisibilityEffect/usePageVisibilityEffect.mjs 760 B
packages/react-simplikit/dist/hooks/usePageVisibilityEffect/useVisibilityEvent.cjs 206 B
packages/react-simplikit/dist/hooks/usePageVisibilityEffect/useVisibilityEvent.mjs 211 B
packages/react-simplikit/dist/hooks/usePreservedCallback/usePreservedCallback.cjs 751 B
packages/react-simplikit/dist/hooks/usePreservedCallback/usePreservedCallback.mjs 733 B
packages/react-simplikit/dist/hooks/usePreservedReference/usePreservedReference.cjs 805 B
packages/react-simplikit/dist/hooks/usePreservedReference/usePreservedReference.mjs 789 B
packages/react-simplikit/dist/hooks/usePrevious/usePrevious.cjs 640 B
packages/react-simplikit/dist/hooks/usePrevious/usePrevious.mjs 631 B
packages/react-simplikit/dist/hooks/useRefEffect/useRefEffect.cjs 836 B
packages/react-simplikit/dist/hooks/useRefEffect/useRefEffect.mjs 820 B
packages/react-simplikit/dist/hooks/useSafeAreaInset/useSafeAreaInset.cjs 967 B
packages/react-simplikit/dist/hooks/useSafeAreaInset/useSafeAreaInset.mjs 952 B
packages/react-simplikit/dist/hooks/useScrollDirection/useScrollDirection.cjs 1.32 kB
packages/react-simplikit/dist/hooks/useScrollDirection/useScrollDirection.mjs 1.31 kB
packages/react-simplikit/dist/hooks/useSet/useSet.cjs 1 kB
packages/react-simplikit/dist/hooks/useSet/useSet.mjs 976 B
packages/react-simplikit/dist/hooks/useStorageState/storage.cjs 543 B
packages/react-simplikit/dist/hooks/useStorageState/storage.mjs 527 B
packages/react-simplikit/dist/hooks/useStorageState/useStorageState.cjs 1.63 kB
packages/react-simplikit/dist/hooks/useStorageState/useStorageState.mjs 1.63 kB
packages/react-simplikit/dist/hooks/useThrottle/useThrottle.cjs 782 B
packages/react-simplikit/dist/hooks/useThrottle/useThrottle.mjs 793 B
packages/react-simplikit/dist/hooks/useThrottledState/useThrottledState.cjs 1.19 kB
packages/react-simplikit/dist/hooks/useThrottledState/useThrottledState.mjs 1.17 kB
packages/react-simplikit/dist/hooks/useThrottledValue/useThrottledValue.cjs 1.11 kB
packages/react-simplikit/dist/hooks/useThrottledValue/useThrottledValue.mjs 1.08 kB
packages/react-simplikit/dist/hooks/useTimeout/useTimeout.cjs 688 B
packages/react-simplikit/dist/hooks/useTimeout/useTimeout.mjs 658 B
packages/react-simplikit/dist/hooks/useToggle/useToggle.cjs 524 B
packages/react-simplikit/dist/hooks/useToggle/useToggle.mjs 506 B
packages/react-simplikit/dist/hooks/useVisualViewport/useVisualViewport.cjs 1.5 kB
packages/react-simplikit/dist/hooks/useVisualViewport/useVisualViewport.mjs 1.49 kB
packages/react-simplikit/dist/index.cjs 1.45 kB
packages/react-simplikit/dist/index.mjs 1.05 kB
packages/react-simplikit/dist/utils/buildContext/buildContext.cjs 864 B
packages/react-simplikit/dist/utils/buildContext/buildContext.mjs 844 B
packages/react-simplikit/dist/utils/disableBodyScrollLock/disableBodyScrollLock.cjs 1.02 kB
packages/react-simplikit/dist/utils/disableBodyScrollLock/disableBodyScrollLock.mjs 1.01 kB
packages/react-simplikit/dist/utils/enableBodyScrollLock/enableBodyScrollLock.cjs 939 B
packages/react-simplikit/dist/utils/enableBodyScrollLock/enableBodyScrollLock.mjs 932 B
packages/react-simplikit/dist/utils/getKeyboardHeight/getKeyboardHeight.cjs 609 B
packages/react-simplikit/dist/utils/getKeyboardHeight/getKeyboardHeight.mjs 602 B
packages/react-simplikit/dist/utils/getSafeAreaInset/getSafeAreaInset.cjs 902 B
packages/react-simplikit/dist/utils/getSafeAreaInset/getSafeAreaInset.mjs 893 B
packages/react-simplikit/dist/utils/isAndroid/isAndroid.cjs 543 B
packages/react-simplikit/dist/utils/isAndroid/isAndroid.mjs 534 B
packages/react-simplikit/dist/utils/isIOS/isIOS.cjs 753 B
packages/react-simplikit/dist/utils/isIOS/isIOS.mjs 746 B
packages/react-simplikit/dist/utils/isKeyboardVisible/isKeyboardVisible.cjs 431 B
packages/react-simplikit/dist/utils/isKeyboardVisible/isKeyboardVisible.mjs 419 B
packages/react-simplikit/dist/utils/isServer/isServer.cjs 381 B
packages/react-simplikit/dist/utils/isServer/isServer.mjs 379 B
packages/react-simplikit/dist/utils/mergeProps/mergeProps.cjs 645 B
packages/react-simplikit/dist/utils/mergeProps/mergeProps.mjs 643 B
packages/react-simplikit/dist/utils/mergeRefs/mergeRefs.cjs 790 B
packages/react-simplikit/dist/utils/mergeRefs/mergeRefs.mjs 787 B
packages/react-simplikit/dist/utils/subscribeKeyboardHeight/subscribeKeyboardHeight.cjs 1.17 kB
packages/react-simplikit/dist/utils/subscribeKeyboardHeight/subscribeKeyboardHeight.mjs 1.16 kB

compressed-size-action

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (30b781d) to head (fab88bb).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           v1-base      #614   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           76        76           
  Lines         2447      2423   -24     
  Branches       790       785    -5     
=========================================
- Hits          2447      2423   -24     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@hyesungoh
hyesungoh marked this pull request as ready for review November 19, 2026 06:21
@hyesungoh
hyesungoh requested a review from mnxmnz as a code owner November 19, 2026 06:21

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants