Skip to content

Commit 37bc304

Browse files
authored
refactor: render vaadin-message elements using Lit (#4868)
1 parent 7fa5151 commit 37bc304

3 files changed

Lines changed: 40 additions & 53 deletions

File tree

‎packages/message-list/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@
4242
"@vaadin/component-base": "24.0.0-alpha1",
4343
"@vaadin/vaadin-lumo-styles": "24.0.0-alpha1",
4444
"@vaadin/vaadin-material-styles": "24.0.0-alpha1",
45-
"@vaadin/vaadin-themable-mixin": "24.0.0-alpha1"
45+
"@vaadin/vaadin-themable-mixin": "24.0.0-alpha1",
46+
"lit": "^2.0.0"
4647
},
4748
"devDependencies": {
4849
"@esm-bundle/chai": "^4.3.4",

‎packages/message-list/src/vaadin-message-list.js‎

Lines changed: 28 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
* Copyright (c) 2021 - 2022 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6-
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
6+
import { html as legacyHtml, PolymerElement } from '@polymer/polymer/polymer-element.js';
7+
import { html, render } from 'lit';
8+
import { ifDefined } from 'lit/directives/if-defined.js';
79
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
810
import { KeyboardDirectionMixin } from '@vaadin/component-base/src/keyboard-direction-mixin.js';
911
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
@@ -78,7 +80,7 @@ class MessageList extends KeyboardDirectionMixin(ElementMixin(ThemableMixin(Poly
7880
}
7981

8082
static get template() {
81-
return html`
83+
return legacyHtml`
8284
<style>
8385
:host {
8486
display: block;
@@ -130,20 +132,7 @@ class MessageList extends KeyboardDirectionMixin(ElementMixin(ThemableMixin(Poly
130132
const focusedIndex = this._getIndexOfFocusableElement();
131133
const closeToBottom = this.scrollHeight < this.clientHeight + this.scrollTop + 50;
132134

133-
const removed = oldItems.filter((item) => !items.includes(item));
134-
const added = [...items];
135-
136-
this._messages.forEach((message) => {
137-
const item = message._item;
138-
if (removed.includes(item)) {
139-
message.remove();
140-
} else if (added.includes(item)) {
141-
added.splice(added.indexOf(item), 1);
142-
}
143-
});
144-
145-
this.__addMessages(added, items);
146-
135+
this._renderMessages(items);
147136
this._setTabIndexesByIndex(focusedIndex);
148137

149138
requestAnimationFrame(() => {
@@ -155,42 +144,29 @@ class MessageList extends KeyboardDirectionMixin(ElementMixin(ThemableMixin(Poly
155144
}
156145

157146
/** @private */
158-
__addMessages(itemsToAdd, allItems) {
159-
itemsToAdd.forEach((item) => {
160-
const message = this.__createMessage(item);
161-
const nextItem = allItems[allItems.indexOf(item) + 1];
162-
const nextMessage = this._messages.find((msg) => msg._item === nextItem);
163-
if (nextMessage) {
164-
this.insertBefore(message, nextMessage);
165-
} else {
166-
this.appendChild(message);
167-
}
168-
});
169-
}
170-
171-
/** @private */
172-
__createMessage(item) {
173-
const message = document.createElement('vaadin-message');
174-
message.setAttribute('role', 'listitem');
175-
176-
message.textContent = item.text;
177-
message.time = item.time;
178-
message.userName = item.userName;
179-
message.userAbbr = item.userAbbr;
180-
message.userImg = item.userImg;
181-
message.userColorIndex = item.userColorIndex;
182-
183-
message._item = item;
184-
185-
if (item.theme) {
186-
message.setAttribute('theme', item.theme);
187-
}
188-
189-
message.addEventListener('focusin', (e) => {
190-
this._onMessageFocusIn(e);
191-
});
192-
193-
return message;
147+
_renderMessages(items) {
148+
render(
149+
html`
150+
${items.map(
151+
(item) =>
152+
html`
153+
<vaadin-message
154+
role="listitem"
155+
.time="${item.time}"
156+
.userAbbr="${item.userAbbr}"
157+
.userName="${item.userName}"
158+
.userImg="${item.userImg}"
159+
.userColorIndex="${item.userColorIndex}"
160+
theme="${ifDefined(item.theme)}"
161+
@focusin="${this._onMessageFocusIn}"
162+
>${item.text}</vaadin-message
163+
>
164+
`,
165+
)}
166+
`,
167+
this,
168+
{ host: this },
169+
);
194170
}
195171

196172
/** @private */

‎packages/message-list/test/message-list.test.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,16 @@ describe('message-list', () => {
134134
expect(items.length).to.equal(3);
135135
expect(items[1].textContent).to.equal('Hi');
136136
});
137+
138+
it('should reuse existing vaadin-message element when updating items', async () => {
139+
const firstMessage = messageList.querySelector('vaadin-message');
140+
messageList.items = [messages[1], messages[2]];
141+
await nextRender();
142+
const items = messageList.querySelectorAll('vaadin-message');
143+
expect(items.length).to.equal(2);
144+
expect(items[0]).to.eql(firstMessage);
145+
expect(items[1]).to.not.eql(firstMessage);
146+
});
137147
});
138148

139149
describe('scroll', () => {

0 commit comments

Comments
 (0)