Debian Codegraph @

packages/labs/virtualizer/src/test/scenarios/hidden.test.ts

raw
1 /**
2 * @license
3 * Copyright 2023 Google LLC
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7 import {ignoreBenignErrors} from '../helpers.js';
8 import {html, LitElement} from 'lit';
9 import {customElement, property} from 'lit/decorators.js';
10 import '../../lit-virtualizer.js';
11 import {expect, fixture} from '@open-wc/testing';
12
13 /*
14 This file contains regression tests for https://github.com/lit/lit/issues/3815
15 and https://github.com/lit/lit/issues/4672
16 */
17
18 type Item = {label: number};
19
20 @customElement('virtualizer-hider')
21 export class VirtualizerHider extends LitElement {
22 _list: Item[] = Array(100)
23 .fill('')
24 .map((_, index) => ({
25 label: index,
26 }));
27
28 @property({type: Boolean})
29 hidden = false;
30
31 render() {
32 return html`
33 <button @click=${() => (this.hidden = !this.hidden)}>Toggle</button>
34 <div style="display:${this.hidden ? 'none' : 'block'}">
35 <lit-virtualizer
36 .items=${this._list}
37 .renderItem=${({label}: Item) => html`<div>${label}</div>`}
38 ></lit-virtualizer>
39 </div>
40 `;
41 }
42 }
43
44 describe("Don't render any children if the virtualizer is hidden", () => {
45 ignoreBenignErrors(beforeEach, afterEach);
46
47 it('should not render any children when initially hidden', async () => {
48 const el = await fixture<VirtualizerHider>(html`
49 <virtualizer-hider hidden></virtualizer-hider>
50 `);
51 const virtualizer = el.shadowRoot!.querySelector('lit-virtualizer')!;
52 // We can't await on layoutComplete when first render is empty.
53 // See https://github.com/lit/lit/issues/4376
54 await new Promise((resolve) => setTimeout(resolve, 500));
55 expect(virtualizer.children.length).to.equal(0);
56 });
57
58 it('should not render any children when subsequently hidden', async () => {
59 const el = await fixture<VirtualizerHider>(html`
60 <virtualizer-hider></virtualizer-hider>
61 `);
62 const virtualizer = el.shadowRoot!.querySelector('lit-virtualizer')!;
63 await virtualizer.layoutComplete;
64 expect(virtualizer.children.length).to.be.greaterThan(0);
65
66 el.hidden = true;
67 await virtualizer.layoutComplete;
68 expect(virtualizer.children.length).to.equal(0);
69 });
70
71 // Issue #4672
72 it('should not render any children when hidden and nested beneath a clipping ancestor', async () => {
73 const clipper = await fixture<HTMLDivElement>(html`
74 <div style="overflow: hidden;">
75 <virtualizer-hider></virtualizer-hider>
76 </div>
77 `);
78 const el = clipper.querySelector('virtualizer-hider')! as VirtualizerHider;
79 const virtualizer = el.shadowRoot!.querySelector('lit-virtualizer')!;
80 await virtualizer.layoutComplete;
81 expect(virtualizer.children.length).to.be.greaterThan(0);
82
83 el.hidden = true;
84 await virtualizer.layoutComplete;
85 expect(virtualizer.children.length).to.equal(0);
86 });
87 });