[@mantine/hooks] use-debounced-callback: Fix leading edge behavior to… #8021
Conversation
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
… suppress trailing execution (mantinedev#7917) - Fix leading=true to execute only immediately without trailing execution - Previously leading=true would execute immediately + after delay (incorrect) - Now leading=true executes immediately, ignores subsequent calls during delay - Leading state resets after delay period for next immediate execution - Update tests to reflect correct behavior expectations - Maintain flush() and cancel() method functionality - All existing tests pass with corrected behavior Resolves issue where users expected leading=true to suppress trailing execution but callback was being invoked again after the delay period
76bd996 to
1c631ef
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the behavior of useDebouncedCallback when leading: true so that the callback only fires immediately and never again after the delay period.
- Refactored callback logic to separate “first” and “subsequent” leading-edge branches and suppress trailing invocations
- Introduced
clearTimeoutAndLeadingRef()helper and reorganizedflush/cancelassignment - Updated and added tests to assert no trailing execution when
leading: true
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/@mantine/hooks/src/use-debounced-callback/use-debounced-callback.ts | Reworked leading/tailing branches, added helper, and adjusted timers |
| packages/@mantine/hooks/src/use-debounced-callback/use-debounced-callback.test.ts | Updated existing tests and added new scenario to verify suppression of trailing calls |
Comments suppressed due to low confidence (3)
packages/@mantine/hooks/src/use-debounced-callback/use-debounced-callback.ts:40
- [nitpick] The definitions of
flushandcancelare duplicated across the leading and trailing branches. Consider extracting these into shared helpers to reduce code duplication and simplify the flow.
if (leading && isFirstCall) {
packages/@mantine/hooks/src/use-debounced-callback/use-debounced-callback.ts:34
- [nitpick] The name
clearTimeoutAndLeadingRefis quite long and mixes concerns. Renaming it to something likeresetDebounceStateorresetLeadingStatecould improve clarity.
function clearTimeoutAndLeadingRef() {
packages/@mantine/hooks/src/use-debounced-callback/use-debounced-callback.test.ts:337
- Consider adding tests for the
flush()andcancel()methods whenleading: trueto ensure they invoke or suppress the callback correctly under various timing scenarios.
it('leading=true should suppress trailing execution', () => {
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #7917
Resolves issue where users expected leading=true to suppress trailing
execution but callback was being invoked again after the delay period