mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 04:09:12 +00:00
407 lines
16 KiB
TypeScript
407 lines
16 KiB
TypeScript
import { aTimeout, expect, oneEvent, waitUntil } from '@open-wc/testing';
|
|
import { sendKeys } from '@web/test-runner-commands';
|
|
import { html } from 'lit';
|
|
import sinon from 'sinon';
|
|
import { clickOnElement } from '../../internal/test.js';
|
|
import { fixtures } from '../../internal/test/fixture.js';
|
|
import { runFormControlBaseTests } from '../../internal/test/form-control-base-tests.js';
|
|
import type WaCheckbox from './checkbox.js';
|
|
|
|
describe('<wa-checkbox>', () => {
|
|
runFormControlBaseTests('wa-checkbox');
|
|
|
|
for (const fixture of fixtures) {
|
|
describe(`with "${fixture.type}" rendering`, () => {
|
|
it('should pass accessibility tests', async () => {
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox>Checkbox</wa-checkbox> `);
|
|
await expect(el).to.be.accessible();
|
|
});
|
|
|
|
it('default properties', async () => {
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox></wa-checkbox> `);
|
|
|
|
expect(el.name).to.equal('');
|
|
expect(el.value).to.equal('on');
|
|
expect(el.title).to.equal('');
|
|
expect(el.disabled).to.be.false;
|
|
expect(el.required).to.be.false;
|
|
expect(el.checked).to.be.false;
|
|
expect(el.indeterminate).to.be.false;
|
|
expect(el.defaultChecked).to.be.false;
|
|
expect(el.hint).to.equal('');
|
|
});
|
|
|
|
it('should have title if title attribute is set', async () => {
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox title="Test"></wa-checkbox> `);
|
|
const input = el.shadowRoot!.querySelector('input')!;
|
|
|
|
expect(input.title).to.equal('Test');
|
|
});
|
|
|
|
it('should be disabled with the disabled attribute', async () => {
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox disabled></wa-checkbox> `);
|
|
const checkbox = el.shadowRoot!.querySelector('input')!;
|
|
|
|
expect(checkbox.disabled).to.be.true;
|
|
});
|
|
|
|
it('should be disabled when disabled property is set', async () => {
|
|
const el = await fixture<WaCheckbox>(html`<wa-checkbox></wa-checkbox>`);
|
|
const checkbox = el.shadowRoot!.querySelector('input')!;
|
|
|
|
el.disabled = true;
|
|
await el.updateComplete;
|
|
|
|
expect(checkbox.disabled).to.be.true;
|
|
});
|
|
|
|
it('should be valid by default', async () => {
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox></wa-checkbox> `);
|
|
expect(el.checkValidity()).to.be.true;
|
|
});
|
|
|
|
it('should emit wa-change and wa-input when clicked', async () => {
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox></wa-checkbox> `);
|
|
const changeHandler = sinon.spy();
|
|
const inputHandler = sinon.spy();
|
|
|
|
el.addEventListener('wa-change', changeHandler);
|
|
el.addEventListener('wa-input', inputHandler);
|
|
el.click();
|
|
await aTimeout(0);
|
|
await el.updateComplete;
|
|
|
|
expect(changeHandler).to.have.been.calledOnce;
|
|
expect(inputHandler).to.have.been.calledOnce;
|
|
expect(el.checked).to.be.true;
|
|
});
|
|
|
|
it('should emit wa-change and wa-input when toggled with spacebar', async () => {
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox></wa-checkbox> `);
|
|
const changeHandler = sinon.spy();
|
|
const inputHandler = sinon.spy();
|
|
|
|
el.addEventListener('wa-change', changeHandler);
|
|
el.addEventListener('wa-input', inputHandler);
|
|
el.focus();
|
|
await el.updateComplete;
|
|
await sendKeys({ press: ' ' });
|
|
|
|
expect(changeHandler).to.have.been.calledOnce;
|
|
expect(inputHandler).to.have.been.calledOnce;
|
|
expect(el.checked).to.be.true;
|
|
});
|
|
|
|
it('should not emit wa-change or wa-input when checked programmatically', async () => {
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox></wa-checkbox> `);
|
|
|
|
el.addEventListener('wa-change', () => expect.fail('wa-change should not be emitted'));
|
|
el.addEventListener('wa-input', () => expect.fail('wa-input should not be emitted'));
|
|
el.checked = true;
|
|
await el.updateComplete;
|
|
await aTimeout(0);
|
|
el.checked = false;
|
|
await el.updateComplete;
|
|
await aTimeout(0);
|
|
});
|
|
|
|
it('should hide the native input with the correct positioning to scroll correctly when contained in an overflow', async () => {
|
|
//
|
|
// See: https://github.com/shoelace-style/shoelace/issues/1169
|
|
//
|
|
const el = await fixture<WaCheckbox>(html` <wa-checkbox></wa-checkbox> `);
|
|
const label = el.shadowRoot!.querySelector('.checkbox')!;
|
|
const input = el.shadowRoot!.querySelector('.checkbox__input')!;
|
|
|
|
const labelPosition = getComputedStyle(label).position;
|
|
const inputPosition = getComputedStyle(input).position;
|
|
|
|
expect(labelPosition).to.equal('relative');
|
|
expect(inputPosition).to.equal('absolute');
|
|
});
|
|
|
|
it('Should keep its form value when going from checked -> unchecked -> checked', async () => {
|
|
const form = await fixture<HTMLFormElement>(
|
|
html`<form><wa-checkbox name="test" value="myvalue" checked>Checked</wa-checkbox></form>`,
|
|
);
|
|
const checkbox = form.querySelector('wa-checkbox')!;
|
|
|
|
expect(checkbox.checked).to.equal(true);
|
|
expect(checkbox.value).to.equal('myvalue');
|
|
expect(new FormData(form).get('test')).to.equal('myvalue');
|
|
|
|
checkbox.checked = false;
|
|
await checkbox.updateComplete;
|
|
|
|
expect(checkbox.checked).to.equal(false);
|
|
expect(checkbox.value).to.equal('myvalue');
|
|
expect(new FormData(form).get('test')).to.equal(null);
|
|
|
|
checkbox.checked = true;
|
|
await checkbox.updateComplete;
|
|
|
|
expect(checkbox.checked).to.equal(true);
|
|
expect(checkbox.value).to.equal('myvalue');
|
|
expect(new FormData(form).get('test')).to.equal('myvalue');
|
|
});
|
|
|
|
describe('when submitting a form', () => {
|
|
it('should submit the correct value when a value is provided', async () => {
|
|
const form = await fixture<HTMLFormElement>(html`
|
|
<form>
|
|
<wa-checkbox name="a" value="1" checked></wa-checkbox>
|
|
<wa-button type="submit">Submit</wa-button>
|
|
</form>
|
|
`);
|
|
const button = form.querySelector('wa-button')!;
|
|
const submitHandler = sinon.spy((event: SubmitEvent) => {
|
|
formData = new FormData(form);
|
|
event.preventDefault();
|
|
});
|
|
let formData: FormData;
|
|
|
|
form.addEventListener('submit', submitHandler);
|
|
button.click();
|
|
|
|
await waitUntil(() => submitHandler.calledOnce);
|
|
|
|
expect(formData!.get('a')).to.equal('1');
|
|
});
|
|
|
|
it('should submit "on" when no value is provided', async () => {
|
|
const form = await fixture<HTMLFormElement>(html`
|
|
<form>
|
|
<wa-checkbox name="a" checked></wa-checkbox>
|
|
<wa-button type="submit">Submit</wa-button>
|
|
</form>
|
|
`);
|
|
const button = form.querySelector('wa-button')!;
|
|
const submitHandler = sinon.spy((event: SubmitEvent) => {
|
|
formData = new FormData(form);
|
|
event.preventDefault();
|
|
});
|
|
let formData: FormData;
|
|
|
|
form.addEventListener('submit', submitHandler);
|
|
button.click();
|
|
|
|
await waitUntil(() => submitHandler.calledOnce);
|
|
|
|
expect(formData!.get('a')).to.equal('on');
|
|
});
|
|
|
|
it('should be invalid when setCustomValidity() is called with a non-empty value', async () => {
|
|
const checkbox = await fixture<HTMLFormElement>(html` <wa-checkbox></wa-checkbox> `);
|
|
|
|
// Submitting the form after setting custom validity should not trigger the handler
|
|
checkbox.setCustomValidity('Invalid selection');
|
|
await checkbox.updateComplete;
|
|
|
|
expect(checkbox.checkValidity()).to.be.false;
|
|
expect(checkbox.checkValidity()).to.be.false;
|
|
expect(checkbox.hasCustomState('invalid')).to.be.true;
|
|
expect(checkbox.hasCustomState('valid')).to.be.false;
|
|
expect(checkbox.hasCustomState('user-invalid')).to.be.true;
|
|
expect(checkbox.hasCustomState('user-valid')).to.be.false;
|
|
|
|
await clickOnElement(checkbox);
|
|
await checkbox.updateComplete;
|
|
await aTimeout(0);
|
|
|
|
expect(checkbox.hasCustomState('user-invalid')).to.be.true;
|
|
expect(checkbox.hasCustomState('user-valid')).to.be.false;
|
|
});
|
|
|
|
it('should be invalid when required and unchecked', async () => {
|
|
const checkbox = await fixture<HTMLFormElement>(html` <wa-checkbox required></wa-checkbox> `);
|
|
expect(checkbox.checkValidity()).to.be.false;
|
|
});
|
|
|
|
it('should be valid when required and checked', async () => {
|
|
const checkbox = await fixture<HTMLFormElement>(html` <wa-checkbox required checked></wa-checkbox> `);
|
|
await checkbox.updateComplete;
|
|
expect(checkbox.checkValidity()).to.be.true;
|
|
});
|
|
|
|
it('should be present in form data when using the form attribute and located outside of a <form>', async () => {
|
|
const el = await fixture<HTMLFormElement>(html`
|
|
<div>
|
|
<form id="f">
|
|
<wa-button type="submit">Submit</wa-button>
|
|
</form>
|
|
<wa-checkbox form="f" name="a" value="1" checked></wa-checkbox>
|
|
</div>
|
|
`);
|
|
const form = el.querySelector('form')!;
|
|
const formData = new FormData(form);
|
|
|
|
expect(formData.get('a')).to.equal('1');
|
|
});
|
|
|
|
it('should receive validation attributes ("states") even when novalidate is used on the parent form', async () => {
|
|
const el = await fixture<HTMLFormElement>(html`
|
|
<form novalidate><wa-checkbox required></wa-checkbox></form>
|
|
`);
|
|
const checkbox = el.querySelector<WaCheckbox>('wa-checkbox')!;
|
|
|
|
expect(checkbox.hasCustomState('required')).to.be.true;
|
|
expect(checkbox.hasCustomState('optional')).to.be.false;
|
|
expect(checkbox.hasCustomState('invalid')).to.be.true;
|
|
expect(checkbox.hasCustomState('valid')).to.be.false;
|
|
expect(checkbox.hasCustomState('user-invalid')).to.be.false;
|
|
expect(checkbox.hasCustomState('user-valid')).to.be.false;
|
|
});
|
|
});
|
|
|
|
describe('when resetting a form', () => {
|
|
it('should reset the element to its initial value', async () => {
|
|
const form = await fixture<HTMLFormElement>(html`
|
|
<form>
|
|
<wa-checkbox name="a" value="1" checked></wa-checkbox>
|
|
<wa-button type="reset">Reset</wa-button>
|
|
</form>
|
|
`);
|
|
const button = form.querySelector('wa-button')!;
|
|
const checkbox = form.querySelector('wa-checkbox')!;
|
|
checkbox.checked = false;
|
|
|
|
await checkbox.updateComplete;
|
|
setTimeout(() => button.click());
|
|
|
|
await oneEvent(form, 'reset');
|
|
await checkbox.updateComplete;
|
|
|
|
expect(checkbox.checked).to.be.true;
|
|
|
|
checkbox.defaultChecked = false;
|
|
|
|
setTimeout(() => button.click());
|
|
await oneEvent(form, 'reset');
|
|
await checkbox.updateComplete;
|
|
|
|
expect(checkbox.checked).to.be.false;
|
|
});
|
|
});
|
|
|
|
describe('click', () => {
|
|
it('should click the inner input', async () => {
|
|
const el = await fixture<WaCheckbox>(html`<wa-checkbox></wa-checkbox>`);
|
|
const checkbox = el.shadowRoot!.querySelector('input')!;
|
|
const clickSpy = sinon.spy();
|
|
|
|
checkbox.addEventListener('click', clickSpy, { once: true });
|
|
|
|
el.click();
|
|
await el.updateComplete;
|
|
|
|
expect(clickSpy.called).to.equal(true);
|
|
expect(el.checked).to.equal(true);
|
|
});
|
|
});
|
|
|
|
describe('focus', () => {
|
|
it('should focus the inner input', async () => {
|
|
const el = await fixture<WaCheckbox>(html`<wa-checkbox></wa-checkbox>`);
|
|
const checkbox = el.shadowRoot!.querySelector('input')!;
|
|
const focusSpy = sinon.spy();
|
|
|
|
checkbox.addEventListener('focus', focusSpy, { once: true });
|
|
|
|
el.focus();
|
|
await el.updateComplete;
|
|
|
|
expect(focusSpy.called).to.equal(true);
|
|
expect(el.shadowRoot!.activeElement).to.equal(checkbox);
|
|
});
|
|
|
|
it('should not jump the page to the bottom when focusing a checkbox at the bottom of an element with overflow: auto;', async () => {
|
|
// https://github.com/shoelace-style/shoelace/issues/1169
|
|
const el = await fixture<HTMLDivElement>(html`
|
|
<div style="display: flex; flex-direction: column; overflow: auto; max-height: 400px; gap: 8px;">
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
<wa-checkbox>Checkbox</wa-checkbox>
|
|
</div>
|
|
;
|
|
`);
|
|
|
|
const checkboxes = el.querySelectorAll<WaCheckbox>('wa-checkbox');
|
|
const lastSwitch = checkboxes[checkboxes.length - 1];
|
|
|
|
expect(window.scrollY).to.equal(0);
|
|
// Without these 2 timeouts, tests will pass unexpectedly in Safari.
|
|
await aTimeout(10);
|
|
lastSwitch.focus();
|
|
await aTimeout(10);
|
|
expect(window.scrollY).to.equal(0);
|
|
});
|
|
});
|
|
|
|
describe('blur', () => {
|
|
it('should blur the inner input', async () => {
|
|
const el = await fixture<WaCheckbox>(html`<wa-checkbox></wa-checkbox>`);
|
|
const checkbox = el.shadowRoot!.querySelector('input')!;
|
|
const blurSpy = sinon.spy();
|
|
|
|
checkbox.addEventListener('blur', blurSpy, { once: true });
|
|
|
|
el.focus();
|
|
await el.updateComplete;
|
|
|
|
el.blur();
|
|
await el.updateComplete;
|
|
|
|
expect(blurSpy.called).to.equal(true);
|
|
expect(el.shadowRoot!.activeElement).to.equal(null);
|
|
});
|
|
});
|
|
|
|
describe('indeterminate', () => {
|
|
it('should render indeterminate icon until checked', async () => {
|
|
const el = await fixture<WaCheckbox>(html`<wa-checkbox indeterminate></wa-checkbox>`);
|
|
let indeterminateIcon = el.shadowRoot!.querySelector('[part~="indeterminate-icon"]')!;
|
|
|
|
expect(indeterminateIcon).not.to.be.null;
|
|
|
|
el.click();
|
|
await el.updateComplete;
|
|
|
|
indeterminateIcon = el.shadowRoot!.querySelector('[part~="indeterminate-icon"]')!;
|
|
|
|
expect(indeterminateIcon).to.be.null;
|
|
});
|
|
});
|
|
});
|
|
}
|
|
});
|