Skip to content

Commit

Permalink
feat(accordion)!: addressing review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@venkateshjo
venkateshjo committed Jun 26, 2023
1 parent ce17c1e commit 8eda90e
Show file tree
Hide file tree
Showing 5 changed files with 186 additions and 11 deletions.
144 changes: 142 additions & 2 deletions packages/accordion/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,33 @@ The `density` property, when applied, accepts the values of `compact` or `spacio

### Compact

<sp-tabs selected="m" auto label="Size Attribute Options">
<sp-tab value="s">Small</sp-tab>
<sp-tab-panel value="s">

```html
<sp-accordion density="compact" size="s">
<sp-accordion-item label="Heading 1">
<div>Item 1</div>
</sp-accordion-item>
<sp-accordion-item disabled label="Heading 2">
<div>Item 2</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 3">
<div>Item 3</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 4">
<div>Item 4</div>
</sp-accordion-item>
</sp-accordion>
```

</sp-tab-panel>
<sp-tab value="m">Medium</sp-tab>
<sp-tab-panel value="m">

```html
<sp-accordion density="compact">
<sp-accordion density="compact" size="m">
<sp-accordion-item label="Heading 1">
<div>Item 1</div>
</sp-accordion-item>
Expand All @@ -187,10 +212,80 @@ The `density` property, when applied, accepts the values of `compact` or `spacio
</sp-accordion>
```

</sp-tab-panel>
<sp-tab value="l">Large</sp-tab>
<sp-tab-panel value="l">

```html
<sp-accordion density="compact" size="l">
<sp-accordion-item label="Heading 1">
<div>Item 1</div>
</sp-accordion-item>
<sp-accordion-item disabled label="Heading 2">
<div>Item 2</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 3">
<div>Item 3</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 4">
<div>Item 4</div>
</sp-accordion-item>
</sp-accordion>
```

</sp-tab-panel>
<sp-tab value="xl">Extra Large</sp-tab>
<sp-tab-panel value="xl">

```html
<sp-accordion density="compact" size="xl">
<sp-accordion-item label="Heading 1">
<div>Item 1</div>
</sp-accordion-item>
<sp-accordion-item disabled label="Heading 2">
<div>Item 2</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 3">
<div>Item 3</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 4">
<div>Item 4</div>
</sp-accordion-item>
</sp-accordion>
```

</sp-tab-panel>
</sp-tabs>

### Spacious

<sp-tabs selected="m" auto label="Size Attribute Options">
<sp-tab value="s">Small</sp-tab>
<sp-tab-panel value="s">

```html
<sp-accordion density="spacious" size="s">
<sp-accordion-item label="Heading 1">
<div>Item 1</div>
</sp-accordion-item>
<sp-accordion-item disabled label="Heading 2">
<div>Item 2</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 3">
<div>Item 3</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 4">
<div>Item 4</div>
</sp-accordion-item>
</sp-accordion>
```

</sp-tab-panel>
<sp-tab value="m">Medium</sp-tab>
<sp-tab-panel value="m">

