-
Notifications
You must be signed in to change notification settings - Fork 395
/
renderer.ts
351 lines (298 loc) · 10.8 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
/*
* Copyright (c) 2020, 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 {
isUndefined,
isNull,
isBooleanAttribute,
isGlobalHtmlAttribute,
isAriaAttribute,
create,
StringToLowerCase,
htmlPropertyToAttribute,
} from '@lwc/shared';
import { Renderer } from '@lwc/engine-core';
import { HostNode, HostElement, HostAttribute, HostNodeType } from './types';
import { classNameToTokenList, tokenListToClassName } from './utils/classes';
function unsupportedMethod(name: string): () => never {
return function () {
throw new TypeError(`"${name}" is not supported in this environment`);
};
}
function createElement(name: string): HostElement {
return {
type: HostNodeType.Element,
name,
parent: null,
shadowRoot: null,
children: [],
attributes: [],
eventListeners: {},
};
}
const registry: Record<string, CustomElementConstructor> = create(null);
const reverseRegistry: WeakMap<CustomElementConstructor, string> = new WeakMap();
function registerCustomElement(name: string, ctor: CustomElementConstructor) {
if (name !== StringToLowerCase.call(name) || registry[name]) {
throw new TypeError(`Invalid Registration`);
}
registry[name] = ctor;
reverseRegistry.set(ctor, name);
}
class HTMLElement {
constructor() {
const { constructor } = this;
const name = reverseRegistry.get(constructor as CustomElementConstructor);
if (!name) {
throw new TypeError(`Invalid Construction`);
}
return createElement(name);
}
}
export const renderer: Renderer<HostNode, HostElement> = {
ssr: true,
isHydrating(): boolean {
return false;
},
isNativeShadowDefined: false,
isSyntheticShadowDefined: false,
insert(node, parent, anchor) {
if (node.parent !== null && node.parent !== parent) {
const nodeIndex = node.parent.children.indexOf(node);
node.parent.children.splice(nodeIndex, 1);
}
node.parent = parent;
const anchorIndex = isNull(anchor) ? -1 : parent.children.indexOf(anchor);
if (anchorIndex === -1) {
parent.children.push(node);
} else {
parent.children.splice(anchorIndex, 0, node);
}
},
remove(node, parent) {
const nodeIndex = parent.children.indexOf(node);
parent.children.splice(nodeIndex, 1);
},
createElement,
createText(content: string): HostNode {
return {
type: HostNodeType.Text,
value: String(content),
parent: null,
};
},
createComment(content: string): HostNode {
return {
type: HostNodeType.Comment,
value: content,
parent: null,
};
},
nextSibling(node) {
const { parent } = node;
if (isNull(parent)) {
return null;
}
const nodeIndex = parent.children.indexOf(node);
return (parent.children[nodeIndex + 1] as HostNode) || null;
},
attachShadow(element, config) {
element.shadowRoot = {
type: HostNodeType.ShadowRoot,
children: [],
mode: config.mode,
delegatesFocus: !!config.delegatesFocus,
};
return element.shadowRoot as any;
},
getProperty(node, key) {
if (key in node) {
return (node as any)[key];
}
if (node.type === HostNodeType.Element) {
const attrName = htmlPropertyToAttribute(key);
// Handle all the boolean properties.
if (isBooleanAttribute(attrName, node.name)) {
return this.getAttribute(node, attrName) ?? false;
}
// Handle global html attributes and AOM.
if (isGlobalHtmlAttribute(attrName) || isAriaAttribute(attrName)) {
return this.getAttribute(node, attrName);
}
// Handle special elements live bindings. The checked property is already handled above
// in the boolean case.
if (node.name === 'input' && key === 'value') {
return this.getAttribute(node, 'value') ?? '';
}
}
if (process.env.NODE_ENV !== 'production') {
// eslint-disable-next-line no-console
console.error(`Unexpected "${key}" property access from the renderer`);
}
},
setProperty(node, key, value): void {
if (key in node) {
return ((node as any)[key] = value);
}
if (node.type === HostNodeType.Element) {
const attrName = htmlPropertyToAttribute(key);
if (key === 'innerHTML') {
node.children = [
{
type: HostNodeType.Raw,
parent: node,
value,
},
];
return;
}
// Handle all the boolean properties.
if (isBooleanAttribute(attrName, node.name)) {
return value === true
? this.setAttribute(node, attrName, '')
: this.removeAttribute(node, attrName);
}
// Handle global html attributes and AOM.
if (isGlobalHtmlAttribute(attrName) || isAriaAttribute(attrName)) {
return this.setAttribute(node, attrName, value);
}
// Handle special elements live bindings. The checked property is already handled above
// in the boolean case.
if (node.name === 'input' && attrName === 'value') {
return isNull(value) || isUndefined(value)
? this.removeAttribute(node, 'value')
: this.setAttribute(node, 'value', value);
}
}
if (process.env.NODE_ENV !== 'production') {
// eslint-disable-next-line no-console
console.error(`Unexpected attempt to set "${key}=${value}" property from the renderer`);
}
},
setText(node, content) {
if (node.type === HostNodeType.Text) {
node.value = content;
} else if (node.type === HostNodeType.Element) {
node.children = [
{
type: HostNodeType.Text,
parent: node,
value: content,
},
];
}
},
getAttribute(element, name, namespace = null) {
const attribute = element.attributes.find(
(attr) => attr.name === name && attr.namespace === namespace
);
return attribute ? attribute.value : null;
},
setAttribute(element, name, value, namespace = null) {
const attribute = element.attributes.find(
(attr) => attr.name === name && attr.namespace === namespace
);
if (isUndefined(attribute)) {
element.attributes.push({
name,
namespace,
value: String(value),
});
} else {
attribute.value = value;
}
},
removeAttribute(element, name, namespace) {
element.attributes = element.attributes.filter(
(attr) => attr.name !== name && attr.namespace !== namespace
);
},
getClassList(element) {
function getClassAttribute(): HostAttribute {
let classAttribute = element.attributes.find(
(attr) => attr.name === 'class' && isNull(attr.namespace)
);
if (isUndefined(classAttribute)) {
classAttribute = {
name: 'class',
namespace: null,
value: '',
};
element.attributes.push(classAttribute);
}
return classAttribute;
}
return {
add(...names: string[]): void {
const classAttribute = getClassAttribute();
const tokenList = classNameToTokenList(classAttribute.value);
names.forEach((name) => tokenList.add(name));
classAttribute.value = tokenListToClassName(tokenList);
},
remove(...names: string[]): void {
const classAttribute = getClassAttribute();
const tokenList = classNameToTokenList(classAttribute.value);
names.forEach((name) => tokenList.delete(name));
classAttribute.value = tokenListToClassName(tokenList);
},
} as DOMTokenList;
},
setCSSStyleProperty(element, name, value, important) {
const styleAttribute = element.attributes.find(
(attr) => attr.name === 'style' && isNull(attr.namespace)
);
const serializedProperty = `${name}: ${value}${important ? ' !important' : ''}`;
if (isUndefined(styleAttribute)) {
element.attributes.push({
name: 'style',
namespace: null,
value: serializedProperty,
});
} else {
styleAttribute.value += `; ${serializedProperty}`;
}
},
isConnected(node: HostNode) {
return !isNull(node.parent);
},
insertGlobalStylesheet() {
// Noop on SSR (for now). This need to be reevaluated whenever we will implement support for
// synthetic shadow.
},
insertStylesheet() {
// Noop on SSR (for now). This need to be reevaluated whenever we will implement support for
// synthetic shadow.
},
addEventListener() {
// Noop on SSR.
},
removeEventListener() {
// Noop on SSR.
},
dispatchEvent: unsupportedMethod('dispatchEvent'),
getBoundingClientRect: unsupportedMethod('getBoundingClientRect'),
querySelector: unsupportedMethod('querySelector'),
querySelectorAll: unsupportedMethod('querySelectorAll'),
getElementsByTagName: unsupportedMethod('getElementsByTagName'),
getElementsByClassName: unsupportedMethod('getElementsByClassName'),
getChildren: unsupportedMethod('getChildren'),
getChildNodes: unsupportedMethod('getChildNodes'),
getFirstChild: unsupportedMethod('getFirstChild'),
getFirstElementChild: unsupportedMethod('getFirstElementChild'),
getLastChild: unsupportedMethod('getLastChild'),
getLastElementChild: unsupportedMethod('getLastElementChild'),
defineCustomElement(
name: string,
constructor: CustomElementConstructor,
_options?: ElementDefinitionOptions
) {
registerCustomElement(name, constructor);
},
getCustomElement(name: string): CustomElementConstructor | undefined {
return registry[name];
},
HTMLElement: HTMLElement as any,
};