Skip to content

Commit 62d235d

Browse files
authored
refactor(framework): remove render method (#8501)
Removed the deprecated `UI5Element#render` method of the UI5Element class and replaced it with `UI5Element#renderer`. BREAKING CHANGE: Removed `UI5Element#render` method in favour of `UI5Element#renderer`. If you previously used "render" ```js class MyClass extends UI5Element { static get render() { return litRenderer; } } ``` start using "renderer" ```ts class MyClass extends UI5Element { static get renderer() { return litRenderer; } } ``` Related to [#8461](#8461)
1 parent a3aa04e commit 62d235d

11 files changed

+19
-31
lines changed

docs/5-development/02-custom-UI5-Web-Components.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class Demo extends UI5Element {
3434
return metadata;
3535
}
3636

37-
static get render() {
37+
static get renderer() {
3838
return litRender;
3939
}
4040

@@ -108,7 +108,7 @@ For a complete reference to all metadata entities, click [here](./03-understandi
108108
UI5 Web Components are agnostic of the DOM render engine used. However, all standard UI5 Web Components (`@ui5/webcomponents`, `@ui5/webcomponents-fiori`, etc.)
109109
use [lit-html](https://github.com/Polymer/lit-html) as the rendering technology of choice.
110110

111-
The render engine is defined via the `render` static getter:
111+
The render engine is defined via the `renderer` static getter:
112112

113113
```js
114114
import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
@@ -129,7 +129,7 @@ class Demo extends UI5Element {
129129
return metadata;
130130
}
131131

132-
static get render() {
132+
static get renderer() {
133133
return litRender;
134134
}
135135
}
@@ -167,7 +167,7 @@ class Demo extends UI5Element {
167167
return metadata;
168168
}
169169

170-
static get render() {
170+
static get renderer() {
171171
return litRender;
172172
}
173173

@@ -216,7 +216,7 @@ class Demo extends UI5Element {
216216
return metadata;
217217
}
218218

219-
static get render() {
219+
static get renderer() {
220220
return litRender;
221221
}
222222

@@ -280,7 +280,7 @@ class Demo extends UI5Element {
280280
return metadata;
281281
}
282282

283-
static get render() {
283+
static get renderer() {
284284
return litRender;
285285
}
286286

@@ -331,7 +331,7 @@ class Demo extends UI5Element {
331331
return metadata;
332332
}
333333

334-
static get render() {
334+
static get renderer() {
335335
return litRender;
336336
}
337337

@@ -398,7 +398,7 @@ class Demo extends UI5Element {
398398
return metadata;
399399
}
400400

401-
static get render() {
401+
static get renderer() {
402402
return litRender;
403403
}
404404

@@ -455,7 +455,7 @@ class Demo extends UI5Element {
455455
return metadata;
456456
}
457457

458-
static get render() {
458+
static get renderer() {
459459
return litRender;
460460
}
461461

docs/5-development/07-typescript-in-UI5-Web-Components.md

-2
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,6 @@ class MyElement extends UI5Element {
7070
}
7171
```
7272

73-
**Note**: the `static get render()` that we use when developing in JavaScript (still supported for backward compatibility) is replaced with **`renderer`** in the `@customElement` decorator.
74-
7573
### Property decorators
7674

7775
These are used inside the class and are associated with accessors (class members).

packages/base/src/UI5Element.ts

+1-5
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,7 @@ abstract class UI5Element extends HTMLElement {
108108
static staticAreaTemplate?: TemplateFunction;
109109
static _metadata: UI5ElementMetadata;
110110

111-
/**
112-
* @deprecated
113-
*/
114-
static render: Renderer;
115-
static renderer?: Renderer;
111+
static renderer: Renderer;
116112

117113
constructor() {
118114
super();

packages/base/src/decorators/customElement.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,8 @@ const customElement = (tagNameOrComponentSettings: string | {
4949
target.metadata.fastNavigation = fastNavigation;
5050
}
5151

52-
["render", "renderer", "template", "staticAreaTemplate", "styles", "staticAreaStyles", "dependencies"].forEach((customElementEntity: string) => {
53-
const _customElementEntity = customElementEntity === "render" ? "renderer" : customElementEntity;
54-
const customElementEntityValue = tagNameOrComponentSettings[_customElementEntity as keyof typeof tag];
52+
["renderer", "template", "staticAreaTemplate", "styles", "staticAreaStyles", "dependencies"].forEach((customElementEntity: string) => {
53+
const customElementEntityValue = tagNameOrComponentSettings[customElementEntity as keyof typeof tag];
5554

5655
customElementEntityValue && Object.defineProperty(target, customElementEntity, {
5756
get: () => customElementEntityValue,

packages/base/src/updateShadowRoot.ts

+1-6
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,7 @@ const updateShadowRoot = (element: UI5Element, forStaticArea = false) => {
2323

2424
shadowRoot.adoptedStyleSheets = getConstructableStyle(ctor, forStaticArea);
2525

26-
if (ctor.renderer) {
27-
ctor.renderer(renderResult, shadowRoot, forStaticArea, { host: element });
28-
return;
29-
}
30-
31-
ctor.render(renderResult, shadowRoot, forStaticArea, { host: element });
26+
ctor.renderer(renderResult, shadowRoot, forStaticArea, { host: element });
3227
};
3328

3429
export default updateShadowRoot;

packages/base/test/elements/Child.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class Child extends UI5Element {
2121
return metadata;
2222
}
2323

24-
static get render() {
24+
static get renderer() {
2525
return litRender;
2626
}
2727

packages/base/test/elements/Generic.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class Generic extends UI5Element {
5050
return metadata;
5151
}
5252

53-
static get render() {
53+
static get renderer() {
5454
return litRender;
5555
}
5656

packages/base/test/elements/Parent.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class Parent extends UI5Element {
2525
return metadata;
2626
}
2727

28-
static get render() {
28+
static get renderer() {
2929
return litRender;
3030
}
3131

packages/base/test/elements/WithComplexTemplate.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class WithComplexTemplate extends UI5Element {
99
};
1010
}
1111

12-
static get render() {
12+
static get renderer() {
1313
return litRender;
1414
}
1515

packages/base/test/elements/WithStaticArea.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class WithStaticArea extends UI5Element {
2121
return metadata;
2222
}
2323

24-
static get render() {
24+
static get renderer() {
2525
return litRender;
2626
}
2727

packages/main/src/SliderBase.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ abstract class SliderBase extends UI5Element {
213213
};
214214
}
215215

216-
static get render() {
216+
static get renderer() {
217217
return litRender;
218218
}
219219

0 commit comments

Comments
 (0)