Skip to content

Commit dcbdba0

Browse files
Remove support for contents list optional visually hidden text
1 parent a182aeb commit dcbdba0

File tree

3 files changed

+3
-11
lines changed

3 files changed

+3
-11
lines changed

src/components/navigation/contents-list/ContentsList.tsx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const ContentsListItem: FC<ContentsListItemProps> = ({ className, current, ...re
1616
);
1717

1818
interface ContentsListProps extends HTMLProps<HTMLDivElement> {
19-
visuallyHiddenText?: false | string;
19+
visuallyHiddenText?: string;
2020
}
2121

2222
interface ContentsListComponent extends FC<ContentsListProps> {
@@ -31,9 +31,7 @@ const ContentsListComponent: ContentsListComponent = ({
3131
...rest
3232
}) => (
3333
<nav className={classNames('nhsuk-contents-list', className)} role={role} {...rest}>
34-
{visuallyHiddenText !== false ? (
35-
<h2 className="nhsuk-u-visually-hidden">{visuallyHiddenText}</h2>
36-
) : null}
34+
<h2 className="nhsuk-u-visually-hidden">{visuallyHiddenText}</h2>
3735
<ol className="nhsuk-contents-list__list">{children}</ol>
3836
</nav>
3937
);

src/components/navigation/contents-list/__tests__/ContentsList.test.tsx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ describe('ContentsList', () => {
2121
expect(container.querySelector('.nhsuk-u-visually-hidden')?.textContent).toEqual('Custom');
2222
});
2323

24-
it('disables hidden text', () => {
25-
const { container } = render(<ContentsList visuallyHiddenText={false} />);
26-
27-
expect(container.querySelector('.nhsuk-u-visually-hidden')).toBeFalsy();
28-
});
29-
3024
describe('ContentsList.Item', () => {
3125
it('matches snapshot', () => {
3226
const { container } = render(<ContentsList.Item>Content</ContentsList.Item>);

stories/Navigation/ContentsList.stories.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Meta, StoryObj } from '@storybook/react';
99
*
1010
* The `ContentsList` component has one subcomponent: `ContentsList.Item`.
1111
*
12-
* There are two default props set to the ContentsList: `role: 'navigation'` and `visuallyHiddenText: 'Contents'`. These are only default props and can be overriden. `visuallyHiddenText={false}` will disable the visually hidden text.
12+
* There are two default props set to the ContentsList: `role: 'navigation'` and `visuallyHiddenText: 'Contents'`. These are only default props and can be overriden.
1313
*
1414
* ## Usage
1515
*

0 commit comments

Comments
 (0)