-
Notifications
You must be signed in to change notification settings - Fork 395
/
renderer.ts
353 lines (298 loc) · 11.3 KB
/
renderer.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
/*
* Copyright (c) 2018, salesforce.com, inc.
* All rights reserved.
* SPDX-License-Identifier: MIT
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
*/
import {
assert,
create,
hasOwnProperty,
htmlPropertyToAttribute,
globalThis,
isFunction,
isUndefined,
isArray,
KEY__IS_NATIVE_SHADOW_ROOT_DEFINED,
KEY__SHADOW_TOKEN,
setPrototypeOf,
StringToLowerCase,
} from '@lwc/shared';
import { Renderer } from '@lwc/engine-core';
const globalStylesheets: { [content: string]: true } = create(null);
if (process.env.NODE_ENV === 'development') {
// @ts-ignore
window.__lwcResetGlobalStylesheets = () => {
for (const key of Object.keys(globalStylesheets)) {
delete globalStylesheets[key];
}
};
}
const globalStylesheetsParentElement: Element = document.head || document.body || document;
// This check for constructable stylesheets is similar to Fast's:
// https://github.com/microsoft/fast/blob/d49d1ec/packages/web-components/fast-element/src/dom.ts#L51-L53
// See also: https://github.com/whatwg/webidl/issues/1027#issuecomment-934510070
const supportsConstructableStyleSheets =
isFunction((CSSStyleSheet.prototype as any).replaceSync) &&
isArray((document as any).adoptedStyleSheets);
const styleElements: { [content: string]: HTMLStyleElement } = create(null);
const styleSheets: { [content: string]: CSSStyleSheet } = create(null);
const nodesToStyleSheets = new WeakMap<Node, { [content: string]: true }>();
let getCustomElement, defineCustomElement, HTMLElementConstructor;
function isCustomElementRegistryAvailable() {
if (typeof customElements === 'undefined') {
return false;
}
try {
// dereference HTMLElement global because babel wraps globals in compat mode with a
// _wrapNativeSuper()
// This is a problem because LWCUpgradableElement extends renderer.HTMLElement which does not
// get wrapped by babel.
const HTMLElementAlias = HTMLElement;
// In case we use compat mode with a modern browser, the compat mode transformation
// invokes the DOM api with an .apply() or .call() to initialize any DOM api sub-classing,
// which are not equipped to be initialized that way.
class clazz extends HTMLElementAlias {}
customElements.define('lwc-test-' + Math.floor(Math.random() * 1000000), clazz);
new clazz();
return true;
} catch {
return false;
}
}
function insertConstructableStyleSheet(content: string, target: Node) {
// It's important for CSSStyleSheets to be unique based on their content, so that
// `shadowRoot.adoptedStyleSheets.includes(sheet)` works.
let styleSheet = styleSheets[content];
if (isUndefined(styleSheet)) {
styleSheet = new CSSStyleSheet();
(styleSheet as any).replaceSync(content);
styleSheets[content] = styleSheet;
}
if (!(target as any).adoptedStyleSheets.includes(styleSheet)) {
(target as any).adoptedStyleSheets = [...(target as any).adoptedStyleSheets, styleSheet];
}
}
function insertStyleElement(content: string, target: Node) {
// Avoid inserting duplicate `<style>`s
let sheets = nodesToStyleSheets.get(target);
if (isUndefined(sheets)) {
sheets = create(null);
nodesToStyleSheets.set(target, sheets!);
}
if (sheets![content]) {
return;
}
sheets![content] = true;
// This `<style>` may be repeated multiple times in the DOM, so cache it. It's a bit
// faster to call `cloneNode()` on an existing node than to recreate it every time.
let elm = styleElements[content];
if (isUndefined(elm)) {
elm = document.createElement('style');
elm.type = 'text/css';
elm.textContent = content;
styleElements[content] = elm;
} else {
elm = elm.cloneNode(true) as HTMLStyleElement;
}
target.appendChild(elm);
}
if (isCustomElementRegistryAvailable()) {
getCustomElement = customElements.get.bind(customElements);
defineCustomElement = customElements.define.bind(customElements);
HTMLElementConstructor = HTMLElement;
} else {
const registry: Record<string, CustomElementConstructor> = create(null);
const reverseRegistry: WeakMap<CustomElementConstructor, string> = new WeakMap();
defineCustomElement = function define(name: string, ctor: CustomElementConstructor) {
if (name !== StringToLowerCase.call(name) || registry[name]) {
throw new TypeError(`Invalid Registration`);
}
registry[name] = ctor;
reverseRegistry.set(ctor, name);
};
getCustomElement = function get(name: string): CustomElementConstructor | undefined {
return registry[name];
};
HTMLElementConstructor = function HTMLElement(this: HTMLElement) {
if (!(this instanceof HTMLElement)) {
throw new TypeError(`Invalid Invocation`);
}
const { constructor } = this;
const name = reverseRegistry.get(constructor as CustomElementConstructor);
if (!name) {
throw new TypeError(`Invalid Construction`);
}
const elm = document.createElement(name);
setPrototypeOf(elm, constructor.prototype);
return elm;
};
HTMLElementConstructor.prototype = HTMLElement.prototype;
}
let isHydrating = false;
export function setIsHydrating(v: boolean) {
isHydrating = v;
}
export const renderer: Renderer<Node, Element> = {
ssr: false,
isHydrating(): boolean {
return isHydrating;
},
isNativeShadowDefined: globalThis[KEY__IS_NATIVE_SHADOW_ROOT_DEFINED],
isSyntheticShadowDefined: hasOwnProperty.call(Element.prototype, KEY__SHADOW_TOKEN),
createElement(tagName: string, namespace: string): Element {
return isUndefined(namespace)
? document.createElement(tagName)
: document.createElementNS(namespace, tagName);
},
createText(content: string): Node {
return document.createTextNode(content);
},
createComment(content: string): Node {
return document.createComment(content);
},
insert(node: Node, parent: Node, anchor: Node): void {
parent.insertBefore(node, anchor);
},
remove(node: Node, parent: Node): void {
parent.removeChild(node);
},
nextSibling(node: Node): Node | null {
return node.nextSibling;
},
attachShadow(element: Element, options: ShadowRootInit): ShadowRoot {
if (isHydrating) {
return element.shadowRoot!;
}
return element.attachShadow(options);
},
setText(node: Node, content: string): void {
node.nodeValue = content;
},
getProperty(node: Node, key: string): any {
return (node as any)[key];
},
setProperty(node: Node, key: string, value: any): void {
if (process.env.NODE_ENV !== 'production') {
if (node instanceof Element && !(key in node)) {
// TODO [#1297]: Move this validation to the compiler
assert.fail(
`Unknown public property "${key}" of element <${
node.tagName
}>. This is likely a typo on the corresponding attribute "${htmlPropertyToAttribute(
key
)}".`
);
}
}
(node as any)[key] = value;
},
getAttribute(element: Element, name: string, namespace?: string): string | null {
return isUndefined(namespace)
? element.getAttribute(name)
: element.getAttributeNS(namespace, name);
},
setAttribute(element: Element, name: string, value: string, namespace?: string): void {
return isUndefined(namespace)
? element.setAttribute(name, value)
: element.setAttributeNS(namespace, name, value);
},
removeAttribute(element: Element, name: string, namespace?: string): void {
if (isUndefined(namespace)) {
element.removeAttribute(name);
} else {
element.removeAttributeNS(namespace, name);
}
},
addEventListener(
target: Node,
type: string,
callback: EventListener,
options: AddEventListenerOptions | boolean
): void {
target.addEventListener(type, callback, options);
},
removeEventListener(
target: Node,
type: string,
callback: EventListener,
options: EventListenerOptions | boolean
): void {
target.removeEventListener(type, callback, options);
},
dispatchEvent(target: Node, event: Event): boolean {
return target.dispatchEvent(event);
},
getClassList(element: Element): DOMTokenList {
return element.classList;
},
setCSSStyleProperty(element: Element, name: string, value: string, important: boolean): void {
// TODO [#0]: How to avoid this type casting? Shall we use a different type interface to
// represent elements in the engine?
(element as HTMLElement | SVGElement).style.setProperty(
name,
value,
important ? 'important' : ''
);
},
getBoundingClientRect(element: Element): DOMRect {
return element.getBoundingClientRect();
},
querySelector(element: Element, selectors: string): Element | null {
return element.querySelector(selectors);
},
querySelectorAll(element: Element, selectors: string): NodeList {
return element.querySelectorAll(selectors);
},
getElementsByTagName(element: Element, tagNameOrWildCard: string): HTMLCollection {
return element.getElementsByTagName(tagNameOrWildCard);
},
getElementsByClassName(element: Element, names: string): HTMLCollection {
return element.getElementsByClassName(names);
},
getChildren(element: Element): HTMLCollection {
return element.children;
},
getChildNodes(element: Element): NodeList {
return element.childNodes;
},
getFirstChild(element: Element): Node | null {
return element.firstChild;
},
getFirstElementChild(element: Element): Element | null {
return element.firstElementChild;
},
getLastChild(element: Element): Node | null {
return element.lastChild;
},
getLastElementChild(element: Element): Element | null {
return element.lastElementChild;
},
isConnected(node: Node): boolean {
return node.isConnected;
},
insertGlobalStylesheet(content: string): void {
if (!isUndefined(globalStylesheets[content])) {
return;
}
globalStylesheets[content] = true;
const elm = document.createElement('style');
elm.type = 'text/css';
elm.textContent = content;
globalStylesheetsParentElement.appendChild(elm);
},
insertStylesheet(content: string, target: Node): void {
if (supportsConstructableStyleSheets) {
insertConstructableStyleSheet(content, target);
} else {
// Fall back to <style> element
insertStyleElement(content, target);
}
},
assertInstanceOfHTMLElement(elm: any, msg: string) {
assert.invariant(elm instanceof HTMLElement, msg);
},
defineCustomElement,
getCustomElement,
HTMLElement: HTMLElementConstructor as any,
};