Skip to content

Commit f17c90a

Browse files
authored
refactor: message-list dynamic markdown import (#9107)
* refactor: message-list dynamic markdown import * refactor: revert back to using vaadin-markdown
1 parent bc1f4de commit f17c90a

11 files changed

Lines changed: 65 additions & 8 deletions

‎packages/markdown/theme/lumo/vaadin-markdown-styles.js‎

Whitespace-only changes.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
import './vaadin-markdown-styles.js';
12
import '../../src/vaadin-markdown.js';

‎packages/markdown/theme/material/vaadin-markdown-styles.js‎

Whitespace-only changes.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
import './vaadin-markdown-styles.js';
12
import '../../src/vaadin-markdown.js';

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
* Copyright (c) 2021 - 2025 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6-
import '@vaadin/markdown/src/vaadin-markdown.js';
76
import { html, render } from 'lit';
87
import { ifDefined } from 'lit/directives/if-defined.js';
98
import { KeyboardDirectionMixin } from '@vaadin/a11y-base/src/keyboard-direction-mixin.js';
@@ -98,12 +97,23 @@ export const MessageListMixin = (superClass) =>
9897
}
9998

10099
/** @private */
101-
__markdownChanged(_markdown) {
100+
__markdownChanged(markdown) {
101+
if (markdown && !customElements.get('vaadin-markdown')) {
102+
// Dynamically import the markdown component
103+
import('@vaadin/markdown/src/vaadin-markdown.js')
104+
// Wait until the component is defined
105+
.then(() => customElements.whenDefined('vaadin-markdown'))
106+
// Render the messages again
107+
.then(() => this._renderMessages(this.items));
108+
}
102109
this._renderMessages(this.items);
103110
}
104111

105112
/** @private */
106113
_renderMessages(items) {
114+
// Check if markdown component is still loading
115+
const loadingMarkdown = this.markdown && !customElements.get('vaadin-markdown');
116+
107117
render(
108118
html`
109119
${items.map(
@@ -118,6 +128,7 @@ export const MessageListMixin = (superClass) =>
118128
theme="${ifDefined(item.theme)}"
119129
class="${ifDefined(item.className)}"
120130
@focusin="${this._onMessageFocusIn}"
131+
style="${ifDefined(loadingMarkdown ? 'visibility: hidden' : undefined)}"
121132
>${this.markdown
122133
? html`<vaadin-markdown .content=${item.text}></vaadin-markdown>`
123134
: item.text}<vaadin-avatar slot="avatar"></vaadin-avatar
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
import { expect } from '@vaadin/chai-plugins';
2+
import { fixtureSync } from '@vaadin/testing-helpers';
3+
import '../src/vaadin-message-list.js';
4+
5+
async function until(predicate) {
6+
while (!predicate()) {
7+
await new Promise((r) => {
8+
setTimeout(r, 10);
9+
});
10+
}
11+
return predicate();
12+
}
13+
14+
describe('message-list-markdown dynamic import', () => {
15+
let messageList;
16+
const messages = [
17+
{
18+
text: 'This is a **bold text** in Markdown',
19+
time: '10:00 AM',
20+
userName: 'Markdown User',
21+
userAbbr: 'MU',
22+
},
23+
];
24+
25+
beforeEach(() => {
26+
messageList = fixtureSync('<vaadin-message-list></vaadin-message-list>');
27+
});
28+
29+
it('should not render incorrect content during import', async () => {
30+
messageList.markdown = true;
31+
messageList.items = messages;
32+
33+
// Expect the markdown to not exist in DOM as such
34+
expect(messageList.textContent).to.not.include('**bold text**');
35+
36+
// Expect the markdown to be rendered as HTML eventually
37+
await until(() => messageList.querySelector('vaadin-message strong')?.textContent === 'bold text');
38+
});
39+
});

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { expect } from '@vaadin/chai-plugins';
2-
import { fixtureSync, nextUpdate } from '@vaadin/testing-helpers';
2+
import { fixtureSync, nextFrame, nextUpdate } from '@vaadin/testing-helpers';
33
import '../src/vaadin-message-list.js';
44

55
describe('message-list-markdown', () => {
@@ -16,7 +16,8 @@ describe('message-list-markdown', () => {
1616
beforeEach(async () => {
1717
messageList = fixtureSync('<vaadin-message-list markdown></vaadin-message-list>');
1818
messageList.items = messages;
19-
await nextUpdate(messageList);
19+
await customElements.whenDefined('vaadin-markdown');
20+
await nextFrame();
2021
});
2122

2223
it('should render the message items as markdown', () => {

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { sendKeys } from '@vaadin/test-runner-commands';
2-
import { fixtureSync, nextRender } from '@vaadin/testing-helpers';
2+
import { fixtureSync, nextFrame, nextRender } from '@vaadin/testing-helpers';
33
import { visualDiff } from '@web/test-runner-visual-regression';
44
import '../../../theme/lumo/vaadin-message-list.js';
55

@@ -64,6 +64,8 @@ describe('message-list', () => {
6464
element.items[0].text = 'This is a **bold text** in Markdown';
6565
element.items = [...element.items];
6666
element.markdown = true;
67+
await customElements.whenDefined('vaadin-markdown');
68+
await nextFrame();
6769
await visualDiff(div, `${dir}-markdown`);
6870
});
6971
});

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { sendKeys } from '@vaadin/test-runner-commands';
2-
import { fixtureSync, nextRender } from '@vaadin/testing-helpers';
2+
import { fixtureSync, nextFrame, nextRender } from '@vaadin/testing-helpers';
33
import { visualDiff } from '@web/test-runner-visual-regression';
44
import '../../../theme/material/vaadin-message-list.js';
55

@@ -64,6 +64,8 @@ describe('message-list', () => {
6464
element.items[0].text = 'This is a **bold text** in Markdown';
6565
element.items = [...element.items];
6666
element.markdown = true;
67+
await customElements.whenDefined('vaadin-markdown');
68+
await nextFrame();
6769
await visualDiff(div, `${dir}-markdown`);
6870
});
6971
});
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
import '@vaadin/markdown/theme/lumo/vaadin-markdown.js';
1+
import '@vaadin/markdown/theme/lumo/vaadin-markdown-styles.js';
22
import './vaadin-message-list-styles.js';
33
import '../../src/vaadin-message-list.js';

0 commit comments

Comments
 (0)