-
Notifications
You must be signed in to change notification settings - Fork 240
chore: Add built-in internationalization to button dropdown filtering #4884
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
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
115 changes: 115 additions & 0 deletions
115
src/button-dropdown/__tests__/button-dropdown-i18n.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,115 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| import React from 'react'; | ||
| import { render } from '@testing-library/react'; | ||
|
|
||
| import ButtonDropdown, { ButtonDropdownProps } from '../../../lib/components/button-dropdown'; | ||
| import TestI18nProvider from '../../../lib/components/i18n/testing'; | ||
| import createWrapper from '../../../lib/components/test-utils/dom'; | ||
|
|
||
| const items: ButtonDropdownProps.Items = [ | ||
| { id: 'i1', text: 'Cut' }, | ||
| { id: 'i2', text: 'Copy' }, | ||
| { id: 'i3', text: 'Paste' }, | ||
| ]; | ||
|
|
||
| function renderDropdown(jsx: React.ReactElement) { | ||
| const { container } = render(jsx); | ||
| return createWrapper(container).findButtonDropdown()!; | ||
| } | ||
|
|
||
| describe('i18n', () => { | ||
| describe('filteringResultsText', () => { | ||
| it('uses filteringResultsText from i18n provider when not specified', () => { | ||
| const wrapper = renderDropdown( | ||
| <TestI18nProvider | ||
| messages={{ | ||
| 'button-dropdown': { | ||
| filteringResultsText: '{matchesCount} out of {totalCount} items', | ||
| }, | ||
| }} | ||
| > | ||
| <ButtonDropdown items={items} ariaLabel="Actions" filteringType="auto"> | ||
| Actions | ||
| </ButtonDropdown> | ||
| </TestI18nProvider> | ||
| ); | ||
| wrapper.openDropdown(); | ||
| wrapper.findFilteringInput()!.setInputValue('Co'); | ||
| const footer = wrapper.findFooterRegion(); | ||
| expect(footer).not.toBeNull(); | ||
| expect(footer!.getElement()).toHaveTextContent('1 out of 3 items'); | ||
| }); | ||
|
|
||
| it('uses filteringResultsText prop over i18n provider', () => { | ||
| const wrapper = renderDropdown( | ||
| <TestI18nProvider | ||
| messages={{ | ||
| 'button-dropdown': { | ||
| filteringResultsText: '{matchesCount} out of {totalCount} items', | ||
| }, | ||
| }} | ||
| > | ||
| <ButtonDropdown | ||
| items={items} | ||
| ariaLabel="Actions" | ||
| filteringType="auto" | ||
| filteringResultsText={(matchesCount, totalCount) => `Custom ${matchesCount}/${totalCount}`} | ||
| > | ||
| Actions | ||
| </ButtonDropdown> | ||
| </TestI18nProvider> | ||
| ); | ||
| wrapper.openDropdown(); | ||
| wrapper.findFilteringInput()!.setInputValue('Co'); | ||
| const footer = wrapper.findFooterRegion(); | ||
| expect(footer).not.toBeNull(); | ||
| expect(footer!.getElement()).toHaveTextContent('Custom 1/3'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('i18nStrings.filteringItemAriaDescription', () => { | ||
| it('uses i18nStrings.filteringItemAriaDescription from i18n provider when not specified', () => { | ||
| const wrapper = renderDropdown( | ||
| <TestI18nProvider | ||
| messages={{ | ||
| 'button-dropdown': { | ||
| 'i18nStrings.filteringItemAriaDescription': 'Continue typing to further filter the list', | ||
| }, | ||
| }} | ||
| > | ||
| <ButtonDropdown items={items} ariaLabel="Actions" filteringType="auto"> | ||
| Actions | ||
| </ButtonDropdown> | ||
| </TestI18nProvider> | ||
| ); | ||
| wrapper.openDropdown(); | ||
| const menuItem = wrapper.findItemById('i1')!.find('[role="menuitem"]')!.getElement(); | ||
| expect(menuItem).toHaveAccessibleDescription('Continue typing to further filter the list'); | ||
| }); | ||
|
|
||
| it('uses i18nStrings.filteringItemAriaDescription prop over i18n provider', () => { | ||
| const wrapper = renderDropdown( | ||
| <TestI18nProvider | ||
| messages={{ | ||
| 'button-dropdown': { | ||
| 'i18nStrings.filteringItemAriaDescription': 'Continue typing to further filter the list', | ||
| }, | ||
| }} | ||
| > | ||
| <ButtonDropdown | ||
| items={items} | ||
| ariaLabel="Actions" | ||
| filteringType="auto" | ||
| i18nStrings={{ filteringItemAriaDescription: 'Custom description' }} | ||
| > | ||
| Actions | ||
| </ButtonDropdown> | ||
| </TestI18nProvider> | ||
| ); | ||
| wrapper.openDropdown(); | ||
| const menuItem = wrapper.findItemById('i1')!.find('[role="menuitem"]')!.getElement(); | ||
| expect(menuItem).toHaveAccessibleDescription('Custom description'); | ||
| }); | ||
| }); | ||
| }); |
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
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
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
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.
Fine for now; thinking about having the string accept a react node as fallback but that can come in a different PR.