Skip to content

Commit 736a35a

Browse files
authored
fix: patch renderer function instead of the template (#2481)
1 parent c718e03 commit 736a35a

3 files changed

Lines changed: 77 additions & 29 deletions

File tree

‎vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/main/java/com/vaadin/flow/component/grid/it/GridLitRendererPage.java‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
import com.vaadin.flow.component.grid.Grid;
2323
import com.vaadin.flow.component.html.Div;
2424
import com.vaadin.flow.component.html.NativeButton;
25+
import com.vaadin.flow.component.html.Span;
26+
import com.vaadin.flow.data.binder.Binder;
2527
import com.vaadin.flow.data.renderer.ComponentRenderer;
2628
import com.vaadin.flow.data.renderer.LitRenderer;
2729
import com.vaadin.flow.router.Route;
@@ -36,7 +38,9 @@ public GridLitRendererPage() {
3638
grid.addColumn(LitRenderer
3739
.<Integer> of(
3840
"<span id=\"item-${index}\">Lit: ${item.name}</span>")
39-
.withProperty("name", item -> "Item " + item));
41+
.withProperty("name", item -> "Item " + item))
42+
.setEditorComponent(new Span("Editor component"));
43+
grid.getEditor().setBinder(new Binder<>());
4044
setLitRenderer(grid);
4145
add(grid);
4246

@@ -51,7 +55,29 @@ public GridLitRendererPage() {
5155
setLitRenderer(grid);
5256
});
5357
litRendererButton.setId("litRendererButton");
54-
add(componentRendererButton, litRendererButton);
58+
59+
NativeButton toggleEditButton = new NativeButton("Toggle edit mode",
60+
e -> {
61+
if (grid.getEditor().isOpen()) {
62+
grid.getEditor().cancel();
63+
} else {
64+
grid.getEditor().editItem(0);
65+
}
66+
});
67+
toggleEditButton.setId("toggleEditButton");
68+
69+
NativeButton toggleAttachedButton = new NativeButton("Toggle attached",
70+
e -> {
71+
if (grid.isAttached()) {
72+
remove(grid);
73+
} else {
74+
add(grid);
75+
}
76+
});
77+
toggleAttachedButton.setId("toggleAttachedButton");
78+
79+
add(componentRendererButton, litRendererButton, toggleEditButton,
80+
toggleAttachedButton);
5581
}
5682

5783
private void setLitRenderer(Grid<Integer> grid) {

‎vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/grid/it/GridLitRendererIT.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,26 @@ public void shouldSwitchBackToLitRenderer() {
6666
WebElement item = grid.findElement(By.id("details-0"));
6767
Assert.assertEquals("Lit: Item details 0", item.getText());
6868
}
69+
70+
@Test
71+
public void shouldEnterEditMode() {
72+
clickElementWithJs("toggleEditButton");
73+
Assert.assertEquals("Editor component", grid.getCell(0, 0).getText());
74+
}
75+
76+
@Test
77+
public void shouldExitEditMode() {
78+
clickElementWithJs("toggleEditButton");
79+
clickElementWithJs("toggleEditButton");
80+
Assert.assertEquals("Lit: Item 0", grid.getCell(0, 0).getText());
81+
}
82+
83+
@Test
84+
public void shouldEnterEditModeAfterReattach() {
85+
clickElementWithJs("toggleAttachedButton");
86+
clickElementWithJs("toggleAttachedButton");
87+
clickElementWithJs("toggleEditButton");
88+
grid = $(GridElement.class).first();
89+
Assert.assertEquals("Editor component", grid.getCell(0, 0).getText());
90+
}
6991
}

‎vaadin-grid-flow-parent/vaadin-grid-flow/src/main/java/com/vaadin/flow/component/grid/editor/EditorRenderer.java‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -149,46 +149,46 @@ public Rendering<T> render(Element container, DataKeyMapper<T> keyMapper,
149149
editorContainer = createEditorContainer();
150150
container.appendVirtualChild(editorContainer);
151151

152-
/*
153-
* The runBeforeClientResponse is needed because ComponentRenderers
154-
* don't set the innerHTML of the <template> elements in advance, only
155-
* before the client response.
156-
*/
152+
// Run editor renderer setup
157153
runBeforeClientResponse(container,
158-
context -> setupEditorTemplate(container, contentTemplate,
159-
context));
154+
context -> setupEditorRenderer(container, context));
155+
156+
// Also run editor renderer setup whenever the component gets attached
157+
container.addAttachListener(event -> {
158+
runBeforeClientResponse(container,
159+
context -> setupEditorRenderer(container, context));
160+
});
160161

161162
return new EditorRendering(contentTemplate);
162163
}
163164

164-
private void setupEditorTemplate(Element container, Element contentTemplate,
165+
private void setupEditorRenderer(Element container,
165166
ExecutionContext context) {
166-
final String originalTemplate;
167-
final Element attachedTemplate;
168-
169-
// the template can be null if the original renderer didn't use any
170-
// template, such as the ColumnPathRenderer
171-
if (contentTemplate == null) {
172-
originalTemplate = "[[item." + columnInternalId + "]]";
173-
attachedTemplate = new Element("template");
174-
container.appendChild(attachedTemplate);
175-
} else {
176-
attachedTemplate = contentTemplate;
177-
originalTemplate = contentTemplate.getProperty("innerHTML");
178-
}
179167
String appId = context.getUI().getInternals().getAppId();
180168
String editorTemplate = String.format(
181-
"<flow-component-renderer appid='%s' nodeid='[[item._%s_editor]]'></flow-component-renderer>",
169+
"<flow-component-renderer appid='%s' nodeid='${model.item._%s_editor}'></flow-component-renderer>",
182170
appId, columnInternalId);
183171

184-
attachedTemplate.setProperty("innerHTML", String.format(
185172
//@formatter:off
186-
"<template is='dom-if' if='[[item._editing]]' restamp>%s</template>" +
187-
"<template is='dom-if' if='[[!item._editing]]' restamp>%s</template>",
173+
container.executeJs("const originalRender = this.renderer;" +
174+
// Patch the container's renderer function to handle the editor
175+
"this.renderer = (root, container, model) => {" +
176+
"const editingChanged = root.__editing !== model.item._editing;" +
177+
"root.__editing = model.item._editing;" +
178+
179+
// If the editing state changed, the root needs to be cleared
180+
"if (editingChanged) {" +
181+
"delete root._$litPart$; root.innerHTML = ''" +
182+
"}" +
183+
184+
// If editing, render the editor, otherwise use the original renderer
185+
"if (root.__editing) { root.innerHTML = `" + editorTemplate + "` }" +
186+
"else if (!originalRender) { root.textContent = model.item." + columnInternalId + " }" +
187+
"else { originalRender(root, container, model); }" +
188+
"};");
188189
//@formatter:on
189-
editorTemplate, originalTemplate));
190190

191-
// clear the path property, since we are using a explicit template
191+
// clear the path property, since we are using an explicit renderer
192192
container.removeProperty("path");
193193
}
194194

0 commit comments

Comments
 (0)