Skip to content

Commit 4b1c09b

Browse files
committed
refactor!: move vaadin-message elements to light DOM (#4710)
1 parent afd776e commit 4b1c09b

7 files changed

Lines changed: 251 additions & 179 deletions

File tree

‎packages/message-list/src/vaadin-message-list.d.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,15 @@ export interface MessageListItem {
2121
* `<vaadin-message-list>` is a Web Component for showing an ordered list of messages. The messages are rendered as <vaadin-message>
2222
*
2323
* ### Example
24+
*
2425
* To create a new message list, add the component to the page:
26+
*
2527
* ```html
2628
* <vaadin-message-list></vaadin-message-list>
2729
* ```
2830
*
29-
* Provide the messages to the message list with the `items` property.
31+
* Provide the messages to the message list with the [`items`](#/elements/vaadin-message-list#property-items) property.
32+
*
3033
* ```js
3134
* document.querySelector('vaadin-message-list').items = [
3235
* { text: 'Hello list', time: 'yesterday', userName: 'Matt Mambo', userAbbr: 'MM', userColorIndex: 1 },
@@ -42,6 +45,9 @@ export interface MessageListItem {
4245
* ----------|----------------
4346
* `list` | The container wrapping messages.
4447
*
48+
* See the [`<vaadin-message>`](#/elements/vaadin-message) documentation for the available
49+
* state attributes and stylable shadow parts of message elements.
50+
*
4551
* See [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.
4652
*/
4753
declare class MessageList extends KeyboardDirectionMixin(ThemableMixin(ElementMixin(HTMLElement))) {

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

Lines changed: 73 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
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 '@polymer/polymer/lib/elements/dom-repeat.js';
76
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
8-
import { microTask } from '@vaadin/component-base/src/async.js';
97
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
108
import { KeyboardDirectionMixin } from '@vaadin/component-base/src/keyboard-direction-mixin.js';
119
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
@@ -15,12 +13,15 @@ import { Message } from './vaadin-message.js';
1513
* `<vaadin-message-list>` is a Web Component for showing an ordered list of messages. The messages are rendered as <vaadin-message>
1614
*
1715
* ### Example
16+
*
1817
* To create a new message list, add the component to the page:
18+
*
1919
* ```html
2020
* <vaadin-message-list></vaadin-message-list>
2121
* ```
2222
*
23-
* Provide the messages to the message list with the `items` property.
23+
* Provide the messages to the message list with the [`items`](#/elements/vaadin-message-list#property-items) property.
24+
*
2425
* ```js
2526
* document.querySelector('vaadin-message-list').items = [
2627
* { text: 'Hello list', time: 'yesterday', userName: 'Matt Mambo', userAbbr: 'MM', userColorIndex: 1 },
@@ -36,6 +37,9 @@ import { Message } from './vaadin-message.js';
3637
* ----------|----------------
3738
* `list` | The container wrapping messages.
3839
*
40+
* See the [`<vaadin-message>`](#/elements/vaadin-message) documentation for the available
41+
* state attributes and stylable shadow parts of message elements.
42+
*
3943
* See [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.
4044
*
4145
* @extends HTMLElement
@@ -86,19 +90,7 @@ class MessageList extends KeyboardDirectionMixin(ElementMixin(ThemableMixin(Poly
8690
}
8791
</style>
8892
<div part="list" role="list">
89-
<template is="dom-repeat" items="[[items]]">
90-
<vaadin-message
91-
time="[[item.time]]"
92-
user-name="[[item.userName]]"
93-
user-abbr="[[item.userAbbr]]"
94-
user-img="[[item.userImg]]"
95-
user-color-index="[[item.userColorIndex]]"
96-
theme$="[[item.theme]]"
97-
role="listitem"
98-
on-focusin="_handleFocusEvent"
99-
>[[item.text]]</vaadin-message
100-
>
101-
</template>
93+
<slot></slot>
10294
</div>
10395
`;
10496
}
@@ -126,24 +118,81 @@ class MessageList extends KeyboardDirectionMixin(ElementMixin(ThemableMixin(Poly
126118

127119
/** @protected */
128120
get _messages() {
129-
return Array.from(this.shadowRoot.querySelectorAll('vaadin-message'));
121+
return [...this.querySelectorAll('vaadin-message')];
130122
}
131123

132124
/** @private */
133125
_itemsChanged(newVal, oldVal) {
134-
const focusedIndex = this._getIndexOfFocusableElement();
135-
if (newVal && newVal.length) {
136-
const moreItems = !oldVal || newVal.length > oldVal.length;
126+
const items = newVal || [];
127+
const oldItems = oldVal || [];
128+
129+
if (items.length || oldItems.length) {
130+
const focusedIndex = this._getIndexOfFocusableElement();
137131
const closeToBottom = this.scrollHeight < this.clientHeight + this.scrollTop + 50;
138-
microTask.run(() => {
139-
this._setTabIndexesByIndex(focusedIndex);
140-
if (moreItems && closeToBottom) {
132+
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+
147+
this._setTabIndexesByIndex(focusedIndex);
148+
149+
requestAnimationFrame(() => {
150+
if (items.length > oldItems.length && closeToBottom) {
141151
this._scrollToLastMessage();
142152
}
143153
});
144154
}
145155
}
146156

157+
/** @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;
194+
}
195+
147196
/** @private */
148197
_scrollToLastMessage() {
149198
if (this.items.length > 0) {
@@ -152,7 +201,7 @@ class MessageList extends KeyboardDirectionMixin(ElementMixin(ThemableMixin(Poly
152201
}
153202

154203
/** @private */
155-
_handleFocusEvent(e) {
204+
_onMessageFocusIn(e) {
156205
const target = e.composedPath().find((node) => node instanceof Message);
157206
this._setTabIndexesByMessage(target);
158207
}

‎packages/message-list/test/dom/__snapshots__/message-list.test.snap.js‎

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,18 @@
22
export const snapshots = {};
33

44
snapshots["vaadin-message-list default"] =
5-
`<div
6-
part="list"
7-
role="list"
5+
`<vaadin-message-list
6+
aria-relevant="additions"
7+
role="log"
88
>
9-
<dom-repeat style="display: none;">
10-
<template is="dom-repeat">
11-
</template>
12-
</dom-repeat>
13-
</div>
9+
</vaadin-message-list>
1410
`;
1511
/* end snapshot vaadin-message-list default */
1612

1713
snapshots["vaadin-message-list items"] =
18-
`<div
19-
part="list"
20-
role="list"
14+
`<vaadin-message-list
15+
aria-relevant="additions"
16+
role="log"
2117
>
2218
<vaadin-message
2319
role="listitem"
@@ -49,18 +45,14 @@ snapshots["vaadin-message-list items"] =
4945
>
5046
</vaadin-avatar>
5147
</vaadin-message>
52-
<dom-repeat style="display: none;">
53-
<template is="dom-repeat">
54-
</template>
55-
</dom-repeat>
56-
</div>
48+
</vaadin-message-list>
5749
`;
5850
/* end snapshot vaadin-message-list items */
5951

6052
snapshots["vaadin-message-list theme"] =
61-
`<div
62-
part="list"
63-
role="list"
53+
`<vaadin-message-list
54+
aria-relevant="additions"
55+
role="log"
6456
>
6557
<vaadin-message
6658
role="listitem"
@@ -78,11 +70,7 @@ snapshots["vaadin-message-list theme"] =
7870
>
7971
</vaadin-avatar>
8072
</vaadin-message>
81-
<dom-repeat style="display: none;">
82-
<template is="dom-repeat">
83-
</template>
84-
</dom-repeat>
85-
</div>
73+
</vaadin-message-list>
8674
`;
8775
/* end snapshot vaadin-message-list theme */
8876

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ describe('vaadin-message-list', () => {
1010
});
1111

1212
it('default', async () => {
13-
await expect(list).shadowDom.to.equalSnapshot();
13+
await expect(list).dom.to.equalSnapshot();
1414
});
1515

1616
it('items', async () => {
@@ -19,12 +19,12 @@ describe('vaadin-message-list', () => {
1919
{ text: 'Good morning!', userName: 'Lina Roy' },
2020
];
2121
await nextFrame();
22-
await expect(list).shadowDom.to.equalSnapshot();
22+
await expect(list).dom.to.equalSnapshot();
2323
});
2424

2525
it('theme', async () => {
2626
list.items = [{ text: 'Partial service outage.', userName: 'Admin', theme: 'danger' }];
2727
await nextFrame();
28-
await expect(list).shadowDom.to.equalSnapshot();
28+
await expect(list).dom.to.equalSnapshot();
2929
});
3030
});

0 commit comments

Comments
 (0)