-
Notifications
You must be signed in to change notification settings - Fork 554
feat(autocomplete): replace "cancel" with a back button in detached mode #6942
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
Open
Haroenv
wants to merge
1
commit into
master
Choose a base branch
from
feat/aaa-detached-back
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
Some comments aren't visible on the classic Files Changed page.
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
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
106 changes: 106 additions & 0 deletions
106
...antsearch-ui-components/src/components/autocomplete/__tests__/AutocompleteSearch.test.tsx
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,106 @@ | ||
| /** | ||
| * @jest-environment @instantsearch/testutils/jest-environment-jsdom.ts | ||
| */ | ||
| /** @jsx createElement */ | ||
| import { render } from '@testing-library/preact'; | ||
| import userEvent from '@testing-library/user-event'; | ||
| import { createElement, createRef, Fragment } from 'preact'; | ||
|
|
||
| import { createAutocompleteDetachedFormContainerComponent } from '../AutocompleteDetachedFormContainer'; | ||
| import { createAutocompleteSearchComponent } from '../AutocompleteSearch'; | ||
|
|
||
| const AutocompleteSearch = createAutocompleteSearchComponent({ | ||
| createElement, | ||
| Fragment, | ||
| }); | ||
|
|
||
| const AutocompleteDetachedFormContainer = | ||
| createAutocompleteDetachedFormContainerComponent({ | ||
| createElement, | ||
| Fragment, | ||
| }); | ||
|
|
||
| describe('AutocompleteSearch', () => { | ||
| test('renders a back button and closes on click in detached mode', () => { | ||
| const onSubmit = jest.fn(); | ||
| const inputRef = createRef<HTMLInputElement>(); | ||
| const { container, getByTitle } = render( | ||
| <AutocompleteSearch | ||
| inputProps={{ | ||
| id: 'detached-search', | ||
| ref: inputRef, | ||
| onInput: jest.fn(), | ||
| }} | ||
| onClear={jest.fn()} | ||
| query="iphone" | ||
| isSearchStalled={false} | ||
| onSubmit={onSubmit} | ||
| isDetached={true} | ||
| submitTitle="Close" | ||
| /> | ||
| ); | ||
|
|
||
| userEvent.click(getByTitle('Close')); | ||
|
|
||
| expect(onSubmit).toHaveBeenCalledTimes(1); | ||
| // A dedicated back button is rendered – not the submit button | ||
| expect( | ||
| container.querySelector('.ais-AutocompleteBackButton') | ||
| ).not.toBeNull(); | ||
| expect(container.querySelector('.ais-AutocompleteBackIcon')).not.toBeNull(); | ||
| // Submit button is hidden (label hidden), back button is separate | ||
| expect( | ||
| container.querySelector<HTMLLabelElement>('.ais-AutocompleteLabel') | ||
| ?.hidden | ||
| ).toBe(true); | ||
| expect( | ||
| container.querySelector('.ais-AutocompleteSubmitButton') | ||
| ).not.toBeNull(); | ||
| }); | ||
|
|
||
| test('renders the submit button in non-detached mode', () => { | ||
| const inputRef = createRef<HTMLInputElement>(); | ||
| const { container, getByTitle } = render( | ||
| <AutocompleteSearch | ||
| inputProps={{ | ||
| id: 'default-search', | ||
| ref: inputRef, | ||
| onInput: jest.fn(), | ||
| }} | ||
| onClear={jest.fn()} | ||
| query="" | ||
| isSearchStalled={false} | ||
| /> | ||
| ); | ||
|
|
||
| expect(getByTitle('Submit').getAttribute('type')).toBe('submit'); | ||
| expect( | ||
| container.querySelector('.ais-AutocompleteSubmitIcon') | ||
| ).not.toBeNull(); | ||
| expect(container.querySelector('.ais-AutocompleteBackButton')).toBeNull(); | ||
| expect(container.querySelector('.ais-AutocompleteBackIcon')).toBeNull(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('AutocompleteDetachedFormContainer', () => { | ||
| test('keeps backwards-compatible props without rendering a cancel button', () => { | ||
| const { container, queryByText } = render( | ||
| <AutocompleteDetachedFormContainer | ||
| onCancel={jest.fn()} | ||
| translations={{ | ||
| detachedCancelButtonText: 'Cancel', | ||
| detachedSearchButtonTitle: 'Search', | ||
| detachedClearButtonTitle: 'Clear', | ||
| }} | ||
| > | ||
| <div>Search form</div> | ||
| </AutocompleteDetachedFormContainer> | ||
| ); | ||
|
|
||
| expect(queryByText('Search form')).not.toBeNull(); | ||
| expect(queryByText('Cancel')).toBeNull(); | ||
| expect( | ||
| container.querySelector('.ais-AutocompleteDetachedCancelButton') | ||
| ).toBeNull(); | ||
| }); | ||
| }); |
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AutocompleteDetachedFormContainerno longer renders/usesonCancelandtranslations, but those props are still required byAutocompleteDetachedFormContainerProps. This forces new consumers to pass unused values and makes the public API misleading. Consider making these props optional (and/or marking them deprecated in the type) now that the cancel button isn’t rendered.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it not still using it for the title of the back button? @copilot do you mind explaining?