fix: don't set idl on custom elements that are interested in the corresponding content attribute

[hesxenon]

No description provided.

[hesxenon]

On the contrary - preact is breaking things now because it guesses what the user wants now. It presumes that when I write web components I want preact to take care of the IDL side of things only, which is not what I want when I put a (content) attribute name into the observedAttributes array. This array is by definition there to inform the browser that you are interested in changes to these content attributes and in combination with the MDN glossary on IDL this means (as I understood it) that the IDL attribute should reflect the content attribute, not the other way around. In other words:

class MyCustomElement extends HTMLElement {
  static observedAttributes = ["href", "disabled", "foobar"];
  
  href;

  disabled;
  
  foobar;

  connectedCallback() {
    console.log(this.href, this.disabled, this.fobar);
  }
}
customElements.define("my-custom-element", MyCustomElement);

// render with preact
<my-custom-element href="/some/url" disabled foobar="bazqux"></my-custom-element>

will (confusingly) lead to the following HTML:

<my-custom-element href="/some/url"></my-custom-element>

but it will log all three properties.

This is also out of line with the following example

// given this element in the dom
<input value="foo" />

const input = document.querySelector("input")
input.value = "bar"
console.log(input.value, input.getAttribute("value")) // logs bar, foo, since IDL doesn't update content on purpose

Long story short: the current behaviour of preact breaks webcomponents that try to follow IDL and Content rules. This PR would fix that. Components that currently indicate they are interested in an attribute by specifying its name in observed Attributes that then expect this attribute to be treated like a prop are, well... let's say they're a mystery to me and imho they're going against the spec.

Btw, wouldn't the current behaviour also mean that e.g. stenciljs components that define

@property({
  reflect: false // the default
})
someProp

would "break" in the sense that checks for the content attribute someProp would fail? Those could be either done with getAttribute from JS or, probably more importantly, from CSS - meaning that styling that relies on the content attribute would fail because of preacts assumptions?

[hesxenon]

Converted to draft because regardless of the outcome tests are still missing

[hesxenon]

preact is a js framework

and how many users do you know that even know about the IDL vs. Content gap? I'd say preact is primarily seen as a "rendering soluition" and falling into the mentioned gap while the MDN docs explicitly mention observedAttributes as a way to well, observe attributes shouldn't just be dismissed by saying "js (IDL) first, tough luck" imho 😅.

My point is (and that's what that example was supposed to show) that there is also a gap between content and IDL and that's by design and should be taken into consideration by webcomponent authors following "existing rules". And following those rules leads to incompatibilities with preact (and react for that matter) which basically leads to "you can use preact/react as long as you stay in the ecosystem" all while stating "we're closer to the platform than the rest".

[hesxenon]

and pretending it doesn't exist doesn't help anyone.

sad but true

we're not web components

true, but you claim to be compatible with webcomponents by staying closer to the platform - which webcomponents can I use with preact with this behaviour then that aren't also written with preact/react in mind (which is the antithesis to webcomponents...)?

use a workaround

I'd be happy to know which workaround this could be?

perf and size

This one line shouldn't break perf and surely doesn't break size? And it shouldn't break existing projects since for those to break they'd have to use webcomponents that explicitly go against the mentioned gap.

Honestly I'm finding myself between a rock and a hard place here since I'm now faced with either changing the webcomponents to consider being used within react/preact or dropping react/preact entirely or using a custom preact fork (wasn't able to adapt react as easily) for the time being.

[coveralls]

coverage: 99.485% (-0.001%) from 99.486%
when pulling 5ca6c52 on hesxenon:main
into 2c6df95 on preactjs:main.

[hesxenon]

I am not against the "sigil" approach - but this is a much smaller change, both internally and externally?

The proposed workaround then is to design the webcomponent with preact in mind - since uppercasing the content attribute while lowercasing the IDL introduces complexity in the webcomponent for the purpose of making it compatible with a framework :/

Plus it means that the IDL attribute does not technically reflect the content attribute, which does go against the definition of IDL attributes?

but don't intend on having those attribute set from themselves

Keeping in mind the existing "native elements" like select, input, div etc - they all set their IDL attributes according to the content attributes - that's what "IDL reflects content" means, no? And the IDL attribute is named like the content attribute with very few exceptions that mostly relate to camelCasing kebab-cased attributes.

I don't think use of that API sends the signal that you apply here.

I agree - in isolation it does not send the signal that I apply here. But in combination with the definition of IDL attributes and existing implementations it does, doesn't it? IDL attributes should reflect their content counterparts (and may transform them), observedAttributes means "I'm interested in changes to the content attribute" and existing implementations update their IDL attributes if the content attribute changes.

But I think I've found a "loophole" here. Quoting from MDN:

The IDL attribute is always going to use (but might transform) the underlying content attribute to return a value when you get it and is going to save something in the content attribute when you set it

"is going to save something in the content attribute when you set it" being the key part here. That sounds to me like webcomponents should reflect the IDL change back into the content... I don't see yet how to prevent infinite loops here but that's hardly preacts problem...

I'd still be interested on your thoughts about that and how that relates to the aforementioned existing implementations - e.g. why document.querySelector("input").value = "foobar" does set the IDL attribute but does not update the content attribute

[hesxenon]

since this PR has been approved, can I get some pointers regarding tests? I don't think this should be marked as ready to merge without tests?

[marvinhagemeister]

FYI: The person that approved it has no approval rights and is a bot. They've been going over the preact and graphqljs repo and approving every open PR. It's a spam bot.

[hesxenon]

interesting... a bug in github? Or how does an account without rights approve this? Anyway, I still think this would be the way to go

…

On Tue, Oct 8, 2024, 20:12 Marvin Hagemeister ***@***.***> wrote: FYI: The person that approved it has no approval rights and is a bot. They've been going over the preact and graphqljs repo and approving every open PR. It's a spam bot. — Reply to this email directly, view it on GitHub <#4478 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACOHZTQPB5YKK3SMZR253ZDZ2QOAXAVCNFSM6AAAAABM2DAWOKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMBQGUYTMMBSGU> . You are receiving this because you authored the thread.Message ID: ***@***.***>