import { expect, fixture, html, unsafeStatic, triggerFocusFor, triggerBlurFor, aTimeout, } from '@open-wc/testing'; import { unsafeHTML } from '@lion/core'; import sinon from 'sinon'; import { localize } from '@lion/localize'; import { localizeTearDown } from '@lion/localize/test-helpers.js'; import '../lion-field.js'; const nameSuffix = ''; const tagString = 'lion-field'; const tag = unsafeStatic(tagString); const inputSlotString = ''; const inputSlot = unsafeHTML(inputSlotString); function mimicUserInput(formControl, newViewValue) { formControl.value = newViewValue; // eslint-disable-line no-param-reassign formControl.inputElement.dispatchEvent(new CustomEvent('input', { bubbles: true })); } beforeEach(() => { localizeTearDown(); }); describe('', () => { it(`puts a unique id "${tagString}-[hash]" on the native input`, async () => { const el = await fixture(html`<${tag}>${inputSlot}`); expect(el.$$slot('input').id).to.equal(el._inputId); }); it('fires focus/blur event on host and native input if focused/blurred', async () => { const el = await fixture(html`<${tag}>${inputSlot}`); const cbFocusHost = sinon.spy(); el.addEventListener('focus', cbFocusHost); const cbFocusNativeInput = sinon.spy(); el.inputElement.addEventListener('focus', cbFocusNativeInput); const cbBlurHost = sinon.spy(); el.addEventListener('blur', cbBlurHost); const cbBlurNativeInput = sinon.spy(); el.inputElement.addEventListener('blur', cbBlurNativeInput); await triggerFocusFor(el); expect(document.activeElement).to.equal(el.inputElement); expect(cbFocusHost.callCount).to.equal(1); expect(cbFocusNativeInput.callCount).to.equal(1); expect(cbBlurHost.callCount).to.equal(0); expect(cbBlurNativeInput.callCount).to.equal(0); await triggerBlurFor(el); expect(cbBlurHost.callCount).to.equal(1); expect(cbBlurNativeInput.callCount).to.equal(1); await triggerFocusFor(el); expect(document.activeElement).to.equal(el.inputElement); expect(cbFocusHost.callCount).to.equal(2); expect(cbFocusNativeInput.callCount).to.equal(2); await triggerBlurFor(el); expect(cbBlurHost.callCount).to.equal(2); expect(cbBlurNativeInput.callCount).to.equal(2); }); it('offers simple getter "this.focused" returning true/false for the current focus state', async () => { const el = await fixture(html`<${tag}>${inputSlot}`); expect(el.focused).to.equal(false); await triggerFocusFor(el); expect(el.focused).to.equal(true); await triggerBlurFor(el); expect(el.focused).to.equal(false); }); it('can be disabled via attribute', async () => { const elDisabled = await fixture(html`<${tag} disabled>${inputSlot}`); expect(elDisabled.disabled).to.equal(true); expect(elDisabled.inputElement.disabled).to.equal(true); }); it('can be disabled via property', async () => { const el = await fixture(html`<${tag}>${inputSlot}`); el.disabled = true; await el.updateComplete; expect(el.inputElement.disabled).to.equal(true); }); it('can be cleared which erases value, validation and interaction states', async () => { const el = await fixture( html`<${tag} value="Some value from attribute">${inputSlot}`, ); el.clear(); expect(el.value).to.equal(''); el.value = 'Some value from property'; expect(el.value).to.equal('Some value from property'); el.clear(); expect(el.value).to.equal(''); }); it('can be reset which restores original modelValue', async () => { const el = await fixture(html` <${tag} .modelValue="${'foo'}"> ${inputSlot} `); expect(el._initialModelValue).to.equal('foo'); el.modelValue = 'bar'; el.reset(); expect(el.modelValue).to.equal('foo'); }); it('reads initial value from attribute value', async () => { const el = await fixture(html`<${tag} value="one">${inputSlot}`); expect(el.$$slot('input').value).to.equal('one'); }); it('delegates value property', async () => { const el = await fixture(html`<${tag}>${inputSlot}`); expect(el.$$slot('input').value).to.equal(''); el.value = 'one'; expect(el.value).to.equal('one'); expect(el.$$slot('input').value).to.equal('one'); }); // TODO: find out if we could put all listeners on this.value (instead of this.inputElement.value) // and make it act on this.value again it('has a class "state-filled" if this.value is filled', async () => { const el = await fixture(html`<${tag} value="filled">${inputSlot}`); expect(el.classList.contains('state-filled')).to.equal(true); el.value = ''; await el.updateComplete; expect(el.classList.contains('state-filled')).to.equal(false); el.value = 'bla'; await el.updateComplete; expect(el.classList.contains('state-filled')).to.equal(true); }); it('preserves the caret position on value change for native text fields (input|textarea)', async () => { const el = await fixture(html`<${tag}>${inputSlot}`); await triggerFocusFor(el); await el.updateComplete; el.inputElement.value = 'hello world'; el.inputElement.selectionStart = 2; el.inputElement.selectionEnd = 2; el.value = 'hey there universe'; expect(el.inputElement.selectionStart).to.equal(2); expect(el.inputElement.selectionEnd).to.equal(2); }); // TODO: add pointerEvents test for disabled it('has a class "state-disabled"', async () => { const el = await fixture(html`<${tag}>${inputSlot}`); expect(el.classList.contains('state-disabled')).to.equal(false); expect(el.inputElement.hasAttribute('disabled')).to.equal(false); el.disabled = true; await el.updateComplete; await aTimeout(); expect(el.classList.contains('state-disabled')).to.equal(true); expect(el.inputElement.hasAttribute('disabled')).to.equal(true); const disabledel = await fixture(html`<${tag} disabled>${inputSlot}`); expect(disabledel.classList.contains('state-disabled')).to.equal(true); expect(disabledel.inputElement.hasAttribute('disabled')).to.equal(true); }); describe(`A11y${nameSuffix}`, () => { it(`by setting corresponding aria-labelledby (for label) and aria-describedby (for helpText, feedback) ~~~ [helpText]
[feedback] ~~~`, async () => { const el = await fixture(html`<${tag}> ${inputSlot} Enter your Name No name entered `); const nativeInput = el.$$slot('input'); expect(nativeInput.getAttribute('aria-labelledby')).to.equal(` label-${el._inputId}`); expect(nativeInput.getAttribute('aria-describedby')).to.contain(` help-text-${el._inputId}`); expect(nativeInput.getAttribute('aria-describedby')).to.contain(` feedback-${el._inputId}`); }); it(`allows additional slots (prefix, suffix, before, after) to be included in labelledby (via attribute data-label) and in describedby (via attribute data-description)`, async () => { const el = await fixture(html`<${tag}> ${inputSlot} [before] [after] [prefix] [suffix] `); const nativeInput = el.$$slot('input'); expect(nativeInput.getAttribute('aria-labelledby')).to.contain( ` before-${el._inputId} after-${el._inputId}`, ); expect(nativeInput.getAttribute('aria-describedby')).to.contain( ` prefix-${el._inputId} suffix-${el._inputId}`, ); }); // TODO: put this test on FormControlMixin test once there it(`allows to add to aria description or label via addToAriaLabel() and addToAriaDescription()`, async () => { const wrapper = await fixture(html`
<${tag}> ${inputSlot}
Added to description by default
This also needs to be read whenever the input has focus
Same for this
`); const el = wrapper.querySelector(tagString); // wait until the field element is done rendering await el.updateComplete; await el.updateComplete; const { inputElement } = el; // 1. addToAriaLabel() // Check if the aria attr is filled initially expect(inputElement.getAttribute('aria-labelledby')).to.contain(`label-${el._inputId}`); el.addToAriaLabel('additionalLabel'); // Now check if ids are added to the end (not overridden) expect(inputElement.getAttribute('aria-labelledby')).to.contain(`label-${el._inputId}`); // Should be placed in the end expect( inputElement.getAttribute('aria-labelledby').indexOf(`label-${el._inputId}`) < inputElement.getAttribute('aria-labelledby').indexOf('additionalLabel'), ); // 2. addToAriaDescription() // Check if the aria attr is filled initially expect(inputElement.getAttribute('aria-describedby')).to.contain(`feedback-${el._inputId}`); el.addToAriaDescription('additionalDescription'); // Now check if ids are added to the end (not overridden) expect(inputElement.getAttribute('aria-describedby')).to.contain(`feedback-${el._inputId}`); // Should be placed in the end expect( inputElement.getAttribute('aria-describedby').indexOf(`feedback-${el._inputId}`) < inputElement.getAttribute('aria-describedby').indexOf('additionalDescription'), ); }); }); describe(`Validation${nameSuffix}`, () => { beforeEach(() => { // Reset and preload validation translations localizeTearDown(); localize.addData('en-GB', 'lion-validate', { error: { hasX: 'This is error message for hasX', }, }); }); it('shows validity states(error|warning|info|success) when interaction criteria met ', async () => { // TODO: in order to make this test work as an integration test, we chose a modelValue // that is compatible with lion-input-email. // However, when we can put priorities to validators (making sure error message of hasX is // shown instead of a predefined validator like isEmail), we should fix this. function hasX(str) { return { hasX: str.indexOf('x') > -1 }; } const el = await fixture(html`<${tag}>${inputSlot}`); const feedbackEl = el._feedbackElement; el.modelValue = 'a@b.nl'; el.errorValidators = [[hasX]]; expect(el.error.hasX).to.equal(true); expect(feedbackEl.innerText.trim()).to.equal( '', 'shows no feedback, although the element has an error', ); el.dirty = true; el.touched = true; el.modelValue = 'ab@c.nl'; // retrigger validation await el.updateComplete; expect(feedbackEl.innerText.trim()).to.equal( 'This is error message for hasX', 'shows feedback, because touched=true and dirty=true', ); el.touched = false; el.dirty = false; el.prefilled = true; await el.updateComplete; expect(feedbackEl.innerText.trim()).to.equal( 'This is error message for hasX', 'shows feedback, because prefilled=true', ); }); it('can be required', async () => { const el = await fixture(html` <${tag} .errorValidators=${[['required']]} >${inputSlot} `); expect(el.error.required).to.be.true; el.modelValue = 'cat'; expect(el.error.required).to.be.undefined; }); it('will only update formattedValue when valid on `user-input-changed`', async () => { const formatterSpy = sinon.spy(value => `foo: ${value}`); function isBarValidator(value) { return { isBar: value === 'bar' }; } const el = await fixture(html` <${tag} .modelValue=${'init-string'} .formatter=${formatterSpy} .errorValidators=${[[isBarValidator]]} >${inputSlot} `); expect(formatterSpy.callCount).to.equal(0); expect(el.formattedValue).to.equal('init-string'); el.modelValue = 'bar'; expect(formatterSpy.callCount).to.equal(1); expect(el.formattedValue).to.equal('foo: bar'); mimicUserInput(el, 'foo'); expect(formatterSpy.callCount).to.equal(1); expect(el.value).to.equal('foo'); }); }); describe(`Content projection${nameSuffix}`, () => { it('renders correctly all slot elements in light DOM', async () => { const el = await fixture(html` <${tag}> ${inputSlot} [help-text] [before] [after] [prefix] [suffix] [feedback] `); const names = [ 'label', 'input', 'help-text', 'before', 'after', 'prefix', 'suffix', 'feedback', ]; names.forEach(slotName => { el.querySelector(`[slot="${slotName}"]`).setAttribute('test-me', 'ok'); const slot = el.shadowRoot.querySelector(`slot[name="${slotName}"]`); const assignedNodes = slot.assignedNodes(); expect(assignedNodes.length).to.equal(1); expect(assignedNodes[0].getAttribute('test-me')).to.equal('ok'); }); }); }); describe('Delegation', () => { it('delegates property value', async () => { const el = await fixture(html`<${tag}>${inputSlot}`); expect(el.inputElement.value).to.equal(''); el.value = 'one'; expect(el.value).to.equal('one'); expect(el.inputElement.value).to.equal('one'); }); it('delegates property selectionStart and selectionEnd', async () => { const el = await fixture(html` <${tag} .modelValue=${'Some text to select'} >${unsafeHTML(inputSlotString)} `); el.selectionStart = 5; el.selectionEnd = 12; expect(el.inputElement.selectionStart).to.equal(5); expect(el.inputElement.selectionEnd).to.equal(12); }); }); });