types(useEventListener): fix typos #4787
Open
+71
−5
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
() => void with Fn
Alfred-Skyblue
previously approved these changes
May 29, 2025
() => void with Fn
43081j
reviewed
Jun 1, 2025
| @@ -64,10 +67,10 @@ export function useEventListener<E extends keyof WindowEventMap>( | |||
| * @param listener | |||
| * @param options | |||
| */ | |||
| export function useEventListener<E extends keyof DocumentEventMap>( | |||
| export function useEventListener<E extends keyof DocumentOrShadowRootEventMap>( | |||
There was a problem hiding this comment.
I wonder if this should be two overloads instead. otherwise this means we can add shadow root event listeners to a document
something like:
function useEventListener<E extends keyof DocumentEventMap>(
target: Document,
event: MaybeRefOrGetter<Arrayable<E>>,
listener: MaybeRef<Arrayable<(this: Document, ev: DocumentEventMap[E]) => any>>,
options?: MaybeRefOrGetter<boolean | AddEventListenerOptions>
): Fn;
function useEventListener<E extends keyof ShadowRootEventMap>(
target: ShadowRoot,
event: MaybeRefOrGetter<Arrayable<E>>,
listener: MaybeRef<Arrayable<(this: ShadowRoot, ev: DocumentEventMap[E]) => any>>,
options?: MaybeRefOrGetter<boolean | AddEventListenerOptions>
): Fn;
function useEventListener<E extends keyof DocumentOrShadowRootEventMap>(
target: DocumentOrShadowRoot,
event: MaybeRefOrGetter<Arrayable<E>>,
listener: MaybeRef<Arrayable<(this: DocumentOrShadowRoot, ev: DocumentEventMap[E]) => any>>,
options?: MaybeRefOrGetter<boolean | AddEventListenerOptions>
): Fn {
// implementation
}that also means the this of the event listener will be correctly typed
There was a problem hiding this comment.
I think we need a mixture of both
#4788 is what I was describing, but should be using the shadow root event map
There was a problem hiding this comment.
function useEventListener<E extends keyof DocumentEventMap>(
target: Document,
event: MaybeRefOrGetter<Arrayable<E>>,
listener: MaybeRef<Arrayable<(this: Document, ev: DocumentEventMap[E]) => any>>,
options?: MaybeRefOrGetter<boolean | AddEventListenerOptions>
): Fn;
function useEventListener<E extends keyof ShadowRootEventMap>(
target: ShadowRoot,
event: MaybeRefOrGetter<Arrayable<E>>,
listener: MaybeRef<Arrayable<(this: ShadowRoot, ev: DocumentEventMap[E]) => any>>,
options?: MaybeRefOrGetter<boolean | AddEventListenerOptions>
): Fn;
removed DocumentOrShadowRootEventMap and relatived defination
There was a problem hiding this comment.
maybe ShadowRoot is enough for this
There was a problem hiding this comment.
hi, we share the same view. You can take a look at my pr. I think the most important thing is "this" in the listener. Because shadowRoot has attributes that other nodes do not have.such as host,mode.
43081j
previously approved these changes
Jun 3, 2025
43081j
reviewed
Jun 4, 2025
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
Additional context