```html
<sp-accordion density="spacious">
<sp-accordion density="spacious" size="m">
<sp-accordion-item label="Heading 1">
<div>Item 1</div>
</sp-accordion-item>
Expand All @@ -205,3 +300,48 @@ The `density` property, when applied, accepts the values of `compact` or `spacio
</sp-accordion-item>
</sp-accordion>
```

</sp-tab-panel>
<sp-tab value="l">Large</sp-tab>
<sp-tab-panel value="l">

```html
<sp-accordion density="spacious" size="l">
<sp-accordion-item label="Heading 1">
<div>Item 1</div>
</sp-accordion-item>
<sp-accordion-item disabled label="Heading 2">
<div>Item 2</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 3">
<div>Item 3</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 4">
<div>Item 4</div>
</sp-accordion-item>
</sp-accordion>
```

</sp-tab-panel>
<sp-tab value="xl">Extra Large</sp-tab>
<sp-tab-panel value="xl">

```html
<sp-accordion density="spacious" size="xl">
<sp-accordion-item label="Heading 1">
<div>Item 1</div>
</sp-accordion-item>
<sp-accordion-item disabled label="Heading 2">
<div>Item 2</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 3">
<div>Item 3</div>
</sp-accordion-item>
<sp-accordion-item label="Heading 4">
<div>Item 4</div>
</sp-accordion-item>
</sp-accordion>
```

</sp-tab-panel>
</sp-tabs>
9 changes: 6 additions & 3 deletions packages/accordion/src/Accordion.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class Accordion extends SizedMixin(SpectrumElement, {
* Sets the spacing between the content to borders of an accordion item
*/
@property({ type: String, reflect: true })
public density: 'compact' | 'spacious' | undefined;
public density?: 'compact' | 'spacious';

@queryAssignedNodes()
private defaultNodes!: NodeListOf<AccordionItem>;
Expand Down Expand Up @@ -93,7 +93,7 @@ export class Accordion extends SizedMixin(SpectrumElement, {
});
}

private handleSlotchange({}: Event & { target: HTMLSlotElement }): void {
private handleSlotchange(): void {
this.focusGroupController.clearElementCache();
this.items.forEach((item) => {
item.size = this.size;
Expand All @@ -102,7 +102,10 @@ export class Accordion extends SizedMixin(SpectrumElement, {

protected override updated(changed: PropertyValues<this>): void {
super.updated(changed);
if (changed.has('size')) {
if (
changed.has('size') &&
(!!changed.get('size') || this.size !== 'm')
) {
this.items.forEach((item) => {
item.size = this.size;
});
Expand Down
2 changes: 1 addition & 1 deletion packages/accordion/src/AccordionItem.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export class AccordionItem extends SizedMixin(Focusable, {
}

protected renderChevronIcon = (): TemplateResult => {
return chevronIcon[this.size]();
return chevronIcon[this.size || 'm']();
};

protected override render(): TemplateResult {
Expand Down
14 changes: 9 additions & 5 deletions ...on/stories/accordion-densities.stories.ts → ...es/accordion-densities-compact.stories.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ import { TemplateResult } from '@spectrum-web-components/base';
import { AccordionMarkup } from './';

export default {
title: 'Accordion/Densities',
title: 'Accordion/Densities/Compact',
component: 'sp-accordion',
};

export const compact = (): TemplateResult =>
AccordionMarkup({ density: 'compact' });
export const spacious = (): TemplateResult =>
AccordionMarkup({ density: 'spacious' });
export const s = (): TemplateResult =>
AccordionMarkup({ density: 'compact', size: 's' });
export const m = (): TemplateResult =>
AccordionMarkup({ density: 'compact', size: 'm' });
export const l = (): TemplateResult =>
AccordionMarkup({ density: 'compact', size: 'l' });
export const xl = (): TemplateResult =>
AccordionMarkup({ density: 'compact', size: 'xl' });
28 changes: 28 additions & 0 deletions packages/accordion/stories/accordion-densities-spacious.stories.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
Copyright 2023 Adobe. All rights reserved.
This file is licensed to you under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy
of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/

import { TemplateResult } from '@spectrum-web-components/base';
import { AccordionMarkup } from './';

export default {
title: 'Accordion/Densities/Spacious',
component: 'sp-accordion',
};

export const s = (): TemplateResult =>
AccordionMarkup({ density: 'spacious', size: 's' });
export const m = (): TemplateResult =>
AccordionMarkup({ density: 'spacious', size: 'm' });
export const l = (): TemplateResult =>
AccordionMarkup({ density: 'spacious', size: 'l' });
export const xl = (): TemplateResult =>
AccordionMarkup({ density: 'spacious', size: 'xl' });

0 comments on commit 8eda90e

Please sign in to comment.