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

Navigation: add controlled unit test, use modern Testing Library features #41668

Merged
merged 6 commits into from
Jun 15, 2022
Merged

Navigation: add controlled unit test, use modern Testing Library features #41668

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6a8be0c
Rewrite tests using user-event and modern testing library asseertions…
ciampo Jun 10, 2022
648a33c
Add controlled test
ciampo Jun 10, 2022
2248a0e
CHANGELOG
ciampo Jun 10, 2022
b848ecb
Fix typo
ciampo Jun 14, 2022
ad82fac
Check for `aria-current` attribute instead of `is-active` classname
ciampo Jun 14, 2022
678afad
Merge branch 'trunk' into feat/navigation-rewrite-logic
ciampo Jun 14, 2022
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
69 changes: 32 additions & 37 deletions packages/components/src/navigation/test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,11 @@ const TestNavigationControlled = () => {
const [ activeItem, setActiveItem ] = useState( 'item-1' );
const [ activeMenu, setActiveMenu ] = useState( 'root' );

// Mock navigation link.
const MockLink = ( { href, children } ) => (
<button
href={ href }
// Since we're not actually navigating pages, simulate it with onClick.
onClick={ ( event ) => {
event.preventDefault();
const item = href.replace( 'https://example.com/', '' );
setActiveItem( item );
} }
>
{ children }
</button>
);
const onMockLinkClick = ( event ) => {
event.preventDefault();
const item = event.target.href.replace( 'https://example.com/', '' );
setActiveItem( item );
};

return (
<>
Expand All @@ -79,16 +70,18 @@ const TestNavigationControlled = () => {
onActivateMenu={ setActiveMenu }
>
<NavigationMenu title="Home">
<NavigationItem item="item-1" title="Item 1">
<MockLink href="https://example.com/item-1">
Item 1
</MockLink>
</NavigationItem>
<NavigationItem item="item-2">
<MockLink href="https://example.com/item-2">
Item 2
</MockLink>
</NavigationItem>
<NavigationItem
item="item-1"
title="Item 1"
href="https://example.com/item-1"
onClick={ onMockLinkClick }
/>
<NavigationItem
item="item-2"
title="Item 2"
href="https://example.com/item-2"
onClick={ onMockLinkClick }
/>
<NavigationItem
item="item-sub-menu"
navigateToMenu="sub-menu"
Expand Down Expand Up @@ -175,8 +168,10 @@ describe( 'Navigation', () => {
expect( menuItems[ 1 ] ).toHaveTextContent( 'Item 2' );
expect( menuItems[ 2 ] ).toHaveTextContent( 'Category' );
expect( menuItems[ 3 ] ).toHaveTextContent( 'customize me' );
expect( menuItems[ 0 ] ).not.toHaveClass( 'is-active' );
expect( menuItems[ 1 ] ).toHaveClass( 'is-active' );

expect(
screen.getByRole( 'link', { current: 'page' } )
).toHaveTextContent( 'Item 2' );
} );

it( 'should render anchor links when menu item supplies an href', () => {
Expand Down Expand Up @@ -266,14 +261,14 @@ describe( 'Navigation', () => {
screen.getByRole( 'heading', { name: 'Home' } )
).toBeInTheDocument();
expect(
screen.getByRole( 'button', { name: 'Item 1' } ).parentElement
).toHaveClass( 'is-active' );
screen.getByRole( 'link', { current: 'page' } )
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: only "Item 1" and "Item 2" have role="link" since, in the example, their menu items are passed an href attribute.

The rest of the menu items are rendered as button as expected

).toHaveTextContent( 'Item 1' );

// click Item 2, check it's selected
await user.click( screen.getByRole( 'button', { name: 'Item 2' } ) );
await user.click( screen.getByRole( 'link', { name: 'Item 2' } ) );
expect(
screen.getByRole( 'button', { name: 'Item 2' } ).parentElement
).toHaveClass( 'is-active' );
screen.getByRole( 'link', { current: 'page' } )
).toHaveTextContent( 'Item 2' );

// click sub-menu, check new menu is shown
await user.click( screen.getByRole( 'button', { name: 'Sub-Menu' } ) );
Expand All @@ -284,8 +279,8 @@ describe( 'Navigation', () => {
// click Child 1, check it's selected
await user.click( screen.getByRole( 'button', { name: 'Child 1' } ) );
expect(
screen.getByRole( 'button', { name: 'Child 1' } ).parentElement
).toHaveClass( 'is-active' );
screen.getByRole( 'button', { current: 'page' } )
).toHaveTextContent( 'Child 1' );

// click nested sub-menu, check nested sub-menu is shown
await user.click(
Expand All @@ -300,8 +295,8 @@ describe( 'Navigation', () => {
screen.getByRole( 'button', { name: 'Sub-Child 2' } )
);
expect(
screen.getByRole( 'button', { name: 'Sub-Child 2' } ).parentElement
).toHaveClass( 'is-active' );
screen.getByRole( 'button', { current: 'page' } )
).toHaveTextContent( 'Sub-Child 2' );

// click back, check sub-menu is shown
await user.click( screen.getByRole( 'button', { name: 'Sub-Menu' } ) );
Expand Down Expand Up @@ -335,7 +330,7 @@ describe( 'Navigation', () => {
screen.getByRole( 'heading', { name: 'Sub-Menu' } )
).toBeInTheDocument();
expect(
screen.getByRole( 'button', { name: 'Child 2' } ).parentElement
).toHaveClass( 'is-active' );
screen.getByRole( 'button', { current: 'page' } )
).toHaveTextContent( 'Child 2' );
} );
} );