Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(lion-tabs): introduced before-selected-changed cancelable event #2092

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(lion-tabs): introduced before-selected-changed cancelable event #2092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions packages/ui/components/tabs/src/LionTabs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,16 @@ export class LionTabs extends LitElement {
if (value === -1) {
return;
}

const beforeSelectedChangedEvent = new CustomEvent('before-selected-changed', {
cancelable: true,
detail: { selectedIndex: value },
});
this.dispatchEvent(beforeSelectedChangedEvent);
if (beforeSelectedChangedEvent.defaultPrevented) {
return;
}

const stale = this.__selectedIndex;
this.__selectedIndex = value;
this.__updateSelected(true);
Expand Down
46 changes: 46 additions & 0 deletions packages/ui/components/tabs/test/lion-tabs.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,14 @@ describe('<lion-tabs>', () => {
expect(spy).to.have.been.calledOnce;
});

it('does not send event "before-selected-changed" when selectedIndex is set programmatically', async () => {
const el = /** @type {LionTabs} */ (await fixture(basicTabs));
const spy = sinon.spy();
el.addEventListener('before-selected-changed', spy);
el.selectedIndex = 1;
expect(spy).to.not.have.been.calledOnce;
});

it('logs warning if unequal amount of tabs and panels', async () => {
const stub = sinon.stub(console, 'warn');
await fixture(html`
Expand Down Expand Up @@ -345,6 +353,44 @@ describe('<lion-tabs>', () => {
tabs[2].dispatchEvent(new KeyboardEvent('keyup', { key: 'ArrowRight' }));
expect(el.selectedIndex).to.equal(1);
});

describe('when interacted with it sends "before-selected-changed" event', () => {
it('and sets new selectedIndex if event default action was not prevented', async () => {
const el = /** @type {LionTabs} */ (await fixture(basicTabs));
const beforeSelectedChangedSpy = sinon.spy();
const selectedChangedSpy = sinon.spy();

el.addEventListener('before-selected-changed', beforeSelectedChangedSpy);
el.addEventListener('selected-changed', selectedChangedSpy);

const tabs = el.querySelectorAll('[slot=tab]');
tabs[1].dispatchEvent(new Event('click'));
expect(selectedChangedSpy).to.have.been.calledOnce;
expect(beforeSelectedChangedSpy).to.have.been.calledWithMatch({
cancelable: true,
detail: { selectedIndex: 1 },
});
expect(el.selectedIndex).to.equal(1);
});

it('and does not set new selectedIndex if event default action was prevented', async () => {
const el = /** @type {LionTabs} */ (await fixture(basicTabs));
const beforeSelectedChangedSpy = sinon.spy(e => e.preventDefault());
const selectedChangedSpy = sinon.spy();

el.addEventListener('before-selected-changed', beforeSelectedChangedSpy);
el.addEventListener('selected-changed', selectedChangedSpy);

const tabs = el.querySelectorAll('[slot=tab]');
tabs[1].dispatchEvent(new Event('click'));
expect(selectedChangedSpy).to.not.have.been.called;
expect(beforeSelectedChangedSpy).to.have.been.calledWithMatch({
cancelable: true,
detail: { selectedIndex: 1 },
});
expect(el.selectedIndex).to.equal(0);
});
});
});

describe('Content distribution', () => {
Expand Down
Loading