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(documentation): Document collapseChange event on post-accordion #2620

Merged
merged 8 commits into from
Feb 19, 2024
Merged

feat(documentation): Document collapseChange event on post-accordion #2620

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
700e279
feat(components, documentation): Add new itemsCollapseChange event on…
imagoiq Feb 7, 2024
138f98f
Prevent to bubbles to support nested accordion
imagoiq Feb 7, 2024
79db272
Simplify
imagoiq Feb 8, 2024
26b151f
Add another test and remove .only
imagoiq Feb 8, 2024
7288ab5
Fixed changeset
imagoiq Feb 8, 2024
106e8fd
Merge branch 'main' into feat/2572-collapse-change-event-on-accordion
imagoiq Feb 13, 2024
f29d53d
Merge branch 'main' into feat/2572-collapse-change-event-on-accordion
imagoiq Feb 19, 2024
87da944
Fixed test
imagoiq Feb 19, 2024
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
5 changes: 5 additions & 0 deletions .changeset/spotty-donuts-visit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@swisspost/design-system-documentation': patch
---

Documented collapseChange event from post-accordion-item on post-accordion.
35 changes: 35 additions & 0 deletions packages/components/cypress/e2e/accordion.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,41 @@ describe('accordion', () => {
cy.get('@collapsibles').last().click();
cy.get('@collapsibles').first().find('.collapse').should('be.hidden');
});

it('should propagate collapseChange event from post-accordion-item on post-accordion', () => {
cy.document().then(document => {
const EventHandlerMock = cy.spy();
Cypress.$(document.querySelector('post-accordion')).on('collapseChange', EventHandlerMock);

cy.get('@collapsibles')
.last()
.click()
.then(() => {
expect(EventHandlerMock).to.be.calledTwice;
});
});
});
});

describe('nested', () => {
beforeEach(() => {
cy.getComponent('accordion', 'nested');
cy.get('@accordion').find('post-accordion post-accordion-item').as('nestedCollapsibles');
});

it('should not propagate collapseChange event from nested post-accordion', () => {
cy.document().then(document => {
const EventHandlerMock = cy.spy();
Cypress.$(document.querySelector('post-accordion')).on('collapseChange', EventHandlerMock);

cy.get('@nestedCollapsibles')
.last()
.click()
.then(() => {
expect(EventHandlerMock).to.not.be.called;
});
});
});
});

describe('multiple open panels', () => {
Expand Down
53 changes: 52 additions & 1 deletion packages/documentation/src/stories/components/accordion/accordion.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { html } from 'lit';
import { ifDefined } from 'lit/directives/if-defined.js';
import { BADGE } from '../../../../.storybook/constants';

const meta: Meta<HTMLPostAccordionElement> = {
const meta: Meta<HTMLPostAccordionElement & HTMLPostCollapsibleElementEventMap> = {
title: 'Components/Accordion',
component: 'post-accordion',
parameters: {
Expand All @@ -12,6 +12,18 @@ const meta: Meta<HTMLPostAccordionElement> = {
args: {
multiple: false,
},
argTypes: {
collapseChange: {
name: 'collapseChange',
description: `<p>An event emitted when the collapse element is shown or hidden, before the transition.</p>
<p>The event payload is a boolean: true if the collapsible was opened, false if it was closed.</p>`,
control: null,
table: {
category: 'Events',
type: { summary: 'boolean' },
},
},
},
};

export default meta;
Expand Down Expand Up @@ -61,6 +73,45 @@ export const MultipleOpenPanels: Story = {
`,
};

// Used only in testing for now.
export const Nested: Story = {
render: () => html`
<post-accordion>
<post-accordion-item>
<span slot="header">Titulum 1</span>
<p>Contentus momentus vero siteos et accusam iretea et justo.</p>

<post-accordion>
<post-accordion-item>
<span slot="header">Titulum 1</span>
<p>Contentus momentus vero siteos et accusam iretea et justo.</p>
</post-accordion-item>

<post-accordion-item collapsed>
<span slot="header">Titulum 2</span>
<p>Contentus momentus vero siteos et accusam iretea et justo.</p>
</post-accordion-item>

<post-accordion-item collapsed>
<span slot="header">Titulum 3</span>
<p>Contentus momentus vero siteos et accusam iretea et justo.</p>
</post-accordion-item>
</post-accordion>
</post-accordion-item>

<post-accordion-item collapsed>
<span slot="header">Titulum 2</span>
<p>Contentus momentus vero siteos et accusam iretea et justo.</p>
</post-accordion-item>

<post-accordion-item collapsed>
<span slot="header">Titulum 3</span>
<p>Contentus momentus vero siteos et accusam iretea et justo.</p>
</post-accordion-item>
</post-accordion>
`,
};

export const DefaultCollapsedPanels: Story = {
render: () => html`
<post-accordion>
Expand Down
Loading