Debian Codegraph @

packages/labs/virtualizer/src/test/scenarios/visibility-changed-events.test.ts

raw
1 /**
2 * @license
3 * Copyright 2022 Google LLC
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7 import {
8 array,
9 first,
10 ignoreBenignErrors,
11 isInViewport,
12 last,
13 pass,
14 until,
15 } from '../helpers.js';
16 import {LitVirtualizer} from '../../lit-virtualizer.js';
17 import {VisibilityChangedEvent} from '../../events.js';
18 import {expect, html, fixture} from '@open-wc/testing';
19
20 describe('VisibilityChanged event', () => {
21 ignoreBenignErrors(beforeEach, afterEach);
22
23 async function createVirtualizer<T>(properties: {items: T[]}) {
24 const container = await fixture(
25 html` <div>
26 <style>
27 lit-virtualizer {
28 height: 200px;
29 width: 200px;
30 }
31 .item {
32 width: 200px;
33 height: 50px;
34 margin: 0;
35 padding: 0;
36 }
37 </style>
38 <lit-virtualizer
39 scroller
40 .items=${properties.items}
41 .renderItem=${(item: T) => html`<div class="item">${item}</div>`}
42 ></lit-virtualizer>
43 </div>`
44 );
45 const virtualizer = (await until(() =>
46 container.querySelector('lit-virtualizer')
47 )) as LitVirtualizer;
48 expect(virtualizer).to.be.instanceof(LitVirtualizer);
49 return {container, virtualizer};
50 }
51
52 function getVisibleItems(virtualizer: LitVirtualizer) {
53 return Array.from(virtualizer.renderRoot.querySelectorAll('.item')).filter(
54 (e) => isInViewport(e, virtualizer)
55 ) as HTMLElement[];
56 }
57
58 it('should fire when item moves into view', async () => {
59 const items = array(1000);
60 const {container, virtualizer} = await createVirtualizer({items});
61 const containerEvents: VisibilityChangedEvent[] = [];
62 const virtualizerEvents: VisibilityChangedEvent[] = [];
63
64 await pass(() => expect(getVisibleItems(virtualizer).length).to.equal(4));
65
66 container.addEventListener('visibilityChanged', (e) => {
67 containerEvents.push(e as VisibilityChangedEvent);
68 });
69
70 virtualizer.addEventListener('visibilityChanged', (e) => {
71 virtualizerEvents.push(e as VisibilityChangedEvent);
72 });
73
74 first(getVisibleItems(virtualizer)).style.height = '10px';
75
76 await pass(() => expect(virtualizerEvents.length).to.equal(1));
77
78 expect(last(virtualizerEvents).first).to.equal(0);
79 expect(last(virtualizerEvents).last).to.equal(4);
80
81 // The visibilitychanged event should not bubble up to its containing element.
82 expect(containerEvents.length).to.equal(0);
83 });
84
85 it('should fire when item moves out of view', async () => {
86 const items = array(1000);
87 const {container, virtualizer} = await createVirtualizer({items});
88 const containerEvents: VisibilityChangedEvent[] = [];
89 const virtualizerEvents: VisibilityChangedEvent[] = [];
90
91 await pass(() => expect(getVisibleItems(virtualizer).length).to.equal(4));
92
93 container.addEventListener('visibilityChanged', (e) => {
94 containerEvents.push(e as VisibilityChangedEvent);
95 });
96
97 virtualizer.addEventListener('visibilityChanged', (e) => {
98 virtualizerEvents.push(e as VisibilityChangedEvent);
99 });
100
101 first(getVisibleItems(virtualizer)).style.height = '100px';
102
103 await pass(() => expect(virtualizerEvents.length).to.equal(1));
104
105 expect(last(virtualizerEvents).first).to.equal(0);
106 expect(last(virtualizerEvents).last).to.equal(2);
107
108 // The visibilitychanged event should not bubble up to its containing element.
109 expect(containerEvents.length).to.equal(0);
110 });
111
112 it('should fire visibilityChanged even when other state (e.g, range) does not change', async () => {
113 const items = array(1000);
114 const {virtualizer} = await createVirtualizer({items});
115 const virtualizerEvents: VisibilityChangedEvent[] = [];
116
117 virtualizer.addEventListener('visibilityChanged', (e) => {
118 virtualizerEvents.push(e as VisibilityChangedEvent);
119 });
120
121 await new Promise(requestAnimationFrame);
122 await pass(() => expect(virtualizerEvents.length).to.be.greaterThan(0));
123
124 expect(last(virtualizerEvents).first).to.equal(0);
125
126 virtualizer.scrollTo({top: 1000, behavior: 'smooth'});
127 await pass(() => expect(virtualizer.scrollTop).to.equal(1000));
128 expect(last(virtualizerEvents).first).to.be.greaterThan(0);
129
130 virtualizer.scrollTo({top: 0, behavior: 'smooth'});
131 await pass(() => expect(virtualizer.scrollTop).to.equal(0));
132 expect(last(virtualizerEvents).first).to.equal(0);
133 });
134 });