| 1 |
/** |
| 2 |
* @license |
| 3 |
* Copyright 2022 Google LLC |
| 4 |
* SPDX-License-Identifier: BSD-3-Clause |
| 5 |
*/ |
| 6 |
|
| 7 |
import {array, ignoreBenignErrors, pass, until} from '../helpers.js'; |
| 8 |
import {LitVirtualizer} from '../../lit-virtualizer.js'; |
| 9 |
import {virtualize} from '../../virtualize.js'; |
| 10 |
import {RangeChangedEvent, VisibilityChangedEvent} from '../../events.js'; |
| 11 |
import {css, LitElement} from 'lit'; |
| 12 |
import {customElement, property} from 'lit/decorators.js'; |
| 13 |
import {expect, html, fixture} from '@open-wc/testing'; |
| 14 |
|
| 15 |
abstract class TestElement extends LitElement { |
| 16 |
static styles = css` |
| 17 |
.item { |
| 18 |
height: 50px; |
| 19 |
margin: 0; |
| 20 |
padding: 0; |
| 21 |
} |
| 22 |
`; |
| 23 |
|
| 24 |
@property({type: Object, attribute: false}) |
| 25 |
public selected = new Set<number>(); |
| 26 |
|
| 27 |
@property({type: Array, attribute: false}) |
| 28 |
public items: Array<number> = []; |
| 29 |
|
| 30 |
@property({type: Array, attribute: false}) |
| 31 |
public rangeChangedEvents: RangeChangedEvent[] = []; |
| 32 |
|
| 33 |
@property({type: Array, attribute: false}) |
| 34 |
public visibilityChangedEvents: VisibilityChangedEvent[] = []; |
| 35 |
|
| 36 |
recordRangeChangedEvent(event: RangeChangedEvent) { |
| 37 |
this.rangeChangedEvents.push(event); |
| 38 |
} |
| 39 |
|
| 40 |
recordVisibilityChangedEvent(event: VisibilityChangedEvent) { |
| 41 |
this.visibilityChangedEvents.push(event); |
| 42 |
} |
| 43 |
} |
| 44 |
|
| 45 |
@customElement('using-lit-virtualizer') |
| 46 |
class UsingLitVirtualizer extends TestElement { |
| 47 |
render() { |
| 48 |
return html` <lit-virtualizer |
| 49 |
@rangeChanged=${this.recordRangeChangedEvent} |
| 50 |
@visibilityChanged=${this.recordVisibilityChangedEvent} |
| 51 |
scroller |
| 52 |
.items=${this.items} |
| 53 |
.renderItem=${(n: number) => |
| 54 |
html`<div class="item"> |
| 55 |
[${n}${this.selected.has(n) ? ' selected' : ''}] |
| 56 |
</div>`} |
| 57 |
></lit-virtualizer>`; |
| 58 |
} |
| 59 |
} |
| 60 |
|
| 61 |
@customElement('using-virtualize-directive') |
| 62 |
class UsingVirtualizeDirective extends TestElement { |
| 63 |
render() { |
| 64 |
return html` <div |
| 65 |
@rangeChanged=${this.recordRangeChangedEvent} |
| 66 |
@visibilityChanged=${this.recordVisibilityChangedEvent} |
| 67 |
> |
| 68 |
${virtualize({ |
| 69 |
scroller: true, |
| 70 |
items: this.items, |
| 71 |
renderItem: (n) => |
| 72 |
html`<div class="item"> |
| 73 |
[${n}${this.selected.has(n) ? ' selected' : ''}] |
| 74 |
</div>`, |
| 75 |
})} |
| 76 |
</div>`; |
| 77 |
} |
| 78 |
} |
| 79 |
|
| 80 |
describe('test fixture classes', () => { |
| 81 |
it('are registered as custom elements', () => { |
| 82 |
expect(customElements.get('this-is-not-a-custom-element')).to.be.undefined; |
| 83 |
expect(customElements.get('lit-virtualizer')).to.eq(LitVirtualizer); |
| 84 |
expect(customElements.get('using-lit-virtualizer')).to.eq( |
| 85 |
UsingLitVirtualizer |
| 86 |
); |
| 87 |
expect(customElements.get('using-virtualize-directive')).to.eq( |
| 88 |
UsingVirtualizeDirective |
| 89 |
); |
| 90 |
}); |
| 91 |
}); |
| 92 |
|
| 93 |
describe('lit-virtualizer and virtualize directive', () => { |
| 94 |
ignoreBenignErrors(beforeEach, afterEach); |
| 95 |
|
| 96 |
/** |
| 97 |
* Regression test to cover the difference in behavior which led |
| 98 |
* to this issue: https://github.com/lit/lit/issues/3052 |
| 99 |
*/ |
| 100 |
it('both render changes based on non-item data changes', async () => { |
| 101 |
const items = array(100); |
| 102 |
const selected = new Set([2, 5]); |
| 103 |
|
| 104 |
const example = await fixture(html` |
| 105 |
<div> |
| 106 |
<using-lit-virtualizer></using-lit-virtualizer> |
| 107 |
<using-virtualize-directive></using-virtualize-directive> |
| 108 |
</div> |
| 109 |
<style> |
| 110 |
using-lit-virtualizer { |
| 111 |
height: 500px; |
| 112 |
} |
| 113 |
using-virtualize-directive { |
| 114 |
height: 500px; |
| 115 |
} |
| 116 |
</style> |
| 117 |
`); |
| 118 |
await until( |
| 119 |
() => |
| 120 |
example.querySelector('using-lit-virtualizer') instanceof |
| 121 |
UsingLitVirtualizer |
| 122 |
); |
| 123 |
await until( |
| 124 |
() => |
| 125 |
example.querySelector('using-virtualize-directive') instanceof |
| 126 |
UsingVirtualizeDirective |
| 127 |
); |
| 128 |
|
| 129 |
const ulv: UsingLitVirtualizer = example.querySelector( |
| 130 |
'using-lit-virtualizer' |
| 131 |
)!; |
| 132 |
const uvd: UsingVirtualizeDirective = example.querySelector( |
| 133 |
'using-virtualize-directive' |
| 134 |
)!; |
| 135 |
|
| 136 |
ulv.items = [...items]; |
| 137 |
uvd.items = [...items]; |
| 138 |
|
| 139 |
ulv.selected = selected; |
| 140 |
uvd.selected = selected; |
| 141 |
|
| 142 |
// Wait for events from initial render to fire. |
| 143 |
await pass(() => { |
| 144 |
expect(ulv.rangeChangedEvents.length).to.equal(3); |
| 145 |
expect(uvd.rangeChangedEvents.length).to.equal(3); |
| 146 |
|
| 147 |
expect(ulv.visibilityChangedEvents.length).to.equal(3); |
| 148 |
expect(uvd.visibilityChangedEvents.length).to.equal(3); |
| 149 |
}); |
| 150 |
|
| 151 |
// Clear initial events to make it easier to see what's happening with new events. |
| 152 |
ulv.rangeChangedEvents.length = 0; |
| 153 |
uvd.rangeChangedEvents.length = 0; |
| 154 |
ulv.visibilityChangedEvents.length = 0; |
| 155 |
uvd.visibilityChangedEvents.length = 0; |
| 156 |
|
| 157 |
await pass(() => { |
| 158 |
expect(ulv.shadowRoot?.textContent).to.include('[2 selected]'); |
| 159 |
expect(uvd.shadowRoot?.textContent).to.include('[2 selected]'); |
| 160 |
|
| 161 |
expect(ulv.shadowRoot?.textContent).to.include('[5 selected]'); |
| 162 |
expect(uvd.shadowRoot?.textContent).to.include('[5 selected]'); |
| 163 |
}); |
| 164 |
|
| 165 |
// Changing selection doesn't trigger visibility changed or range changed events. |
| 166 |
ulv.selected = new Set([1, 3]); |
| 167 |
uvd.selected = new Set([1, 3]); |
| 168 |
|
| 169 |
await pass(() => { |
| 170 |
expect(ulv.shadowRoot?.textContent).to.include('[1 selected]'); |
| 171 |
expect(uvd.shadowRoot?.textContent).to.include('[1 selected]'); |
| 172 |
|
| 173 |
expect(ulv.shadowRoot?.textContent).to.include('[3 selected]'); |
| 174 |
expect(uvd.shadowRoot?.textContent).to.include('[3 selected]'); |
| 175 |
|
| 176 |
expect(ulv.shadowRoot?.textContent).not.to.include('[2 selected]'); |
| 177 |
expect(uvd.shadowRoot?.textContent).not.to.include('[2 selected]'); |
| 178 |
|
| 179 |
expect(ulv.shadowRoot?.textContent).not.to.include('[5 selected]'); |
| 180 |
expect(uvd.shadowRoot?.textContent).not.to.include('[5 selected]'); |
| 181 |
}); |
| 182 |
|
| 183 |
// Adding an item to the start of the list to trigger rangechanged events. |
| 184 |
ulv.items = [-1, ...items]; |
| 185 |
uvd.items = [-1, ...items]; |
| 186 |
|
| 187 |
await pass(() => { |
| 188 |
expect(ulv.shadowRoot?.textContent).to.include('[-1]'); |
| 189 |
expect(uvd.shadowRoot?.textContent).to.include('[-1]'); |
| 190 |
|
| 191 |
expect(ulv.rangeChangedEvents.length).to.equal(1); |
| 192 |
expect(uvd.rangeChangedEvents.length).to.equal(1); |
| 193 |
}); |
| 194 |
|
| 195 |
// The indexes of visible items have not changed even though new item was |
| 196 |
// added to head of the array. So no visibilitychanged events are expected. |
| 197 |
expect(ulv.visibilityChangedEvents.length).to.equal(0); |
| 198 |
expect(uvd.visibilityChangedEvents.length).to.equal(0); |
| 199 |
}); |
| 200 |
}); |