Skip to content

Commit d60ec6f

Browse files
authored
Merge pull request #3522 from solidjs/fix/delegated-event-key
fix(web): move delegated event handlers off the Solid 1 `$$<type>` key
2 parents 7624320 + 6d2bdeb commit d60ec6f

21 files changed

Lines changed: 309 additions & 48 deletions

File tree

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
"@solidjs/web": patch
3+
"@solidjs/babel-plugin": patch
4+
"@solidjs/compiler": patch
5+
---
6+
7+
Move delegated event handlers off the `$$<type>` element key Solid 1 uses.
8+
9+
Solid 1 delegates from `document` and fires any `$$click`/`$$input`/… it finds while walking up from the target, so a 1.x runtime on the same page — an older embedded widget, a devtools panel built on 1.x — ran every delegated handler in a 2.x app a second time. Compiled output and the runtime now stamp `_$$<type>` / `_$$<type>Data` instead; neither version can see the other's handlers, in either nesting direction.
10+
11+
The key, the `_$SOLID_EVENT_OWNER` mark, and the walk rules are documented in `client.ts` as the delegated-event wire contract shared by every Solid copy on a page. Anything reading `el.$$click` directly must switch to `el._$$click`.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ function Counter() {
6060

6161
return (() => {
6262
const _el$ = _tmpl$();
63-
_el$.$$click = () => setCount(c => c + 1);
63+
_el$._$$click = () => setCount(c => c + 1);
6464
insert(_el$, doubled);
6565
return _el$;
6666
})();

‎packages/babel-plugin/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ const view = ({ item }) => {
5656
_el$5 = _el$3.nextSibling,
5757
_el$6 = _el$5.firstChild;
5858
_$insert(_el$2, itemId);
59-
_el$4.$$click = e => select(item, e);
59+
_el$4._$$click = e => select(item, e);
6060
_$insert(_el$4, () => item.label);
61-
_el$6.$$click = e => del(item, e);
61+
_el$6._$$click = e => del(item, e);
6262
_$effect(
6363
() => selected(),
6464
_v$ => _$className(_el$, itemId === _v$ ? "danger" : "")

‎packages/babel-plugin/src/dom/element.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1059,7 +1059,7 @@ function transformAttributes(
10591059
t.expressionStatement(
10601060
t.assignmentExpression(
10611061
"=",
1062-
t.memberExpression(elem, t.identifier(`$$${ev}Data`)),
1062+
t.memberExpression(elem, t.identifier(`_$$${ev}Data`)),
10631063
handler.elements[1] as babelTypes.Expression
10641064
)
10651065
)
@@ -1070,7 +1070,7 @@ function transformAttributes(
10701070
t.expressionStatement(
10711071
t.assignmentExpression(
10721072
"=",
1073-
t.memberExpression(elem, t.identifier(`$$${ev}`)),
1073+
t.memberExpression(elem, t.identifier(`_$$${ev}`)),
10741074
handler
10751075
)
10761076
)
@@ -1080,7 +1080,7 @@ function transformAttributes(
10801080
t.expressionStatement(
10811081
t.assignmentExpression(
10821082
"=",
1083-
t.memberExpression(elem, t.identifier(`$$${ev}`)),
1083+
t.memberExpression(elem, t.identifier(`_$$${ev}`)),
10841084
handler
10851085
)
10861086
)

‎packages/babel-plugin/test/__dom_fixtures__/eventExpressions/output.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ _el$3.addEventListener("change", e => (id => console.log("bound", id))(id, e));
2828
_$addEvent(_el$4, "change", handler);
2929
_el$5.addEventListener("change", handler);
3030
_el$6.addEventListener("change", hoisted1);
31-
_el$7.$$click = () => console.log("delegated");
32-
_el$8.$$click = id => console.log("delegated", id);
33-
_el$8.$$clickData = rowId;
31+
_el$7._$$click = () => console.log("delegated");
32+
_el$8._$$click = id => console.log("delegated", id);
33+
_el$8._$$clickData = rowId;
3434
_$addEvent(_el$9, "click", handler, true);
35-
_el$0.$$click = handler;
36-
_el$1.$$click = hoisted2;
35+
_el$0._$$click = handler;
36+
_el$1._$$click = hoisted2;
3737
const template = _el$;
3838
_$delegateEvents(["click"]);

‎packages/babel-plugin/test/__dom_fixtures__/jsxAttributeValues/output.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ _$effect(
6060
);
6161
const multiValues = _el$4;
6262
var _el$5 = _tmpl$3();
63-
_el$5.$$click = () => mount(_tmpl$7());
63+
_el$5._$$click = () => mount(_tmpl$7());
6464
const handlerValue = _el$5;
6565
var _el$6 = _tmpl$2();
6666
_$ref(() => el => el.appendChild(_tmpl$8()), _el$6);

‎packages/babel-plugin/test/__dom_hydratable_fixtures__/eventExpressions/output.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ var _el$ = _$getNextElement(_tmpl$),
1616
_el$5 = _el$4.nextSibling;
1717
_el$2.addEventListener("change", () => console.log("bound"));
1818
_el$3.addEventListener("change", e => (id => console.log("bound", id))(id, e));
19-
_el$4.$$click = () => console.log("delegated");
20-
_el$5.$$click = id => console.log("delegated", id);
21-
_el$5.$$clickData = rowId;
19+
_el$4._$$click = () => console.log("delegated");
20+
_el$5._$$click = id => console.log("delegated", id);
21+
_el$5._$$clickData = rowId;
2222
_$runHydrationEvents();
2323
const template = _el$;
2424
_$delegateEvents(["click"]);

‎packages/babel-plugin/test/__dom_hydratable_fixtures__/jsxAttributeValues/output.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ _$effect(
6262
);
6363
const multiValues = _el$4;
6464
var _el$5 = _$getNextElement(_tmpl$3);
65-
_el$5.$$click = () => mount(_$getNextElement(_tmpl$7));
65+
_el$5._$$click = () => mount(_$getNextElement(_tmpl$7));
6666
_$runHydrationEvents();
6767
const handlerValue = _el$5;
6868
var _el$6 = _$getNextElement(_tmpl$2);

‎packages/babel-plugin/test/__dynamic_fixtures__/eventExpressions/output.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ _el$3.addEventListener("change", e => (id => console.log("bound", id))(id, e));
2424
_$addEvent(_el$4, "change", handler);
2525
_el$5.addEventListener("change", handler);
2626
_el$6.addEventListener("change", hoisted1);
27-
_el$7.$$click = () => console.log("delegated");
28-
_el$8.$$click = id => console.log("delegated", id);
29-
_el$8.$$clickData = rowId;
27+
_el$7._$$click = () => console.log("delegated");
28+
_el$8._$$click = id => console.log("delegated", id);
29+
_el$8._$$clickData = rowId;
3030
_$addEvent(_el$9, "click", handler, true);
31-
_el$0.$$click = handler;
32-
_el$1.$$click = hoisted2;
31+
_el$0._$$click = handler;
32+
_el$1._$$click = hoisted2;
3333
const template = _el$;
3434
_$delegateEvents(["click"]);

‎packages/babel-plugin/test/__tsrx_dom_fixtures__/keyedAccessorEdges/output.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export function Rows({ rows }) {
2020
var _el$2 = _tmpl$2(),
2121
_el$3 = _el$2.firstChild,
2222
_el$4 = _el$3.nextSibling;
23-
_el$2.$$click = () => preserve("local", 0);
23+
_el$2._$$click = () => preserve("local", 0);
2424
_$insert(_el$2, () => row().name, _el$3);
2525
_$insert(_el$2, index, _el$4);
2626
_$effect(

0 commit comments

Comments
 (0)