fix(onClickOutside): the order of overload signatures #4839
+22
−17
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
dosubot
bot
added
the
size:S
cszhjh
reviewed
Jun 26, 2025
Comment on lines
62
to
67
| export function onClickOutside( | ||
| target: MaybeElementRef, | ||
| handler: OnClickOutsideHandler<{ detectIframe: OnClickOutsideOptions['detectIframe'], controls: true }>, | ||
| options: OnClickOutsideOptions<true>, | ||
| ): { stop: Fn, cancel: Fn, trigger: (event: Event) => void } | ||
|
|
There was a problem hiding this comment.
Would you be able to assist with solving this kind of type inference issue as well? I’d really appreciate it!
onClickOutside(document.documentElement, (e) => {
// Currently, the type of e is `Event | PointerEvent`
// The correct type should be `Event | PointerEvent | FocusEvent`.
}, {
controls: true,
detectIframe: true
})There was a problem hiding this comment.
ok. i'll see what i can do.
There was a problem hiding this comment.
I had to add stricter overloads for the handler.
dosubot
bot
added
size:M
ilyaliao
reviewed
Jun 28, 2025
There was a problem hiding this comment.
Should we change it like this?
-export interface OnClickOutsideOptions<Controls extends boolean = false> extends ConfigurableWindow {
+export interface OnClickOutsideOptions<Controls extends boolean = false, DetectIframe extends boolean = false> extends ConfigurableWindow {
// ...
- detectIframe?: boolean
+ detectIframe?: DetectIframe
// ...
}
|
i think you could simplify this to two overloads 👀 you only need to know what so we could instead do something like this: export function onClickOutside<
T extends OnClickOutsideOptions<true>
>(
target: MaybeElementRef,
handler: OnClickOutsideHandler<T>,
options: T
): Controls;
export function onClickOutside<
T extends OnClickOutsideOptions<false>
>(
target: MaybeElementRef,
handler: OnClickOutsideHandler<T>,
options: T
): Fn;and export type OnClickOutsideHandler<
TControls extends boolean, // may not be needed? may be able to just do `<boolean>` below
T extends OnClickOutsideOptions<TControls>
> = (
event: (T['detectIframe'] extends true ? FocusEvent : never)
| (T['controls'] extends true ? Event : never)
| PointerEvent,
) => void |
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.
Before submitting the PR, please make sure you do the following
fixes #123).Description
Fixes #4838.
The order of Overload Signatures has been changed.
Additional context