Skip to content

refactor: move customElements.whenDefined to willUpdate #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 10, 2022
Merged

refactor: move customElements.whenDefined to willUpdate #167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions packages/api-demo/src/layout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ class ApiDemoLayout extends LitElement {
@property({ attribute: false })
propKnobs!: PropertyKnob[];

private _whenDefined: Record<string, Promise<unknown>> = {};
@property({ type: Boolean })
private defined = false;

private eventsController!: EventsController;

Expand All @@ -72,16 +73,7 @@ class ApiDemoLayout extends LitElement {
protected render(): TemplateResult {
const { tag } = this;

// Invoke `requestUpdate` to render demo once the component is imported lazily
// and becomes defined, but only it if matches the currently selected tag name.
if (!customElements.get(tag)) {
this._whenDefined[tag] = customElements.whenDefined(tag);
this._whenDefined[tag].then(() => {
if (this.tag === tag) {
this.requestUpdate();
}
});

if (!this.defined) {
return html`
<div part="warning">
Element ${tag} is not defined. Have you imported it?
Expand Down Expand Up @@ -190,6 +182,19 @@ class ApiDemoLayout extends LitElement {
willUpdate(props: PropertyValues) {
// Reset state if tag changed
if (props.has('tag')) {
const { tag } = this;
this.defined = !!customElements.get(tag);

if (!this.defined) {
// Change `defined` to render demo once the component is imported lazily
// and becomes defined, but only if the corresponding tag is selected.
customElements.whenDefined(tag).then(() => {
if (this.tag === tag) {
this.defined = true;
}
});
}

this.knobs = {};
this.propKnobs = getKnobs(this.tag, this.props, this.exclude);
this.customKnobs = getCustomKnobs(this.tag, this.vid);
Expand Down