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.

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

OPHJOD-952: Update Accordion to work better with screenreader #175

Merged
merged 1 commit into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 1 addition & 6 deletions lib/components/Accordion/Accordion.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ export const Default: Story = {
title: 'Title',
children: 'Content',
lang: 'en',
expandMoreText: 'Show more',
expandLessText: 'Show less',
},
};

Expand All @@ -59,10 +57,9 @@ export const TitleComponent: Story = {
},
args: {
title: <div className="ds-text-heading-1 ds-font-arial ds-text-alert ds-italic ds-tracking-widest">Title</div>,
titleText: 'Title',
children: 'Content',
lang: 'en',
expandMoreText: 'Show more',
expandLessText: 'Show less',
},
};

Expand All @@ -81,7 +78,5 @@ export const WithUnderline: Story = {
children: 'Content',
underline: true,
lang: 'en',
expandMoreText: 'Show more',
expandLessText: 'Show less',
},
};
10 changes: 4 additions & 6 deletions lib/components/Accordion/Accordion.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,17 @@ import { Accordion } from './Accordion';

describe('Accordion', () => {
const title = 'Accordion Title';
const expandLessText = 'Expand Less';
const expandMoreText = 'Expand More';
const lang = 'en';

test('renders accordion with open state by default', () => {
const { container } = render(
<Accordion title={title} expandLessText={expandLessText} expandMoreText={expandMoreText} lang={lang}>
<Accordion title={title} lang={lang}>
<div>Default content</div>
</Accordion>,
);

const accordionTitle = screen.getByText(title);
const expandButton = screen.getByLabelText(expandLessText);
const expandButton = screen.getByRole('button');
const accordionContent = screen.queryByText('Default content');

expect(accordionTitle).toBeInTheDocument();
Expand All @@ -29,12 +27,12 @@ describe('Accordion', () => {

test('closes accordion when expand button is clicked', () => {
render(
<Accordion title={title} expandLessText={expandLessText} expandMoreText={expandMoreText} lang={lang}>
<Accordion title={title} lang={lang}>
<div>Content to be gone</div>
</Accordion>,
);

const expandButton = screen.getByLabelText(expandLessText);
const expandButton = screen.getByRole('button');
fireEvent.click(expandButton);

const accordionContent = screen.queryByText('Content to be gone');
Expand Down
34 changes: 15 additions & 19 deletions lib/components/Accordion/Accordion.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,31 @@ import React from 'react';
import { MdExpandLess, MdExpandMore } from 'react-icons/md';
import { cx } from '../../cva';

interface AccordionProps {
type TitleProps =
| {
title: React.ReactNode;
titleText: string;
}
| {
title: string;
titleText?: never;
};

type AccordionProps = {
title: React.ReactNode | string;
children: React.ReactNode;
expandLessText: string;
expandMoreText: string;
lang: string;
underline?: boolean;
intialState?: boolean;
}
} & TitleProps;

const Caret = ({ isOpen }: { isOpen: boolean }) => (
<span className="ds-text-black group-hover:!ds-text-accent" aria-hidden>
{isOpen ? <MdExpandLess size={24} /> : <MdExpandMore size={24} />}
</span>
);

export const Accordion = ({
title,
children,
expandLessText,
expandMoreText,
lang,
underline,
intialState = true,
}: AccordionProps) => {
export const Accordion = ({ title, titleText, children, lang, underline, intialState = true }: AccordionProps) => {
const [isOpen, setIsOpen] = React.useState(intialState);
const toggleOpen = () => setIsOpen(!isOpen);
const isTitleValidElement = React.isValidElement(title);
Expand All @@ -47,17 +47,13 @@ export const Accordion = ({
{isTitleValidElement ? (
<div className={wrapperClassnames}>
{title}
<button aria-label={isOpen ? expandLessText : expandMoreText} onClick={toggleOpen} className="ds-flex">
<button aria-label={titleText} aria-expanded={isOpen} onClick={toggleOpen} className="ds-flex">
<Caret isOpen={isOpen} />
</button>
</div>
) : (
<div className="ds-group">
<button
aria-label={isOpen ? expandLessText : expandMoreText}
onClick={toggleOpen}
className={wrapperClassnames}
>
<button aria-expanded={isOpen} onClick={toggleOpen} className={wrapperClassnames}>
<span
className="ds-mr-5 ds-w-full ds-text-left ds-hyphens-auto ds-text-heading-3 group-hover:ds-underline"
lang={lang}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ exports[`Accordion > renders accordion with open state by default 1`] = `
class="ds-group"
>
<button
aria-label="Expand Less"
aria-expanded="true"
class="ds-flex ds-w-full ds-items-center ds-justify-between ds-gap-x-4 ds-mb-2 group-hover:!ds-text-accent"
>
<span
Expand Down