first draft for LightningElement.CustomElement abstraction by caridy · Pull Request #7 · salesforce/lwc-rfcs

caridy · 2019-07-05T18:24:21Z

No description provided.

caridy · 2019-07-05T18:25:04Z

text/0000-custom-element.md

+
+```js
+import XFoo from 'x/foo';
+customElements.define('x-foo', XFoo.CustomElement);


this is the meat of this proposal... the .CustomElement static accessor on every LWC constructor

This would be quite verbose, but what do you think about 'CustomElementConstructor'?

The main issue that I have with CustomElement, is that the custom element represents a custom element instance while the custom elements registry accepts a constructor. I support @apapko into making this explicit.

I mentioned a similar concern in salesforce/lwc#1395 (review)

apapko · 2019-07-05T19:55:05Z

text/0000-custom-element.md

+
+# Summary
+
+Facilitate the registration of LWC Constructor as Custom Elements.


registration with what?

registration of LWC Constructor as Custom Elements

apapko · 2019-07-05T19:55:30Z

text/0000-custom-element.md

+
+# Motivation
+
+As today, the way to generate a qualifying Custom Element from a LWC Constructor, is via an experimental API: `buildCustomElementConstructor()`. Since this is a primary use case for LWC, we want to make it more ergonomic, and simpler. Additionally, the experimental API allow you to generate more than one Custom Element per LWC Constructors, which does not align with the web components semantics.


As of today?

apapko · 2019-07-05T19:57:00Z

text/0000-custom-element.md

+# Motivation
+
+As today, the way to generate a qualifying Custom Element from a LWC Constructor, is via an experimental API: `buildCustomElementConstructor()`. Since this is a primary use case for LWC, we want to make it more ergonomic, and simpler. Additionally, the experimental API allow you to generate more than one Custom Element per LWC Constructors, which does not align with the web components semantics.
+


Listing a use case would be useful

apapko · 2019-07-05T19:57:57Z

text/0000-custom-element.md

+
+# Proposal
+
+This proposal provides a high-level API (an abstraction layer) for authors to access the custom element associate to a LWC Constructor:


did you mean: associated with LWC Constructor?

apapko · 2019-07-05T19:59:34Z

text/0000-custom-element.md

+
+```js
+import XFoo from 'x/foo';
+customElements.define('x-foo', XFoo.CustomElement);


This would be quite verbose, but what do you think about 'CustomElementConstructor'?

apapko · 2019-07-05T20:01:11Z

text/0000-custom-element.md

+This proposal provides a high-level API (an abstraction layer) for authors to access the custom element associate to a LWC Constructor:
+
+```js
+import XFoo from 'x/foo';


is allowing to import 'constructor' property an option?

import { constructor as XFooConstructor } from 'x/foo';

apapko · 2019-07-05T20:02:39Z

text/0000-custom-element.md

+## Semantics and Invariants
+
+* There is a 1-1 mapping between LWC Constructors and the corresponding Custom Element.
+* Claiming the Custom Element for the abstract `LightningElement` must be disallow.


what does this mean- Claiming the Custom Element for the abstract LightningElement?

pmdartus · 2019-07-09T11:36:09Z

text/0000-custom-element.md

+
+```js
+import XFoo from 'x/foo';
+customElements.define('x-foo', XFoo.CustomElement);


The main issue that I have with CustomElement, is that the custom element represents a custom element instance while the custom elements registry accepts a constructor. I support @apapko into making this explicit.

text/0000-custom-element.md

pmdartus · 2020-03-04T13:32:17Z

Looking at this RFC again, I am now uncertain about attaching a CustomElementConstructor on the LightningElement.prototype.

We have started decoupling the LWC engine from the DOM (#23), what would the CustomElementConstructor getter returns when the engine is running in an environment without DOM. The current approach with the buildCustomElementConstructor method has the following benefits:

it can be removed from the @lwc/engine-core and only exposed from the @lwc/engine-dom.
it can be tree-shaken if it is not used by the application.

mikebernard · 2020-03-20T12:35:29Z

This would be huge for nCino! We have a library of custom web components that we've built and use in many of our Salesforce applications. It would save us a lot of time and money if we could reuse them.

gonzalocordero · 2020-06-12T06:38:00Z

@jodarove This was already implemented right? should we change the status then?

pmdartus

@caridy @jodarove I updated the RFC, I will let you check if everything is right. Otherwise LGTM.

jodarove · 2020-06-12T15:13:02Z

thanks @pmdartus!

) * first draft for LightningElement.CustomElement abstraction * update meta for rfc app * wip: change to CustomElementConstructor * wip: review comments * Update 0000-custom-element.md * Update RFC status Co-authored-by: Jose David Rodriguez Velasco <jodarove@gmail.com> Co-authored-by: Pierre-Marie Dartus <p.dartus@salesforce.com>

first draft for LightningElement.CustomElement abstraction

dd1b42a

caridy commented Jul 5, 2019

View reviewed changes

caridy mentioned this pull request Jul 5, 2019

refactor(engine): add LightningElement.CustomElementConstructor getter salesforce/lwc#1395

Merged

apapko reviewed Jul 5, 2019

View reviewed changes

pmdartus reviewed Jul 9, 2019

View reviewed changes

caridy and others added 3 commits November 6, 2019 23:03

update meta for rfc app

06c1788

wip: change to CustomElementConstructor

d37732f

wip: review comments

193f7bd

Update 0000-custom-element.md

b323406

jodarove approved these changes Apr 22, 2020

View reviewed changes

Update RFC status

0eac328

pmdartus approved these changes Jun 12, 2020

View reviewed changes

jodarove merged commit 216e69c into master Jun 12, 2020

jodarove deleted the caridy/custom-elements branch June 12, 2020 15:13


		# Summary

		Facilitate the registration of LWC Constructor as Custom Elements.


		# Motivation

		As today, the way to generate a qualifying Custom Element from a LWC Constructor, is via an experimental API: `buildCustomElementConstructor()`. Since this is a primary use case for LWC, we want to make it more ergonomic, and simpler. Additionally, the experimental API allow you to generate more than one Custom Element per LWC Constructors, which does not align with the web components semantics.


		# Proposal

		This proposal provides a high-level API (an abstraction layer) for authors to access the custom element associate to a LWC Constructor:

Conversation

caridy commented Jul 5, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pmdartus commented Mar 4, 2020

Uh oh!

mikebernard commented Mar 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gonzalocordero commented Jun 12, 2020

Uh oh!

pmdartus left a comment

Choose a reason for hiding this comment

Uh oh!

jodarove commented Jun 12, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

mikebernard commented Mar 20, 2020 •

edited

Loading