Skip to content

Commit 7a9e995

Browse files
authored
test: update grid visual tests not to use templates (#5435)
1 parent 80c16b6 commit 7a9e995

11 files changed

Lines changed: 407 additions & 799 deletions

File tree

Lines changed: 382 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,382 @@
1+
import { click, fixtureSync, nextRender } from '@vaadin/testing-helpers';
2+
import { sendKeys } from '@web/test-runner-commands';
3+
import { visualDiff } from '@web/test-runner-visual-regression';
4+
import { flushGrid } from '../helpers.js';
5+
import { users } from './users.js';
6+
7+
describe('grid', () => {
8+
let element;
9+
10+
['ltr', 'rtl'].forEach((dir) => {
11+
describe(dir, () => {
12+
before(() => {
13+
document.documentElement.setAttribute('dir', dir);
14+
});
15+
16+
after(() => {
17+
document.documentElement.removeAttribute('dir');
18+
});
19+
20+
describe('header and footer', () => {
21+
beforeEach(async () => {
22+
element = fixtureSync(`
23+
<vaadin-grid size="200" style="width: 200px; height: 100px">
24+
<vaadin-grid-column header="header"></vaadin-grid-column>
25+
</vaadin-grid>
26+
`);
27+
element.rowDetailsRenderer = (root, _grid, model) => {
28+
root.textContent = model.index;
29+
};
30+
const column = element.querySelector('vaadin-grid-column');
31+
column.footerRenderer = (root) => {
32+
root.textContent = 'footer';
33+
};
34+
column.renderer = (root, _column, model) => {
35+
root.textContent = model.index;
36+
};
37+
38+
element.items = users;
39+
flushGrid(element);
40+
await nextRender(element);
41+
});
42+
43+
it('header footer', async () => {
44+
await visualDiff(element, `${dir}-header-footer`);
45+
});
46+
});
47+
48+
describe('column groups', () => {
49+
beforeEach(async () => {
50+
element = fixtureSync(`
51+
<vaadin-grid style="height: 250px" column-reordering-allowed>
52+
<vaadin-grid-column width="30px" flex-grow="0" resizable header="#"></vaadin-grid-column>
53+
54+
<vaadin-grid-column-group resizable header="Name">
55+
<vaadin-grid-column width="calc(20% - 50px)" path="name.first"></vaadin-grid-column>
56+
<vaadin-grid-column width="calc(20% - 50px)" path="name.last"></vaadin-grid-column>
57+
</vaadin-grid-column-group>
58+
59+
<vaadin-grid-column-group resizable header="Location">
60+
<vaadin-grid-column width="calc(20% - 50px)" path="location.city"></vaadin-grid-column>
61+
<vaadin-grid-column width="calc(20% - 50px)" path="location.state"></vaadin-grid-column>
62+
<vaadin-grid-column width="200px" resizable path="location.street"></vaadin-grid-column>
63+
</vaadin-grid-column-group>
64+
</vaadin-grid>
65+
`);
66+
element.items = users;
67+
const indexColumn = element.querySelector('vaadin-grid-column[header="#"]');
68+
indexColumn.renderer = (root, _column, model) => {
69+
root.textContent = model.index;
70+
};
71+
72+
flushGrid(element);
73+
await nextRender(element);
74+
});
75+
76+
it('column groups', async () => {
77+
await visualDiff(element, `${dir}-column-groups`);
78+
});
79+
});
80+
81+
describe('row details', () => {
82+
beforeEach(async () => {
83+
element = fixtureSync(`
84+
<vaadin-grid>
85+
<vaadin-grid-column-group>
86+
<vaadin-grid-column width="55px" flex-grow="0"></vaadin-grid-column>
87+
<vaadin-grid-column resizable path="email"></vaadin-grid-column>
88+
<vaadin-grid-column path="location.city"></vaadin-grid-column>
89+
<vaadin-grid-column path="location.state"></vaadin-grid-column>
90+
</vaadin-grid-column-group>
91+
</vaadin-grid>
92+
`);
93+
element.items = users;
94+
element.rowDetailsRenderer = (root, _grid, model) => {
95+
root.innerHTML = `
96+
<div class="details-cell">
97+
<h1>Hi, I'm ${model.item.name.first}</h1>
98+
</div>
99+
`;
100+
};
101+
102+
const columnGroup = element.querySelector('vaadin-grid-column-group');
103+
columnGroup.headerRenderer = (root) => {
104+
root.innerHTML = `
105+
<div class="header-content">
106+
<b>1-200 of 15,554</b>
107+
<input placeholder="Search profiles" focus-target />
108+
</div>
109+
`;
110+
};
111+
112+
const firstColumn = element.querySelector('vaadin-grid-column');
113+
firstColumn.renderer = (root, _column, model) => {
114+
if (!root.firstElementChild) {
115+
root.innerHTML = `<input type="checkbox">`;
116+
root.firstElementChild.addEventListener('change', ({ target }) => {
117+
if (target.checked) {
118+
element.selectItem(target.__item);
119+
} else {
120+
element.deselectItem(target.__item);
121+
}
122+
});
123+
}
124+
const checkbox = root.firstElementChild;
125+
checkbox.__item = model.item;
126+
checkbox.checked = model.selected;
127+
};
128+
129+
flushGrid(element);
130+
await nextRender(element);
131+
});
132+
133+
it('row details', async () => {
134+
element.openItemDetails(element.items[0]);
135+
await visualDiff(element, `${dir}-row-details`);
136+
});
137+
});
138+
139+
describe('sorting', () => {
140+
let firstSorter, secondSorter;
141+
142+
beforeEach(async () => {
143+
element = fixtureSync(`
144+
<vaadin-grid style="height: 250px" multi-sort>
145+
<vaadin-grid-column width="50px" header="#"></vaadin-grid-column>
146+
<vaadin-grid-sort-column path="name.first" header="First name"></vaadin-grid-sort-column>
147+
<vaadin-grid-sort-column path="name.last" header="Last name"></vaadin-grid-sort-column>
148+
</vaadin-grid>
149+
`);
150+
element.items = users;
151+
const indexColumn = element.querySelector('vaadin-grid-column[header="#"]');
152+
indexColumn.renderer = (root, _column, model) => {
153+
root.textContent = model.index;
154+
};
155+
156+
flushGrid(element);
157+
await nextRender(element);
158+
const sorters = [...document.querySelectorAll('vaadin-grid-sorter')];
159+
firstSorter = sorters.find((sorter) => sorter.textContent === 'First name');
160+
secondSorter = sorters.find((sorter) => sorter.textContent === 'Last name');
161+
});
162+
163+
it('initial', async () => {
164+
await visualDiff(element, `${dir}-sorting-initial`);
165+
});
166+
167+
it('single asc', async () => {
168+
click(firstSorter);
169+
await visualDiff(element, `${dir}-sorting-single-asc`);
170+
});
171+
172+
it('multi asc asc', async () => {
173+
click(firstSorter);
174+
click(secondSorter);
175+
await visualDiff(element, `${dir}-sorting-multi-asc-asc`);
176+
});
177+
178+
it('multi asc desc', async () => {
179+
click(firstSorter);
180+
click(secondSorter);
181+
click(secondSorter);
182+
await visualDiff(element, `${dir}-sorting-multi-asc-desc`);
183+
});
184+
185+
it('single desc', async () => {
186+
click(firstSorter);
187+
click(firstSorter);
188+
await visualDiff(element, `${dir}-sorting-single-desc`);
189+
});
190+
});
191+
192+
describe('row focus', () => {
193+
beforeEach(async () => {
194+
element = fixtureSync(`
195+
<vaadin-grid style="width: 550px">
196+
<vaadin-grid-column-group header="Name" frozen>
197+
<vaadin-grid-column path="name.first" width="200px" flex-shrink="0"></vaadin-grid-column>
198+
<vaadin-grid-column path="name.last" width="200px" flex-shrink="0"></vaadin-grid-column>
199+
</vaadin-grid-column-group>
200+
<vaadin-grid-column path="location.city" width="200px" flex-shrink="0"></vaadin-grid-column>
201+
</vaadin-grid>
202+
`);
203+
element.items = users;
204+
flushGrid(element);
205+
206+
// Scroll all the way to end
207+
element.$.table.scrollLeft = element.__isRTL ? -1000 : 1000;
208+
209+
// Focus a header row
210+
await sendKeys({ press: 'Tab' });
211+
// Switch to row focus mode
212+
await sendKeys({ press: element.__isRTL ? 'ArrowRight' : 'ArrowLeft' });
213+
// Tab to body row
214+
await sendKeys({ press: 'Tab' });
215+
216+
await nextRender(element);
217+
});
218+
219+
it('row focus', async () => {
220+
await visualDiff(element, `${dir}-row-focus`);
221+
});
222+
223+
it('row focus - header', async () => {
224+
// Focus a header row
225+
element.tabIndex = 0;
226+
element.focus();
227+
await sendKeys({ press: 'Tab' });
228+
229+
await visualDiff(element, `${dir}-row-focus-header`);
230+
});
231+
});
232+
233+
describe('frozen', () => {
234+
beforeEach(() => {
235+
element = fixtureSync(`
236+
<vaadin-grid style="max-width: 600px">
237+
<vaadin-grid-column path="name.first" width="200px" flex-shrink="0" frozen></vaadin-grid-column>
238+
<vaadin-grid-column path="name.last" width="200px" flex-shrink="0" ></vaadin-grid-column>
239+
<vaadin-grid-column path="location.city" width="200px" flex-shrink="0"></vaadin-grid-column>
240+
<vaadin-grid-column path="location.state" width="200px" flex-shrink="0" frozen-to-end></vaadin-grid-column>
241+
</vaadin-grid>
242+
`);
243+
element.items = users;
244+
flushGrid(element);
245+
});
246+
247+
it('start', async () => {
248+
await visualDiff(element, `${dir}-frozen-start`);
249+
});
250+
251+
it('middle', async () => {
252+
element.$.table.scrollLeft = element.__isRTL ? -180 : 180;
253+
await visualDiff(element, `${dir}-frozen-middle`);
254+
});
255+
256+
it('end', async () => {
257+
element.$.table.scrollLeft = element.__isRTL ? -400 : 400;
258+
await visualDiff(element, `${dir}-frozen-end`);
259+
});
260+
});
261+
});
262+
});
263+
264+
describe('drag and drop', () => {
265+
beforeEach(async () => {
266+
element = fixtureSync(`
267+
<vaadin-grid drop-mode="on-top-or-between" rows-draggable>
268+
<vaadin-grid-column path="name.first" header="First name"></vaadin-grid-column>
269+
<vaadin-grid-column path="name.last" header="Last name"></vaadin-grid-column>
270+
<vaadin-grid-column path="email"></vaadin-grid-column>
271+
</vaadin-grid>
272+
`);
273+
element.rowDetailsRenderer = (root) => {
274+
root.innerHTML = '<p>Details</p>';
275+
};
276+
element.items = users;
277+
flushGrid(element);
278+
await nextRender(element);
279+
});
280+
281+
it('dragover', async () => {
282+
element.setAttribute('dragover', '');
283+
await visualDiff(element, 'dragover');
284+
});
285+
286+
it('dragover on top', async () => {
287+
element.$.items.children[1].setAttribute('dragover', 'on-top');
288+
await visualDiff(element, 'row-dragover-on-top');
289+
});
290+
291+
it('dragover above', async () => {
292+
element.$.items.children[1].setAttribute('dragover', 'above');
293+
await visualDiff(element, 'row-dragover-above');
294+
});
295+
296+
it('dragover below', async () => {
297+
element.$.items.children[1].setAttribute('dragover', 'below');
298+
await visualDiff(element, 'row-dragover-below');
299+
});
300+
301+
it('dragover above details', async () => {
302+
element.detailsOpenedItems = [element.items[1]];
303+
element.$.items.children[1].setAttribute('dragover', 'above');
304+
await visualDiff(element, 'row-dragover-above-details');
305+
});
306+
307+
it('dragover below details', async () => {
308+
element.detailsOpenedItems = [element.items[1]];
309+
element.$.items.children[1].setAttribute('dragover', 'below');
310+
await visualDiff(element, 'row-dragover-below-details');
311+
});
312+
313+
it('dragover row dragstart', async () => {
314+
element.$.items.children[1].setAttribute('dragstart', '123');
315+
await visualDiff(element, 'row-dragstart');
316+
});
317+
318+
it('dragover below last row with all rows visible', async () => {
319+
element.allRowsVisible = true;
320+
element.items = element.items.slice(0, 2);
321+
element.$.items.children[1].setAttribute('dragover', 'below');
322+
await visualDiff(element, 'dragover-below-last-row-all-rows-visible');
323+
});
324+
});
325+
326+
describe('disabled', () => {
327+
beforeEach(async () => {
328+
element = fixtureSync(`
329+
<vaadin-grid>
330+
<vaadin-grid-column path="name.first" header="First name"></vaadin-grid-column>
331+
<vaadin-grid-column path="name.last" header="Last name"></vaadin-grid-column>
332+
<vaadin-grid-column path="email"></vaadin-grid-column>
333+
</vaadin-grid>
334+
`);
335+
element.items = users;
336+
flushGrid(element);
337+
await nextRender(element);
338+
});
339+
340+
it('disabled', async () => {
341+
element.disabled = true;
342+
await visualDiff(element, 'disabled');
343+
});
344+
});
345+
346+
describe('tree', () => {
347+
beforeEach(async () => {
348+
element = fixtureSync(`
349+
<vaadin-grid item-id-path="name">
350+
<vaadin-grid-tree-column path="name" width="200px" flex-shrink="0"></vaadin-grid-tree-column>
351+
<vaadin-grid-column path="name" width="200px" flex-shrink="0"></vaadin-grid-column>
352+
</vaadin-grid>
353+
`);
354+
element.dataProvider = ({ parentItem, page, pageSize }, cb) => {
355+
// Let's have 10 root-level items and 3 items on every child level
356+
const levelSize = parentItem ? 3 : 10;
357+
358+
const pageItems = [...Array(Math.min(levelSize, pageSize))].map((_, i) => {
359+
const indexInLevel = page * pageSize + i;
360+
361+
return {
362+
name: `Very long grid item name ${parentItem ? `${parentItem.name}-` : ''}${indexInLevel}`,
363+
children: true,
364+
};
365+
});
366+
367+
cb(pageItems, levelSize);
368+
};
369+
flushGrid(element);
370+
await nextRender(element);
371+
});
372+
373+
it('default', async () => {
374+
await visualDiff(element, 'tree-default');
375+
});
376+
377+
it('overflow', async () => {
378+
element.style.maxWidth = '400px';
379+
await visualDiff(element, 'tree-overflow');
380+
});
381+
});
382+
});

0 commit comments

Comments
 (0)