docs(upgrade): document event attributes, signal widening, testing and devInput changes - #8889
Open
c0deZ3R0 wants to merge 3 commits into
Open
docs(upgrade): document event attributes, signal widening, testing and devInput changes#8889c0deZ3R0 wants to merge 3 commits into
c0deZ3R0 wants to merge 3 commits into
Conversation
…d devInput changes Fill v1->v2 migration guide gaps that produce no build-time signal: renamed event attributes (q-e:/q-d:/q-w: plus passive variants) and the colon-in-event-name pitfall, the wider Signal type and ReadonlySignal deprecation, null event.target under trigger() in tests, and the removal of client.devInput. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
c0deZ3R0
marked this pull request as ready for review
July 31, 2026 14:02
wmertens
reviewed
Jul 31, 2026
wmertens
left a comment
wmertens
left a comment
Member
There was a problem hiding this comment.
Looking good but let's fix the selector bug first
| The event name itself is still lowercased unless you opt into case sensitivity with a leading `-`, but v2 adds two rules: `--` is a literal `-` (`dbl--click` → `dbl-click`), and `DOMContentLoaded` is stored as `-d-o-m-content-loaded`. | ||
|
|
||
| <Note title="COLONS IN CUSTOM EVENT NAMES"> | ||
| Don't put a `:` inside a custom event name (`useOnDocument('my:event', ...)`). The name becomes part of an attribute selector and an unescaped colon makes it invalid CSS. Use a camelCase name instead (`useOnDocument('myEvent', ...)` → `q-d:my-event`). |
Member
There was a problem hiding this comment.
I guess this one is just a bug in the selector creating, so we shouldn't document it
Contributor
Author
…tead Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ade-guide-gaps # Conflicts: # packages/docs/src/routes/docs/upgrade/index.mdx
@qwik.dev/core
@qwik.dev/router
eslint-plugin-qwik
create-qwik
@qwik.dev/optimizer
@qwik.dev/devtools
commit: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Overview
Documents v1 → v2 changes missing from the upgrade guide. None of these produce a build-time signal, so they surface as runtime or test failures.
What is it?
Description
Behavioral Changes
on:/on-document:/on-window:→ v2q-e:/q-d:/q-w:, plus new passive variants (q-ep:/q-dp:/q-wp:), the--escape andDOMContentLoadedrules, and a note warning against:inside custom event names (produces an invalid attribute selector that throws on dispatch)Signal<T>addsuntrackedValueandtrigger(), so{ value }shims no longer type-check; points at the publiccreateSignal()qwikVite()optionsDeprecated APIs
ReadonlySignal→Readonly<Signal<T>>New Tests section
event.targetis null undertrigger()— use the element argumentq:container— create a fresh DOM per testtrigger()returns theEventand accepts{ waitForIdle }Troubleshooting — three new entries keyed to the error messages, cross-linked to the sections above.
All claims verified against v2 source (
event-names.ts,signal.public.ts,element-fixture.ts,dom-render.ts,vite.ts) and thev1branch.Checklist
🤖 Generated with Claude Code