test: merge combo-box item renderer and class name generator tests (#10241) (#10243)

Author: web-padawan

packages/combo-box/test/item-class-name-generator.test.js

@@ -0,0 +1,195 @@
+import { expect } from '@vaadin/chai-plugins';
+import { fixtureSync, nextRender } from '@vaadin/testing-helpers';
+import sinon from 'sinon';
+import '../src/vaadin-combo-box.js';
+import { getAllItems, getFirstItem, setInputValue } from './helpers.js';
+
+describe('items', () => {
+  let comboBox;
+
+  describe('renderer', () => {
+    beforeEach(async () => {
+      comboBox = fixtureSync('<vaadin-combo-box></vaadin-combo-box>');
+      await nextRender();
+      comboBox.items = ['foo', 'bar', 'baz'];
+    });
+
+    describe('arguments', () => {
+      beforeEach(() => {
+        comboBox.renderer = sinon.spy();
+        comboBox.opened = true;
+      });
+
+      it(`should pass the 'root', 'owner', 'model' arguments to the renderer`, () => {
+        const [root, owner, model] = comboBox.renderer.args[0];
+
+        expect(root.localName).to.equal('vaadin-combo-box-item');
+        expect(owner).to.equal(comboBox);
+        expect(model).to.deep.equal({
+          item: 'foo',
+          index: 0,
+          focused: false,
+          selected: false,
+        });
+      });
+
+      it(`should change the 'model.selected' property`, () => {
+        comboBox.value = 'foo';
+
+        const model = comboBox.renderer.lastCall.args[2];
+
+        expect(model.selected).to.be.true;
+      });
+
+      it(`should change the 'model.focused' property`, () => {
+        comboBox._focusedIndex = 0;
+
+        const model = comboBox.renderer.lastCall.args[2];
+
+        expect(model.focused).to.be.true;
+      });
+    });
+
+    it('should use renderer when it is defined', () => {
+      comboBox.renderer = (root, _comboBox, model) => {
+        const textNode = document.createTextNode(`${model.item} ${model.index}`);
+        root.appendChild(textNode);
+      };
+      comboBox.opened = true;
+
+      expect(getFirstItem(comboBox).textContent.trim()).to.equal('foo 0');
+    });
+
+    it('should run renderers when requesting content update', () => {
+      comboBox.renderer = sinon.spy();
+      comboBox.opened = true;
+
+      expect(comboBox.renderer.callCount).to.be.equal(comboBox.items.length);
+
+      comboBox.requestContentUpdate();
+
+      expect(comboBox.renderer.callCount).to.be.equal(comboBox.items.length * 2);
+    });
+
+    it('should not run renderers for invisible items', () => {
+      // Set up an item renderer that maps item data to DOM elements.
+      const itemContents = {
+        foo: document.createElement('div'),
+        bar: document.createElement('div'),
+        baz: document.createElement('div'),
+      };
+      comboBox.renderer = (root, _, { item }) => {
+        root.textContent = '';
+        root.appendChild(itemContents[item]);
+      };
+      comboBox.opened = true;
+
+      // Filter the items
+      // This renders `bar` into the first item now, and hides the other items.
+      // However, the second item still has `bar` as item data.
+      setInputValue(comboBox, 'bar');
+
+      const filteredItem = getAllItems(comboBox)[0];
+      expect(filteredItem.children.length).to.equal(1);
+      expect(filteredItem.children[0]).to.equal(itemContents.bar);
+
+      // Now run requestContentUpdate. This should only render the first item, but
+      // not the second one. We test this by verifying that the `bar` item content
+      // was not moved to the second item by its renderer.
+      comboBox.requestContentUpdate();
+
+      const allItems = getAllItems(comboBox);
+      expect(allItems[0].children.length).to.equal(1);
+      expect(allItems[0].children[0]).to.equal(itemContents.bar);
+    });
+
+    it('should not throw if requestContentUpdate() called before opening', () => {
+      expect(() => comboBox.requestContentUpdate()).not.to.throw(Error);
+    });
+
+    it('should render the item label when removing the renderer', () => {
+      comboBox.renderer = (root) => {
+        root.textContent = 'bar';
+      };
+      comboBox.opened = true;
+
+      expect(getFirstItem(comboBox).textContent).to.equal('bar');
+
+      comboBox.renderer = null;
+
+      expect(getFirstItem(comboBox).textContent).to.equal('foo');
+    });
+
+    it('should clear the old content after assigning a new renderer', () => {
+      comboBox.opened = true;
+      comboBox.renderer = () => {};
+      expect(getFirstItem(comboBox).textContent).to.equal('');
+    });
+
+    it('should restore filtered item content', () => {
+      const contentNodes = comboBox.items.map((item) => document.createTextNode(item));
+
+      comboBox.renderer = (root, _, { item }) => {
+        root.textContent = '';
+        root.append(contentNodes[comboBox.items.indexOf(item)]);
+      };
+
+      comboBox.opened = true;
+      setInputValue(comboBox, 'r');
+      setInputValue(comboBox, '');
+      expect(getAllItems(comboBox)[1].textContent).to.equal('bar');
+    });
+  });
+
+  describe('itemClassNameGenerator', () => {
+    beforeEach(async () => {
+      comboBox = fixtureSync('<vaadin-combo-box></vaadin-combo-box>');
+      await nextRender();
+      comboBox.items = ['foo', 'bar', 'baz'];
+    });
+
+    it('should set class name on dropdown items', async () => {
+      comboBox.itemClassNameGenerator = (item) => `item-${item}`;
+      comboBox.open();
+      await nextRender();
+      const items = getAllItems(comboBox);
+      expect(items[0].className).to.equal('item-foo');
+      expect(items[1].className).to.equal('item-bar');
+      expect(items[2].className).to.equal('item-baz');
+    });
+
+    it('should remove class name when return value is empty string', async () => {
+      comboBox.itemClassNameGenerator = (item) => `item-${item}`;
+      comboBox.open();
+      await nextRender();
+
+      comboBox.close();
+      comboBox.itemClassNameGenerator = () => '';
+
+      comboBox.open();
+      await nextRender();
+
+      const items = getAllItems(comboBox);
+      expect(items[0].className).to.equal('');
+      expect(items[1].className).to.equal('');
+      expect(items[2].className).to.equal('');
+    });
+
+    it('should remove class name when generator is set to null', async () => {
+      comboBox.itemClassNameGenerator = (item) => `item-${item}`;
+      comboBox.open();
+      await nextRender();
+
+      comboBox.close();
+      comboBox.itemClassNameGenerator = null;
+
+      comboBox.open();
+      await nextRender();
+
+      const items = getAllItems(comboBox);
+      expect(items[0].className).to.equal('');
+      expect(items[1].className).to.equal('');
+      expect(items[2].className).to.equal('');
+    });
+  });
+});