-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Composite: make items tabbable if active element gets removed #65720
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ciampo marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import { queryByAttribute, render, screen } from '@testing-library/react'; | ||
| import { click, press, waitFor } from '@ariakit/test'; | ||
| import type { ComponentProps } from 'react'; | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { useState } from '@wordpress/element'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { Composite } from '..'; | ||
|
|
||
| // This is necessary because of how Ariakit calculates page up and | ||
| // page down. Without this, nothing has a height, and so paging up | ||
| // and down doesn't behave as expected in tests. | ||
ciampo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| let clientHeightSpy: jest.SpiedGetter< | ||
| typeof HTMLElement.prototype.clientHeight | ||
| >; | ||
|
|
||
| beforeAll( () => { | ||
| clientHeightSpy = jest | ||
| .spyOn( HTMLElement.prototype, 'clientHeight', 'get' ) | ||
| .mockImplementation( function getClientHeight( this: HTMLElement ) { | ||
| if ( this.tagName === 'BODY' ) { | ||
| return window.outerHeight; | ||
| } | ||
| return 50; | ||
| } ); | ||
| } ); | ||
|
|
||
| afterAll( () => { | ||
| clientHeightSpy?.mockRestore(); | ||
| } ); | ||
|
|
||
| async function renderAndValidate( ...args: Parameters< typeof render > ) { | ||
| const view = render( ...args ); | ||
| await waitFor( () => { | ||
| const activeButton = queryByAttribute( | ||
| 'data-active-item', | ||
| view.baseElement, | ||
| 'true' | ||
| ); | ||
| expect( activeButton ).not.toBeNull(); | ||
| } ); | ||
| return view; | ||
| } | ||
|
|
||
| function RemoveItemTest( props: ComponentProps< typeof Composite > ) { | ||
| const [ showThirdItem, setShowThirdItem ] = useState( true ); | ||
| return ( | ||
| <> | ||
| <button>Focus trap before composite</button> | ||
| <Composite { ...props }> | ||
| <Composite.Item>Item 1</Composite.Item> | ||
| <Composite.Item>Item 2</Composite.Item> | ||
| { showThirdItem && <Composite.Item>Item 3</Composite.Item> } | ||
| </Composite> | ||
| <button onClick={ () => setShowThirdItem( ( value ) => ! value ) }> | ||
| Toggle third item | ||
| </button> | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
| describe( 'Composite', () => { | ||
ciampo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| it( 'should remain focusable even when there are no elements in the DOM associated with the currently active ID', async () => { | ||
| await renderAndValidate( <RemoveItemTest /> ); | ||
|
|
||
| const toggleButton = screen.getByRole( 'button', { | ||
| name: 'Toggle third item', | ||
| } ); | ||
|
|
||
| await press.Tab(); | ||
| await press.Tab(); | ||
|
|
||
| expect( | ||
| screen.getByRole( 'button', { name: 'Item 1' } ) | ||
| ).toHaveFocus(); | ||
|
|
||
| await press.ArrowRight(); | ||
| await press.ArrowRight(); | ||
|
|
||
| expect( | ||
| screen.getByRole( 'button', { name: 'Item 3' } ) | ||
| ).toHaveFocus(); | ||
|
|
||
| await click( toggleButton ); | ||
|
|
||
| expect( | ||
| screen.queryByRole( 'button', { name: 'Item 3' } ) | ||
| ).not.toBeInTheDocument(); | ||
|
|
||
| await press.ShiftTab(); | ||
|
|
||
| expect( | ||
| screen.getByRole( 'button', { name: 'Item 2' } ) | ||
| ).toHaveFocus(); | ||
|
|
||
| await click( toggleButton ); | ||
|
|
||
| expect( | ||
| screen.getByRole( 'button', { name: 'Item 3' } ) | ||
| ).toBeVisible(); | ||
|
|
||
| await press.ShiftTab(); | ||
|
|
||
| expect( | ||
| screen.getByRole( 'button', { name: 'Item 2' } ) | ||
| ).toHaveFocus(); | ||
|
|
||
| await press.ArrowRight(); | ||
|
|
||
| expect( | ||
| screen.getByRole( 'button', { name: 'Item 3' } ) | ||
| ).toHaveFocus(); | ||
| } ); | ||
| } ); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.