fix(v2): use on events fixes #6711
Merged
Conversation
This file contains 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
|
Varixo
commented
Jul 19, 2024
Comment on lines
+182
to
+185
| } else if (isPromise(jsx)) { | ||
| return maybeThen<JSXOutput, JSXNode<string> | null>(jsx, (jsx) => findFirstStringJSX(jsx)); | ||
| } else if (isSignal(jsx)) { | ||
| return findFirstStringJSX(untrack(() => jsx.value as JSXOutput)); |
There was a problem hiding this comment.
This is the important change. We could get the jsx from a promise or a signal value, so we need to check if the returned value is a JSXNode.
Varixo
commented
Jul 19, 2024
Comment on lines
+148
to
+154
| } else if (isDev) { | ||
| logWarn( | ||
| 'You are trying to add an event using `useOn` hook, ' + | ||
| 'but a node to which you can add an event is not found. ' + | ||
| 'Please make sure that the component has a valid element node. ' | ||
| ); | ||
| } |
There was a problem hiding this comment.
I have added a warning message for dev mode if someone is trying to use useOn hook on the invisible component. We can't handle that, because we don't have any element node to add an event to.
Varixo
commented
Jul 19, 2024
Comment on lines
+123
to
169
| /** | ||
| * This hook is like the `useSequentialScope` but it is specifically for `useOn`. This is needed | ||
| * because we want to execute the `useOn` hooks only once and store the event listeners on the host | ||
| * element. From Qwik V2 the component is rerunning when the promise is thrown, so we need to make | ||
| * sure that the event listeners are not added multiple times. | ||
| * | ||
| * - The event listeners are stored in the `USE_ON_LOCAL` property. | ||
| * - The `USE_ON_LOCAL_SEQ_IDX` is used to keep track of the index of the hook that calls this. | ||
| * - The `USE_ON_LOCAL_FLAGS` is used to keep track of whether the event listener has been added or | ||
| * not. | ||
| */ | ||
| const useOnEventsSequentialScope = () => { | ||
| const iCtx = useInvokeContext(); | ||
| const hostElement = iCtx.$hostElement$; | ||
| const host: HostElement = hostElement as any; | ||
| let onMap = iCtx.$container2$.getHostProp<UseOnMap>(host, USE_ON_LOCAL); | ||
| if (onMap === null) { | ||
| onMap = {}; | ||
| iCtx.$container2$.setHostProp(host, USE_ON_LOCAL, onMap); | ||
| } | ||
| let seqIdx = iCtx.$container2$.getHostProp<number>(host, USE_ON_LOCAL_SEQ_IDX); | ||
| if (seqIdx === null) { | ||
| seqIdx = 0; | ||
| } | ||
| iCtx.$container2$.setHostProp(host, USE_ON_LOCAL_SEQ_IDX, seqIdx + 1); | ||
| let addedFlags = iCtx.$container2$.getHostProp<boolean[]>(host, USE_ON_LOCAL_FLAGS); | ||
| if (addedFlags === null) { | ||
| addedFlags = []; | ||
| iCtx.$container2$.setHostProp(host, USE_ON_LOCAL_FLAGS, addedFlags); | ||
| } | ||
| while (addedFlags.length <= seqIdx) { | ||
| addedFlags.push(false); | ||
| } | ||
| const addEvent = (eventName: string, eventQrl: EventQRL<KnownEventNames>) => { | ||
| addedFlags[seqIdx] = true; | ||
| let events = onMap![eventName]; | ||
| if (!events) { | ||
| onMap![eventName] = events = []; | ||
| } | ||
| events.push(eventQrl); | ||
| }; | ||
|
|
||
| return { | ||
| isAdded: addedFlags[seqIdx], | ||
| addEvent, | ||
| }; | ||
| }; |
There was a problem hiding this comment.
Does anyone has any better idea?
mhevery
approved these changes
Jul 19, 2024
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.
This PR fixes few edge cases for the
useOnhook