javascriptweb-componentcustom-element

custom element setup: constructor vs connectedCallback


I'm new to web components, and I've noticed some examples set the dom in the custom-element's constructor, while others do it in the connectedCallback. As both seem to work fine(although I tried only Chrome), I assume the main difference is the case in which a user creates the element in js and not attaching it to the page?

I guess the main question here is whether I'm missing some other reason to prefer one method over the other.

Thanks.


Solution

  • Best practices and rules for custom element constructors

    What's safe to do in the constructor

    In the constructor, it's safe to

    What you cannot do in the constructor

    In the constructor, you are not allowed (amongst other things)

    ...because those might not be present in the non-upgrade case, and definitely won't be present when you dynamically create your custom element using either document.createElement('my-custom-element') or new MyCustomElement().

    What's unwise to do in the constructor

    In the constructor, you probably don't want to

    Attaching these listeners in the constructor and properly cleaning them up in the disconnectedCallback results in missing listeners once your component gets removed from (and later re-added), or moved in, the DOM.

    *Pitfalls and things to be aware of

    You need to be aware of the custom element lifecycle to not fall into otherwise obvious pitfalls, which include:

    In part, these best practices and rules follow https://html.spec.whatwg.org/multipage/custom-elements.html#custom-element-conformance, in other parts they deviate from recommendations done there in the spec.

    Specifically I disagree on the following (given the scope for the listeners is outside the component), for the reasons I gave above.

    In general, the constructor should be used to set up initial state and default values, and to set up event listeners and possibly a shadow root.